es.situm.sdk.communication

Interface CommunicationManager

public interface CommunicationManager

The Communication manager allows you to make asynchronous requests to the server, mostly to fetch data.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CommunicationManager.Code The error codes received in Handler.onFailure(Error) on the CommunicationManager
static interface	CommunicationManager.PropertyKey

Method Summary

Modifier and Type	Method and Description
boolean	eventClicked(EventOccurrence occurrence, Handler<EventOccurrence> callback) Notifies that the user has clicked a previously seen event.
boolean	eventClicked(EventOccurrence occurrence, Map<String,Object> options, Handler<EventOccurrence> callback) Notifies that the user has clicked a previously seen event.
boolean	eventConverted(EventOccurrence occurrence, Handler<EventOccurrence> callback) Notifies that a previously seen and clicked event has been converted.
boolean	eventConverted(EventOccurrence occurrence, Map<String,Object> options, Handler<EventOccurrence> callback) Notifies that a previously seen and clicked event has been converted.
boolean	eventSeen(SitumEvent event, Handler<EventOccurrence> callback) Notifies that the user has seen an event.
boolean	eventSeen(SitumEvent event, Map<String,Object> options, Handler<EventOccurrence> callback) Notifies that the user has seen an event.
boolean	fetchBuildingInfo(Building building, Handler<BuildingInfo> callback) Download all the building data for the selected building.
boolean	fetchBuildingInfo(Building building, Map<String,Object> options, Handler<BuildingInfo> callback) Download all the building data from the selected building.
boolean	fetchBuildings(Handler<Collection<Building>> callback) Download all the buildings for the current user
boolean	fetchBuildings(Map<String,Object> options, Handler<Collection<Building>> callback) Download all the buildings for the current user
boolean	fetchCalibratedArea(Building building, Floor floor, Handler<Collection<CalibrationArea>> callback) Get the calibrated areas for a floor
boolean	fetchEventsFromBuilding(Building building, Handler<Collection<SitumEvent>> callback) Download the events of a building
boolean	fetchEventsFromBuilding(Building building, Map<String,Object> options, Handler<Collection<SitumEvent>> callback) Download the events of a building
boolean	fetchFloorsFromBuilding(Building building, Handler<Collection<Floor>> callback) Download all the floors of a building
boolean	fetchFloorsFromBuilding(Building building, Map<String,Object> options, Handler<Collection<Floor>> callback) Download all the floors of a building
boolean	fetchIndoorPOIsFromBuilding(Building building, Handler<Collection<Poi>> callback) Download the indoor POIs of a building
boolean	fetchIndoorPOIsFromBuilding(Building building, Map<String,Object> options, Handler<Collection<Poi>> callback) Download the indoor POIs of a building
boolean	fetchMapFromFloor(Floor floor, Handler<android.graphics.Bitmap> callback) Download the map image of a floor
boolean	fetchMapFromFloor(Floor floor, Map<String,Object> options, Handler<android.graphics.Bitmap> callback) Download the map image of a floor
boolean	fetchOutdoorPOIsFromBuilding(Building building, Handler<Collection<Poi>> callback) Download the outdoor POIs of a building
boolean	fetchOutdoorPOIsFromBuilding(Building building, Map<String,Object> options, Handler<Collection<Poi>> callback) Download the outdoor POIs of a building
boolean	fetchPoiCategories(Handler<Collection<PoiCategory>> callback) Get all POI categories, download and cache their icons asynchronously
boolean	fetchPoiCategories(Map<String,Object> options, Handler<Collection<PoiCategory>> callback) Get all POI categories, download and cache their icons asynchronously.
boolean	fetchPoiCategoryIconNormal(PoiCategory category, Handler<android.graphics.Bitmap> callback) Get the normal category icon for a category
boolean	fetchPoiCategoryIconNormal(PoiCategory category, Map<String,Object> options, Handler<android.graphics.Bitmap> callback) Get the normal category icon for a category
boolean	fetchPoiCategoryIconSelected(PoiCategory category, Handler<android.graphics.Bitmap> callback) Get the selected category icon for a category
boolean	fetchPoiCategoryIconSelected(PoiCategory category, Map<String,Object> options, Handler<android.graphics.Bitmap> callback) Get the selected category icon for a category
HttpRequestExecutor	getHttpRequestExecutor() Return the HTTP Request Executor to make custom requests to the Dashboard
void	invalidateCache() Invalidate all the resources in the cache
boolean	logout(Handler<Object> callback) Invalidate user's token and remove it from internal credentials, if exist.
boolean	validateUserCredentials(Handler<Object> callback) Check if the user credentials previously set with Configuration.setUserPass(String, String), SitumSdk.configuration() or in the AndroidManifest.xml are right.

Method Detail

validateUserCredentials

boolean validateUserCredentials(Handler<Object> callback)

Check if the user credentials previously set with Configuration.setUserPass(String, String), SitumSdk.configuration() or in the AndroidManifest.xml are right.

Parameters:

callback - invoked when login is finished. If the user and/or password/api key aren't valid a CommunicationManager.Code.HTTP_UNAUTHORIZED will be received in Handler.onFailure(Error)

Returns:

True if request is sent. False if request can't be sent: there is no user email and password.

logout

boolean logout(Handler<Object> callback)

Invalidate user's token and remove it from internal credentials, if exist. If not exist, return false. After invalidation, first network request will cause a login, to obtain another valid token.

Parameters:

callback - invoked when logout is finished

Returns:

True if request is correctly sent. False if can't be sent: there is no user token.

fetchBuildings

boolean fetchBuildings(Handler<Collection<Building>> callback)

Download all the buildings for the current user

Parameters:

callback - Callback to asynchronously receive the buildings. Not null.

fetchBuildings

boolean fetchBuildings(Map<String,Object> options,
                       Handler<Collection<Building>> callback)

Download all the buildings for the current user

Parameters:

options - the request options. Can be null. Accepted options: CommunicationOptions.FORCE_DOWNLOAD

callback - Callback to asynchronously receive the buildings. Not null.

fetchBuildingInfo

boolean fetchBuildingInfo(Building building,
                          Handler<BuildingInfo> callback)

Download all the building data for the selected building. This info includes floors, indoor and outdoor POIs, events and paths. Also it download floor maps and POI category icons to local storage.

Parameters:

building - selected building for download info. Not null.

callback - Callback to asynchronously receive the buildings. Not null.

fetchBuildingInfo

boolean fetchBuildingInfo(Building building,
                          Map<String,Object> options,
                          Handler<BuildingInfo> callback)

Download all the building data from the selected building. This info includes floors, indoor and outdoor POIs, events and paths. Also it download floor maps and POI category icons to local storage.

Parameters:

building - selected building for download info. Not null.

options - the request options. Can be null. Accepted options: CommunicationOptions.FORCE_DOWNLOAD

callback - Callback to asynchronously receive the buildings. Not null.

fetchFloorsFromBuilding

boolean fetchFloorsFromBuilding(Building building,
                                Handler<Collection<Floor>> callback)

Download all the floors of a building

Parameters:

building - the building. Not null.

callback - Callback to asynchronously receive the floors. Not null.

fetchFloorsFromBuilding

boolean fetchFloorsFromBuilding(Building building,
                                Map<String,Object> options,
                                Handler<Collection<Floor>> callback)

Download all the floors of a building

Parameters:

building - the building. Not null.

options - the request options. Can be null. Accepted options: FORCE_DOWNLOAD (download regardless cache)

callback - Callback to asynchronously receive the floors. Not null.

fetchMapFromFloor

boolean fetchMapFromFloor(Floor floor,
                          Handler<android.graphics.Bitmap> callback)

Download the map image of a floor

Parameters:

floor - the floor. Not null.

callback - callback to asynchronously receive the floor image. Not null.

fetchMapFromFloor

boolean fetchMapFromFloor(Floor floor,
                          Map<String,Object> options,
                          Handler<android.graphics.Bitmap> callback)

Download the map image of a floor

Parameters:

floor - the floor. Not null.

options - the request options. Can be null. Accepted options: CommunicationOptions.FORCE_DOWNLOAD

callback - callback to asynchronously receive the image. Not null.

fetchIndoorPOIsFromBuilding

boolean fetchIndoorPOIsFromBuilding(Building building,
                                    Handler<Collection<Poi>> callback)

Download the indoor POIs of a building

Parameters:

building - the building. Not null.

callback - Callback to asynchronously receive the points of interest. Not null.

fetchIndoorPOIsFromBuilding

boolean fetchIndoorPOIsFromBuilding(Building building,
                                    Map<String,Object> options,
                                    Handler<Collection<Poi>> callback)

Download the indoor POIs of a building

Parameters:

building - the building. Not null.

options - the request options. Can be null. Accepted options: CommunicationOptions.FORCE_DOWNLOAD

callback - callback to asynchronously receive the points of interest. Not null.

fetchPoiCategories

boolean fetchPoiCategories(Handler<Collection<PoiCategory>> callback)

Get all POI categories, download and cache their icons asynchronously

To get some of those icons from local storage use fetchPoiCategoryIconNormal(PoiCategory, Handler) or fetchPoiCategoryIconSelected(PoiCategory, Handler)

Parameters:

callback - Callback to asynchronously receive the POI categories. Not null.

fetchPoiCategories

boolean fetchPoiCategories(Map<String,Object> options,
                           Handler<Collection<PoiCategory>> callback)

Get all POI categories, download and cache their icons asynchronously.

To get some of those icons from local storage use fetchPoiCategoryIconNormal(PoiCategory, Handler) or fetchPoiCategoryIconSelected(PoiCategory, Handler)

Parameters:

options - the request options. Can be null. Accepted options: CommunicationOptions.FORCE_DOWNLOAD

callback - Callback to asynchronously receive the POI categories

fetchPoiCategoryIconNormal

boolean fetchPoiCategoryIconNormal(PoiCategory category,
                                   Handler<android.graphics.Bitmap> callback)

Get the normal category icon for a category

Parameters:

category - the category. Not null.

callback - the callback. Not null.

fetchPoiCategoryIconNormal

boolean fetchPoiCategoryIconNormal(PoiCategory category,
                                   Map<String,Object> options,
                                   Handler<android.graphics.Bitmap> callback)

Get the normal category icon for a category

Parameters:

category - the category. Not null.

options - the request options. Can be null. Accepted options: CommunicationOptions.FORCE_DOWNLOAD

callback - the callback. Not null.

fetchPoiCategoryIconSelected

boolean fetchPoiCategoryIconSelected(PoiCategory category,
                                     Handler<android.graphics.Bitmap> callback)

Get the selected category icon for a category

Parameters:

category - the category. Not null.

callback - the callback. Not null.

fetchPoiCategoryIconSelected

boolean fetchPoiCategoryIconSelected(PoiCategory category,
                                     Map<String,Object> options,
                                     Handler<android.graphics.Bitmap> callback)

Get the selected category icon for a category

Parameters:

category - the category. Not null.

options - the request options. Can be null. Accepted options: FORCE_DOWNLOAD (download regardless cache)

callback - the callback. Not null.

fetchOutdoorPOIsFromBuilding

boolean fetchOutdoorPOIsFromBuilding(Building building,
                                     Handler<Collection<Poi>> callback)

Download the outdoor POIs of a building

Parameters:

building - the building. Not null.

callback - Callback to asynchronously receive the points of interest. Not null.

fetchOutdoorPOIsFromBuilding

boolean fetchOutdoorPOIsFromBuilding(Building building,
                                     Map<String,Object> options,
                                     Handler<Collection<Poi>> callback)

Download the outdoor POIs of a building

Parameters:

building - the building. Not null.

options - the request options. Can be null. Accepted options: CommunicationOptions.FORCE_DOWNLOAD

callback - Callback to asynchronously receive the points of interest. Not null.

fetchEventsFromBuilding

boolean fetchEventsFromBuilding(Building building,
                                Handler<Collection<SitumEvent>> callback)

Download the events of a building

Parameters:

building - the building. Not null.

callback - Callback to asynchronously receive the events of a building. Not null.

fetchEventsFromBuilding

boolean fetchEventsFromBuilding(Building building,
                                Map<String,Object> options,
                                Handler<Collection<SitumEvent>> callback)

Download the events of a building

Parameters:

building - the building. Not null.

options - the request options. Can be null. Accepted options: CommunicationOptions.FORCE_DOWNLOAD

callback - Callback to asynchronously receive the events of a building. Not null.

eventSeen

boolean eventSeen(SitumEvent event,
                  Handler<EventOccurrence> callback)

Notifies that the user has seen an event.

Parameters:

event - event that has been seen. Not null.

callback - receives an event occurrence, necessary to notify a click and conversion of the same event. Not null.

See Also:

EventOccurrence, eventClicked(EventOccurrence, Handler), eventConverted(EventOccurrence, Handler)

eventSeen

boolean eventSeen(SitumEvent event,
                  Map<String,Object> options,
                  Handler<EventOccurrence> callback)

Notifies that the user has seen an event.

Parameters:

event - event that has been seen. Not null.

options - the request options. Can be null.

callback - receives an event occurrence, necessary to notify a click of the same event. Not null.

See Also:

EventOccurrence, eventClicked(EventOccurrence, Handler)

eventClicked

boolean eventClicked(EventOccurrence occurrence,
                     Handler<EventOccurrence> callback)

Notifies that the user has clicked a previously seen event. The time when the click was produced can be provided in the occurrence; if not, new Date() is assumed.

Parameters:

occurrence - object obtained when the event was seen (with eventSeen(SitumEvent, Handler)). Not null. occurrence.getId() not null.

callback - receives the updated occurrence, necessary to notify a conversion of the same event. Not null.

See Also:

EventOccurrence, eventConverted(EventOccurrence, Handler)

eventClicked

boolean eventClicked(EventOccurrence occurrence,
                     Map<String,Object> options,
                     Handler<EventOccurrence> callback)

Notifies that the user has clicked a previously seen event. The time when the click was produced can be provided in the occurrence; if not, new Date() is assumed.

Parameters:

occurrence - object obtained when the event was seen (with eventSeen(SitumEvent, Handler)). Not null. occurrence.getId() not null.

options - the request options. Can be null.

callback - receives the updated occurrence, necessary to notify a conversion of the same event. Not null.

See Also:

eventConverted(EventOccurrence, Handler)

eventConverted

boolean eventConverted(EventOccurrence occurrence,
                       Handler<EventOccurrence> callback)

Notifies that a previously seen and clicked event has been converted. The time when the conversion was produced can be provided in the occurrence; if not, new Date() is assumed.

Parameters:

occurrence - object obtained when the event was clicked (with eventClicked(EventOccurrence, Handler)). Not null. occurrence.getId() and occurrence.getWhenClicked() can't be null neither.

callback - receives the updated occurrence. Not null.

See Also:

EventOccurrence, 3eventConverted( EventOccurrence , Handler)

eventConverted

boolean eventConverted(EventOccurrence occurrence,
                       Map<String,Object> options,
                       Handler<EventOccurrence> callback)

Notifies that a previously seen and clicked event has been converted. The time when the conversion was produced can be provided in the occurrence; if not, new Date() is assumed.

Parameters:

occurrence - object obtained when the event was clicked (with eventClicked(EventOccurrence, Handler)). Not null. occurrence.getId() and occurrence.getWhenClicked() can't be null neither.

options - the request options. Can be null.

callback - receives the updated occurrence. Not null.

See Also:

EventOccurrence, eventConverted(EventOccurrence, Handler)

fetchCalibratedArea

boolean fetchCalibratedArea(Building building,
                            Floor floor,
                            Handler<Collection<CalibrationArea>> callback)

Get the calibrated areas for a floor

Parameters:

building - the building. Not null

floor - the floor. Not null

callback - the callback. Not null

invalidateCache

void invalidateCache()

Invalidate all the resources in the cache

getHttpRequestExecutor

HttpRequestExecutor getHttpRequestExecutor()

Return the HTTP Request Executor to make custom requests to the Dashboard