es.situm.sdk.communication

Interface CommunicationManager

public interface CommunicationManager

Method Summary

Modifier and Type	Method and Description
boolean	eventClicked(EventOcurrence ocurrence, Handler<EventOcurrence> callback) Notifies that the user has clicked a previously seen event.
boolean	eventClicked(EventOcurrence ocurrence, Map<String,Object> options, Handler<EventOcurrence> callback) Notifies that the user has clicked a previously seen event.
boolean	eventConverted(EventOcurrence ocurrence, Handler<EventOcurrence> callback) Notifies that a previously seen and clicked event has been converted.
boolean	eventConverted(EventOcurrence ocurrence, Map<String,Object> options, Handler<EventOcurrence> callback) Notifies that a previously seen and clicked event has been converted.
boolean	eventSeen(SitumEvent event, Handler<EventOcurrence> callback) Notifies that the user has seen an event.
boolean	eventSeen(SitumEvent event, Map<String,Object> options, Handler<EventOcurrence> callback) Notifies that the user has seen an event.
boolean	fetchBuildingInfo(Building building, Handler<BuildingInfo> callback) Download all building data from the selected building.
boolean	fetchBuildingInfo(Building building, Map<String,Object> options, Handler<BuildingInfo> callback) Download all building data from the selected building.
boolean	fetchBuildings(Handler<Collection<Building>> callback) Download all buildings for user
boolean	fetchBuildings(Map<String,Object> options, Handler<Collection<Building>> callback) Download all buildings for user
boolean	fetchEventsFromBuilding(Building building, Handler<Collection<SitumEvent>> callback) Download the events of a building from Situm Indoor Maps Server
boolean	fetchEventsFromBuilding(Building building, Map<String,Object> options, Handler<Collection<SitumEvent>> callback) Download the events of a building from Situm Indoor Maps Server
boolean	fetchFloorsFromBuilding(Building building, Handler<Collection<Floor>> callback) Download all floors for a building
boolean	fetchFloorsFromBuilding(Building building, Map<String,Object> options, Handler<Collection<Floor>> callback) Download all floors for 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 from Situm Indoor Maps Server as a Bitmap
boolean	fetchMapFromFloor(Floor floor, Map<String,Object> options, Handler<android.graphics.Bitmap> callback) Download the map image of a floor from Situm Indoor Maps Server as a Bitmap
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, and download and cache their icons asynchronously
boolean	fetchPoiCategories(Map<String,Object> options, Handler<Collection<PoiCategory>> callback) Get all POI categories, and download and cache their icons asynchronously.
boolean	fetchPoiCategoryIconNormal(PoiCategory category, Handler<android.graphics.Bitmap> callback) Get the normal category Bitmap icon for a category
boolean	fetchPoiCategoryIconNormal(PoiCategory category, Map<String,Object> options, Handler<android.graphics.Bitmap> callback) Get the normal category Bitmap icon for a category
boolean	fetchPoiCategoryIconSelected(PoiCategory category, Handler<android.graphics.Bitmap> callback) Get the selected category Bitmap icon for a category
boolean	fetchPoiCategoryIconSelected(PoiCategory category, Map<String,Object> options, Handler<android.graphics.Bitmap> callback) Get the selected category Bitmap icon for a category
HttpRequestExecutor	getHttpRequestExecutor()
void	invalidateCache()
boolean	logout(Handler<Object> callback) Invalidate user's token and remove it from internal credentials, if exist.
boolean	validateUserCredentials(Handler<Object> callback) Check if user credentials previously set with Configuration.setUserPass(String, String) from SitumSdk.configuration() are right.

Method Detail

validateUserCredentials

boolean validateUserCredentials(Handler<Object> callback)

Check if user credentials previously set with Configuration.setUserPass(String, String) from SitumSdk.configuration() are right.

Parameters:

callback - invoked when login is finished

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:

boolean - 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 buildings for user

Parameters:

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

fetchBuildings

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

Download all buildings for user

Parameters:

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

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

fetchBuildingInfo

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

Download all building data from the selected building. This info includes: floors, indoor pois, outdoor pois, events and paths

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 building data from the selected building. This info includes: floors, indoor and outdoor pois (with categories), events and paths. Also 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: FORCE_DOWNLOAD (download regardless cache)

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

fetchFloorsFromBuilding

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

Download all floors for 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 floors for 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 from Situm Indoor Maps Server as a Bitmap

Parameters:

floor - the floor. Not null.

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

fetchMapFromFloor

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

Download the map image of a floor from Situm Indoor Maps Server as a Bitmap

Parameters:

floor - the floor. Not null.

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

callback - callback to asynchronously receive the image Bitmap. 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: FORCE_DOWNLOAD (download regardless cache)

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

fetchPoiCategories

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

Get all POI categories, and 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, and 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: FORCE_DOWNLOAD (download regardless cache)

callback - Callback to asynchronously receive the POI categories

fetchPoiCategoryIconNormal

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

Get the normal category Bitmap 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 Bitmap 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.

fetchPoiCategoryIconSelected

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

Get the selected category Bitmap 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 Bitmap 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: FORCE_DOWNLOAD (download regardless cache)

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 from Situm Indoor Maps Server

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 from Situm Indoor Maps Server

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 events of a building. Not null.

eventSeen

boolean eventSeen(SitumEvent event,
                  Handler<EventOcurrence> 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:

EventOcurrence}, {@link #eventClicked(EventOcurrence, Handler)}, {@link #eventConverted(EventOcurrence, Handler)}

eventSeen

boolean eventSeen(SitumEvent event,
                  Map<String,Object> options,
                  Handler<EventOcurrence> 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:

EventOcurrence}, {@link #eventClicked(EventOcurrence, Handler)}

eventClicked

boolean eventClicked(EventOcurrence ocurrence,
                     Handler<EventOcurrence> callback)

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

Parameters:

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

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

See Also:

EventOcurrence}, {@link #eventConverted(EventOcurrence, Handler)}

eventClicked

boolean eventClicked(EventOcurrence ocurrence,
                     Map<String,Object> options,
                     Handler<EventOcurrence> callback)

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

Parameters:

ocurrence - object obtained when the event was seen (with eventSeen(SitumEvent, Handler)). Not null. ocurrence.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:

EventOcurrence}, {@link #eventConverted(EventOcurrence, Handler)}

eventConverted

boolean eventConverted(EventOcurrence ocurrence,
                       Handler<EventOcurrence> callback)

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

Parameters:

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

callback - receives the updated occurrence. Not null.

See Also:

EventOcurrence}, {@link #eventConverted(EventOcurrence, Handler)}

eventConverted

boolean eventConverted(EventOcurrence ocurrence,
                       Map<String,Object> options,
                       Handler<EventOcurrence> callback)

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

Parameters:

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

options - the request options. Can be null.

callback - receives the updated occurrence. Not null.

See Also:

EventOcurrence}, {@link #eventConverted(EventOcurrence, Handler)}

invalidateCache

void invalidateCache()

getHttpRequestExecutor

HttpRequestExecutor getHttpRequestExecutor()