Package 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.

  • Method Details

    • validateUserCredentials

      boolean validateUserCredentials(@NonNull 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.

    • fetchOrganizationTheme

      boolean fetchOrganizationTheme(@NonNull Handler<OrganizationTheme> callback)
      Get organization theme: company name, logo and colors
      Parameters:
      callback - Callback to asynchronously receive the organization theme. Not null.
      Returns:
      True if request is sent. False if request can't be sent:

    • 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.

    • prefetchPositioningInfo

      boolean prefetchPositioningInfo(@NonNull Handler<String> callback)
      Download all the necessary information to start positioning. This includes Building, BuildingInfo and the building's model. Downloaded information will be saved in cache. Previous to version 2.50.2 the model was only obtained while starting positioning inside a Building
      Parameters:
      callback - Callback to asynchronously receive the result of this call. An error will be notified if anything fails during the download, only the most critical error will be sent

    • prefetchPositioningInfo

      boolean prefetchPositioningInfo(CommunicationConfig config, Handler<String> callback)
      Download all the necessary information to start positioning. This includes Building, BuildingInfo and the building's model. Downloaded information will be saved in cache. Previous to version 2.50.2 the model was only obtained while starting positioning inside a Building
      Parameters:
      callback - Callback to asynchronously receive the result of this call. An error will be notified if anything fails during the download, only the most critical error will be sent
      config - request specific configuration. Can be null.

    • prefetchPositioningInfo

      boolean prefetchPositioningInfo(@NonNull List<String> buildingIds, @NonNull Handler<String> callback)
      Download all the necessary information to start positioning in the selected buildings. This includes Building, BuildingInfo and the building's model. Downloaded information will be saved in cache. Previous to version 2.50.2 the model was only obtained while starting positioning inside a Building
      Parameters:
      buildingIds - List with the ids of the buildings you want to prefetch
      callback - Callback to asynchronously receive the result of this call. An error will be notified if anything fails during the download, only the most critical error will be sent

    • prefetchPositioningInfo

      boolean prefetchPositioningInfo(@NonNull List<String> buildingIds, CommunicationConfig config, Handler<String> callback)
      Download all the necessary information to start positioning in the selected buildings. This includes Building, BuildingInfo and the building's model. Downloaded information will be saved in cache. Previous to version 2.50.2 the model was only obtained while starting positioning inside a Building
      Parameters:
      buildingIds - List with the ids of the buildings you want to prefetch
      callback - Callback to asynchronously receive the result of this call. An error will be notified if anything fails during the download, only the most critical error will be sent
      config - request specific configuration. Can be null.

    • fetchBuildings

      boolean fetchBuildings(@NonNull 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(CommunicationConfig config, @NonNull Handler<Collection<Building>> callback)
      Download all the buildings for the current user
      Parameters:
      config - request specific configuration. Can be null.
      callback - Callback to asynchronously receive the buildings. Not null.

    • fetchBuildingInfo

      boolean fetchBuildingInfo(String buildingId, @NonNull 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:
      buildingId - selected building for download info. Not null.
      callback - Callback to asynchronously receive the buildings. Not null.

    • fetchBuildingInfo

      boolean fetchBuildingInfo(@NonNull String buildingId, CommunicationConfig config, @NonNull 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:
      buildingId - selected building for download info. Not null.
      config - request specific configuration. Can be null.
      callback - Callback to asynchronously receive the buildings. Not null.

    • fetchFloorsFromBuilding

      boolean fetchFloorsFromBuilding(@NonNull String buildingId, @NonNull Handler<Collection<Floor>> callback)
      Download all the floors of a building
      Parameters:
      buildingId - the building identifier. Not null.
      callback - Callback to asynchronously receive the floors. Not null.

    • fetchFloorsFromBuilding

      boolean fetchFloorsFromBuilding(@NonNull String buildingId, CommunicationConfig config, @NonNull Handler<Collection<Floor>> callback)
      Download all the floors of a building
      Parameters:
      buildingId - the building identifier. Not null.
      config - request specific configuration. Can be null.
      callback - Callback to asynchronously receive the floors. Not null.

    • fetchTilesFromBuilding

      boolean fetchTilesFromBuilding(String buildingId, Handler<String> callback)
      Download the building Tiles. Not all the buildings have tiles available to be downloaded. If the tiles are available, a zip file is downloaded and unzipped in the internal storage.
      Parameters:
      buildingId -
      callback -

    • getTileFromBuilding

      SitumTile getTileFromBuilding(String buildingId, String floorId, int x, int y, int zoom)
      Returns a specific image tile for a building and floor combination. The tile could be a path to an internal storage, for the case that the tiles were previously fetched for a particular building or a URL to an online one in any other case.
      Parameters:
      buildingId -
      floorId -
      x -
      y -
      zoom -
      Returns:

    • fetchMapFromFloor

      boolean fetchMapFromFloor(@NonNull Floor floor, @NonNull 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(@NonNull Floor floor, CommunicationConfig config, @NonNull Handler<android.graphics.Bitmap> callback)
      Download the map image of a floor
      Parameters:
      floor - the floor. Not null.
      config - request specific configuration. Can be null.
      callback - callback to asynchronously receive the image. Not null.

    • fetchIndoorPOIsFromBuilding

      boolean fetchIndoorPOIsFromBuilding(@NonNull String buildingId, @NonNull Handler<Collection<Poi>> callback)
      Download the indoor POIs of a building
      Parameters:
      buildingId - the building identifier. Not null.
      callback - Callback to asynchronously receive the points of interest. Not null.

    • fetchIndoorPOIsFromBuilding

      boolean fetchIndoorPOIsFromBuilding(@NonNull String buildingId, CommunicationConfig config, @NonNull Handler<Collection<Poi>> callback)
      Download the indoor POIs of a building
      Parameters:
      buildingId - the building identifier. Not null.
      config - request specific configuration. Can be null.
      callback - callback to asynchronously receive the points of interest. Not null.

    • fetchClosestPOIs

      boolean fetchClosestPOIs(@NonNull Location location, @Nullable String poiCategoryIdentifier, int limit, @Nullable es.situm.sdk.directions.DistanceAlgorithm distanceAlgorithm, @NonNull Handler<Collection<PoiWithDistance>> callback)
      Returns a list of indoor POIs ordered from closest to furthest with respect to the given Location. Internally, this method performs a network request to download all POIs and their categories for the building associated with the location, filters them by category, calculates their distances, and orders them. Important: The given location must be indoor, meaning it must include a valid building identifier. If not, the callback will be triggered with an error. Note: You can filter the POIs by category specifying , limit the number of results with and set the distance calculation algorithm with .
      Parameters:
      location - - Non null. Indoor Location that will be taken as origin to calculate distances to the POIs.
      poiCategoryIdentifier - - Apply a PoiCategory filter to the POIs result. If null, we will calculate the distance to every POI of the building.
      limit - - Maximum number of POIs to return. If 0 all the POIs that satisfy the filter will be returned.
      distanceAlgorithm - - See DistanceAlgorithm. If null, defaults to DistanceAlgorithm.HAVERSINE
      callback - - Non null. Handler that will receive either a Collection<PoiWithDistance> with the POIs ordered from closest to furthest, or an error during the fetch operation.
      Throws:
      IllegalArgumentException - is thrown in case or are null.

    • fetchIndoorPOIFromBuilding

      boolean fetchIndoorPOIFromBuilding(@NonNull String poiId, @NonNull String buildingId, @NonNull Handler<Poi> callback)
      Download the given indoor POI of a building.
      Parameters:
      poiId - the POI identifier. Not null.
      buildingId - the building identifier. Not null.
      callback - callback to asynchronously receive the points of interest. Not null.
      Returns:

    • fetchIndoorPOIFromBuilding

      boolean fetchIndoorPOIFromBuilding(@NonNull String poiId, @NonNull String buildingId, CommunicationConfig config, @NonNull Handler<Poi> callback)
      Download the given indoor POI of a building.
      Parameters:
      poiId - the POI identifier. Not null.
      buildingId - the building identifier. Not null.
      config - request specific configuration. Can be null.
      callback - callback to asynchronously receive the points of interest. Not null.
      Returns:

    • fetchAllPOIsFromUser

      boolean fetchAllPOIsFromUser(@NonNull Handler<Collection<Poi>> callback)
      Download the POIs from all the buildings of the user
      Parameters:
      callback - callback to asynchronously receive the points of interest. Not null.

    • fetchAllPOIsFromUser

      boolean fetchAllPOIsFromUser(CommunicationConfig config, @NonNull Handler<Collection<Poi>> callback)
      Download the POIs from all the buildings of the user
      Parameters:
      config - request specific configuration. Can be null.
      callback - callback to asynchronously receive the points of interest. Not null.

    • fetchPoiCategories

      boolean fetchPoiCategories(@NonNull 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(CommunicationConfig config, @NonNull 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:
      config - the request specific configuration. Can be null.
      callback - Callback to asynchronously receive the POI categories

    • fetchPoiCategoryIcon

      boolean fetchPoiCategoryIcon(@NonNull PoiCategory category, boolean selected, @NonNull Handler<android.graphics.Bitmap> callback)
      Get the normal category icon for a category
      Parameters:
      category - the category. Not null.
      selected - fetch icon for selected or normal state.
      callback - the callback. Not null.

    • fetchPoiCategoryIcon

      boolean fetchPoiCategoryIcon(@NonNull PoiCategory category, boolean selected, CommunicationConfig config, @NonNull Handler<android.graphics.Bitmap> callback)
      Get the normal category icon for a category
      Parameters:
      category - the category. Not null.
      selected - fetch icon for selected or normal state.
      config - the request specific configuration. Can be null.
      callback - the callback. Not null.

    • fetchOutdoorPOIsFromBuilding

      boolean fetchOutdoorPOIsFromBuilding(@NonNull String buildingId, @NonNull Handler<Collection<Poi>> callback)
      Download the outdoor POIs of a building
      Parameters:
      buildingId - the building identifier. Not null.
      callback - Callback to asynchronously receive the points of interest. Not null.

    • fetchOutdoorPOIsFromBuilding

      boolean fetchOutdoorPOIsFromBuilding(@NonNull String buildingId, CommunicationConfig config, @NonNull Handler<Collection<Poi>> callback)
      Download the outdoor POIs of a building
      Parameters:
      buildingId - the building identifier. Not null.
      config - requerst specific configuration. Can be null.
      callback - Callback to asynchronously receive the points of interest. Not null.

    • fetchEventsFromBuilding

      boolean fetchEventsFromBuilding(@NonNull String buildingId, @NonNull Handler<Collection<SitumEvent>> callback)
      Download the events of a building
      Parameters:
      buildingId - the building identifier. Not null.
      callback - Callback to asynchronously receive the events of a building. Not null.

    • fetchEventsFromBuilding

      boolean fetchEventsFromBuilding(@NonNull String buildingId, CommunicationConfig config, @NonNull Handler<Collection<SitumEvent>> callback)
      Download the events of a building
      Parameters:
      buildingId - the building identifier. Not null.
      config - request specific configuration. Can be null.
      callback - Callback to asynchronously receive the events of a building. Not null.

    • createOccurrenceForEvent

      boolean createOccurrenceForEvent(@NonNull SitumEvent event, @NonNull Handler<EventOccurrence> callback)
      Create an occurrence for an event.
      Parameters:
      event - the event that occurred. Not null.
      callback - receives an event occurrence, necessary to notify a click and conversion of the same event. Not null.
      See Also:

    • updateOccurrence

      boolean updateOccurrence(@NonNull EventOccurrence occurrence, EventAction action, @NonNull Handler<EventOccurrence> callback)
      Update an event occurrence The time when the action was produced can be provided in the occurrence; if not, new Date() is assumed.
      Parameters:
      occurrence - event occurrence. Not null. occurrence.getId() not null.
      action - action performed on the event.
      callback - receives the updated occurrence, necessary to notify a conversion of the same event. Not null.
      See Also:

    • fetchGeofencesFromBuilding

      boolean fetchGeofencesFromBuilding(@NonNull Building building, @NonNull Handler<List<Geofence>> callback)
      Get the geofences of a building
      Parameters:
      building - the building. Not null.
      callback - the callback. Not null.

    • fetchGeofencesFromBuilding

      boolean fetchGeofencesFromBuilding(@NonNull Building building, CommunicationConfig config, @NonNull Handler<List<Geofence>> callback)
      Get the geofences of a building
      Parameters:
      building - the building. Not null.
      config - request specific configuration. Can be null.
      callback - the callback. Not null.

    • fetchRailWidth

      boolean fetchRailWidth(@NonNull String buildingId, @NonNull Handler<Float> callback)
      Get the calibrations rail width used in a building
      Parameters:
      buildingId - the building identifier. Not null
      callback - the callback. Not null

    • updateRailWidth

      boolean updateRailWidth(@NonNull String building, float railWidth, @NonNull Handler<Object> callback)
      Update the calibrations rail width for a building
      Parameters:
      building - the building identifier. Not null
      railWidth - the new rail width
      callback - the callback. Not null

    • fetchRemoteConfig

      boolean fetchRemoteConfig(@NonNull Handler<RemoteConfig> callback)
      Get the RemoteConfig for the current user.
      Parameters:
      callback - Callback to asynchronously receive the remote config. Not null.

    • fetchRemoteConfig

      boolean fetchRemoteConfig(@NonNull LocationRequest locationRequest, @NonNull Handler<RemoteConfig> callback)
      Get the RemoteConfig for the current user. The given LocationRequest will be used do override the remote location request.
      Parameters:
      locationRequest - Local location request used to override remote values. Not null.
      callback - Callback to asynchronously receive the remote config. Not null.

    • invalidateCache

      void invalidateCache()
      Invalidate all the resources in the cache

    • invalidateTiles

      void invalidateTiles()
      Invalidate all tiles resources

    • getHttpRequestExecutor

      @NonNull HttpRequestExecutor getHttpRequestExecutor()
      Return the HTTP Request Executor to make custom requests to the Dashboard

    • prefetchPositioningInfo

      @Deprecated boolean prefetchPositioningInfo(Map<String,Object> options, Handler<String> callback)
      Deprecated.
      use prefetchPositioningInfo(CommunicationConfig, Handler) instead
      Download all the necessary information to start positioning. This includes Building, BuildingInfo and the building's model. Downloaded information will be saved in cache. Previous to version 2.50.2 the model was only obtained while starting positioning inside a Building
      Parameters:
      callback - Callback to asynchronously receive the result of this call. An error will be notified if anything fails during the download, only the most critical error will be sent
      options - the request options. Can be null. Accepted options: CommunicationOptions.FORCE_DOWNLOAD, CommunicationOptions.SERVER_FIRST, CommunicationOptions.CACHE_FIRST, CommunicationOptions.PRELOAD_IMAGES

    • prefetchPositioningInfo

      @Deprecated boolean prefetchPositioningInfo(@NonNull List<String> buildingIds, Map<String,Object> options, Handler<String> callback)
      Deprecated.
      use prefetchPositioningInfo(List, CommunicationConfig, Handler) instead
      Download all the necessary information to start positioning in the selected buildings. This includes Building, BuildingInfo and the building's model. Downloaded information will be saved in cache. Previous to version 2.50.2 the model was only obtained while starting positioning inside a Building
      Parameters:
      buildingIds - List with the ids of the buildings you want to prefetch
      callback - Callback to asynchronously receive the result of this call. An error will be notified if anything fails during the download, only the most critical error will be sent
      options - the request options. Can be null. Accepted options: CommunicationOptions.FORCE_DOWNLOAD, CommunicationOptions.SERVER_FIRST, CommunicationOptions.CACHE_FIRST, CommunicationOptions.PRELOAD_IMAGES

    • fetchBuildings

      @Deprecated boolean fetchBuildings(Map<String,Object> options, @NonNull Handler<Collection<Building>> callback)
      Deprecated.
      use fetchBuildings(CommunicationConfig, Handler) instead
      Download all the buildings for the current user
      Parameters:
      options - the request options. Can be null. Accepted options: CommunicationOptions.FORCE_DOWNLOAD, CommunicationOptions.SERVER_FIRST
      callback - Callback to asynchronously receive the buildings. Not null.

    • fetchBuildingInfo

      @Deprecated boolean fetchBuildingInfo(Building building, @NonNull Handler<BuildingInfo> callback)
      Deprecated.
      use fetchBuildingInfo(String, Handler) instead
      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

      @Deprecated boolean fetchBuildingInfo(@NonNull Building building, Map<String,Object> options, @NonNull Handler<BuildingInfo> callback)
      Deprecated.
      use fetchBuildingInfo(String, CommunicationConfig, Handler) instead
      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, CommunicationOptions.SERVER_FIRST, CommunicationOptions.PRELOAD_IMAGES
      callback - Callback to asynchronously receive the buildings. Not null.

    • fetchFloorsFromBuilding

      @Deprecated boolean fetchFloorsFromBuilding(@NonNull Building building, @NonNull Handler<Collection<Floor>> callback)
      Deprecated.
      use fetchFloorsFromBuilding(String, Handler) instead
      Download all the floors of a building
      Parameters:
      building - the building. Not null.
      callback - Callback to asynchronously receive the floors. Not null.

    • fetchFloorsFromBuilding

      @Deprecated boolean fetchFloorsFromBuilding(@NonNull Building building, Map<String,Object> options, @NonNull Handler<Collection<Floor>> callback)
      Deprecated.
      use fetchFloorsFromBuilding(String, CommunicationConfig, Handler) instead
      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), CommunicationOptions.PRELOAD_IMAGES
      callback - Callback to asynchronously receive the floors. Not null.

    • fetchMapFromFloor

      @Deprecated boolean fetchMapFromFloor(@NonNull Floor floor, Map<String,Object> options, @NonNull Handler<android.graphics.Bitmap> callback)
      Deprecated.
      use fetchMapFromFloor(Floor, CommunicationConfig, Handler) instead
      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, CommunicationOptions.SERVER_FIRST
      callback - callback to asynchronously receive the image. Not null.

    • fetchIndoorPOIsFromBuilding

      @Deprecated boolean fetchIndoorPOIsFromBuilding(@NonNull Building building, @NonNull Handler<Collection<Poi>> callback)
      Deprecated.
      use fetchIndoorPOIsFromBuilding(String, Handler) instead
      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

      @Deprecated boolean fetchIndoorPOIsFromBuilding(@NonNull Building building, Map<String,Object> options, @NonNull Handler<Collection<Poi>> callback)
      Deprecated.
      use fetchIndoorPOIsFromBuilding(String, CommunicationConfig, Handler) instead
      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, CommunicationOptions.SERVER_FIRST, CommunicationOptions.PRELOAD_IMAGES
      callback - callback to asynchronously receive the points of interest. Not null.

    • fetchPoiCategories

      @Deprecated boolean fetchPoiCategories(Map<String,Object> options, @NonNull Handler<Collection<PoiCategory>> callback)
      Deprecated.
      use fetchPoiCategories(CommunicationConfig, Handler) instead
      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, CommunicationOptions.SERVER_FIRST, CommunicationOptions.PRELOAD_IMAGES
      callback - Callback to asynchronously receive the POI categories

    • fetchPoiCategoryIconNormal

      @Deprecated boolean fetchPoiCategoryIconNormal(@NonNull PoiCategory category, @NonNull Handler<android.graphics.Bitmap> callback)
      Deprecated.
      use fetchPoiCategoryIcon(PoiCategory, boolean, Handler) instead
      Get the normal category icon for a category
      Parameters:
      category - the category. Not null.
      callback - the callback. Not null.

    • fetchPoiCategoryIconNormal

      @Deprecated boolean fetchPoiCategoryIconNormal(@NonNull PoiCategory category, Map<String,Object> options, @NonNull Handler<android.graphics.Bitmap> callback)
      Deprecated.
      use fetchPoiCategoryIcon(PoiCategory, boolean, CommunicationConfig, Handler) instead
      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, CommunicationOptions.SERVER_FIRST
      callback - the callback. Not null.

    • fetchPoiCategoryIconSelected

      @Deprecated boolean fetchPoiCategoryIconSelected(@NonNull PoiCategory category, @NonNull Handler<android.graphics.Bitmap> callback)
      Deprecated.
      use fetchPoiCategoryIcon(PoiCategory, boolean, Handler) instead
      Get the selected category icon for a category
      Parameters:
      category - the category. Not null.
      callback - the callback. Not null.

    • fetchPoiCategoryIconSelected

      @Deprecated boolean fetchPoiCategoryIconSelected(@NonNull PoiCategory category, Map<String,Object> options, @NonNull Handler<android.graphics.Bitmap> callback)
      Deprecated.
      use fetchPoiCategoryIcon(PoiCategory, boolean, CommunicationConfig, Handler) instead
      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

      @Deprecated boolean fetchOutdoorPOIsFromBuilding(@NonNull Building building, @NonNull Handler<Collection<Poi>> callback)
      Deprecated.
      use fetchOutdoorPOIsFromBuilding(String, Handler) instead
      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

      @Deprecated boolean fetchOutdoorPOIsFromBuilding(@NonNull Building building, Map<String,Object> options, @NonNull Handler<Collection<Poi>> callback)
      Deprecated.
      use fetchOutdoorPOIsFromBuilding(String, CommunicationConfig, Handler) instead
      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, CommunicationOptions.SERVER_FIRST, CommunicationOptions.PRELOAD_IMAGES
      callback - Callback to asynchronously receive the points of interest. Not null.

    • fetchEventsFromBuilding

      @Deprecated boolean fetchEventsFromBuilding(@NonNull Building building, @NonNull Handler<Collection<SitumEvent>> callback)
      Deprecated.
      use fetchEventsFromBuilding(String, Handler) instead
      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

      @Deprecated boolean fetchEventsFromBuilding(@NonNull Building building, Map<String,Object> options, @NonNull Handler<Collection<SitumEvent>> callback)
      Deprecated.
      use fetchEventsFromBuilding(String, CommunicationConfig, Handler) instead
      Download the events of a building
      Parameters:
      building - the building. Not null.
      options - the request options. Can be null. Accepted options: CommunicationOptions.FORCE_DOWNLOAD, CommunicationOptions.SERVER_FIRST
      callback - Callback to asynchronously receive the events of a building. Not null.

    • eventSeen

      @Deprecated boolean eventSeen(@NonNull SitumEvent event, @NonNull Handler<EventOccurrence> callback)
      Deprecated.
      use createOccurrenceForEvent(SitumEvent, Handler) instead
      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:

    • eventSeen

      @Deprecated boolean eventSeen(@NonNull SitumEvent event, Map<String,Object> options, @NonNull Handler<EventOccurrence> callback)
      Deprecated.
      use createOccurrenceForEvent(SitumEvent, Handler) instead
      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:

    • eventClicked

      @Deprecated boolean eventClicked(@NonNull EventOccurrence occurrence, @NonNull Handler<EventOccurrence> callback)
      Deprecated.
      use updateOccurrence(EventOccurrence, EventAction, Handler) instead
      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:

    • eventClicked

      @Deprecated boolean eventClicked(@NonNull EventOccurrence occurrence, Map<String,Object> options, @NonNull Handler<EventOccurrence> callback)
      Deprecated.
      use updateOccurrence(EventOccurrence, EventAction, Handler) instead
      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

      @Deprecated boolean eventConverted(@NonNull EventOccurrence occurrence, @NonNull Handler<EventOccurrence> callback)
      Deprecated.
      use updateOccurrence(EventOccurrence, EventAction, Handler) instead
      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:

    • eventConverted

      @Deprecated boolean eventConverted(@NonNull EventOccurrence occurrence, Map<String,Object> options, @NonNull Handler<EventOccurrence> callback)
      Deprecated.
      use updateOccurrence(EventOccurrence, EventAction, Handler) instead
      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:

    • fetchGeofencesFromBuilding

      @Deprecated boolean fetchGeofencesFromBuilding(@NonNull Building building, Map<String,Object> options, @NonNull Handler<List<Geofence>> callback)
      Deprecated.
      use fetchGeofencesFromBuilding(Building, CommunicationConfig, Handler) instead
      Get the geofences of a building
      Parameters:
      building - the building. Not null.
      options - the request options. Can be null.
      callback - the callback. Not null.

    • fetchCalibratedArea

      @Deprecated boolean fetchCalibratedArea(@NonNull Building building, @NonNull Floor floor, @NonNull Handler<Collection<CalibrationArea>> callback)
      Deprecated.
      Use CalibrationManager.fetchActiveGtScans(Floor, Handler)
      Get the calibrated areas for a floor. This call will try to fetch the last updated data if possible.
      Parameters:
      building - the building. Not null
      floor - the floor. Not null
      callback - the callback. Not null

    • fetchCalibrationWifiScans

      @Deprecated boolean fetchCalibrationWifiScans(@NonNull Building building, @NonNull Floor floor, @NonNull Handler<Scans> callback)
      Deprecated.
      Use CalibrationManager.fetchActiveWifiScans(Floor, Handler)
      Get the wifi scanned points for a floor. This call will try to fetch the last updated data if possible.
      Parameters:
      building - the building. Not null
      floor - the floor. Not null
      callback - the callback. Not null

    • fetchCalibrationBleScans

      @Deprecated boolean fetchCalibrationBleScans(@NonNull Building building, @NonNull Floor floor, @NonNull Handler<Scans> callback)
      Deprecated.
      Use CalibrationManager.fetchActiveBleScans(Floor, Handler)
      Get the BLE scanned points for a floor. This call will try to fetch the last updated data if possible.
      Parameters:
      building - the building. Not null
      floor - the floor. Not null
      callback - the callback. Not null

    • fetchRailWidth

      @Deprecated boolean fetchRailWidth(@NonNull Building building, @NonNull Handler<Float> callback)
      Deprecated.
      use fetchRailWidth(String, Handler) instead
      Get the calibrations rail width used in a building
      Parameters:
      building - the building. Not null
      callback - the callback. Not null

    • updateRailWidth

      @Deprecated boolean updateRailWidth(@NonNull Building building, float railWidth, @NonNull Handler<Object> callback)
      Deprecated.
      use updateRailWidth(String, float, Handler) instead
      Update the calibrations rail width for a building
      Parameters:
      building - the building. Not null
      railWidth - the new rail width
      callback - the callback. Not null