public static interface

CoreApi.Buildings

com.mapsted.positioning.CoreApi.Buildings

Class Overview

Use BuildingManager to get building related information and functionalities

Summary

Public Methods
abstract void downloadAndCache(int buildingId, Consumer<BuildingData> callback)
Get BuildingData from core library based on its building id.
abstract void getBuildingData(int buildingId, Consumer<BuildingData> callback)
Returns cached building data if available, otherwise downloads and returns that data.
abstract BuildingInfo getBuildingInfo(int buildingId)
Get BuildingInfo corresponding to a specific building id.
abstract BuildingData getCachedBuildingData(int buildingId)
Get a building's BuildingData from core library based on its building id.
abstract void getFloorId(int buildingId, int entityId, Consumer<Integer> callback)
Returns the floorId corresponding to the specific building entity
abstract boolean isCached(int buildingId)
Checks whether a given building is cached in memory

Public Methods

public abstract void downloadAndCache (int buildingId, Consumer<BuildingData> callback)

Get BuildingData from core library based on its building id.

Note: This function should be called on a background thread.

Parameters
buildingId The stored building's building id.
callback callback

public abstract void getBuildingData (int buildingId, Consumer<BuildingData> callback)

Returns cached building data if available, otherwise downloads and returns that data.

Parameters
callback callback with BuildingData cached or downloaded. May be null if download fails.

public abstract BuildingInfo getBuildingInfo (int buildingId)

Get BuildingInfo corresponding to a specific building id.

BuildingInfo contains all information of a building such as the building's id, the name of the building, X and Y coordinates etc.

Parameters
buildingId Building id corresponding to the BuildingInfo returned.
Returns
  • BuildingInfo for the specified building id. See BuildingInfo

public abstract BuildingData getCachedBuildingData (int buildingId)

Get a building's BuildingData from core library based on its building id.

Parameters
buildingId The stored building's building id.
Returns
  • The stored building data that needs to be get. See BuildingData

public abstract void getFloorId (int buildingId, int entityId, Consumer<Integer> callback)

Returns the floorId corresponding to the specific building entity

Parameters
buildingId The building
entityId The entity
callback Callback for the corresponding floorId

public abstract boolean isCached (int buildingId)

Checks whether a given building is cached in memory

Parameters
buildingId the building to test
Returns
  • Whether or not it is cached in memory