android-sdk-core/com.mapsted.positioning/CoreApi/Properties

Properties

interface Properties

Use PropertyManager for property related information and functionalities

Functions

Link copied to clipboard
abstract fun addPropertyDownloadListener(@NonNull listener: PropertyDownloadManager.Listener): Boolean
add listener which will be notified anytime a property is downloaded
Link copied to clipboard
abstract fun addUnloadPropertyDataListener(@NonNull listener: CoreApi.UnloadPropertyDataListener): Boolean
add listener for change in property data
Link copied to clipboard
abstract fun delete(propertyId: Int, onComplete: Consumer<Boolean>)
Delete property data from persistent storage.
Link copied to clipboard
abstract fun deserializePropertyDataAsync(propertyId: Int, propertyDataDownloadListener: PropertyDataDownloadListener)
Download a property's property data based on its property id.
Link copied to clipboard
abstract fun findEntityByName(name: String, propertyId: Int, callback: Consumer<List<SearchEntity>>)
Method to retrieve the list of SearchEntity by a propertyID that matches the nameSubString
Link copied to clipboard
@WorkerThread
abstract fun getAll(): List<PropertyInfo>
Get the list of PropertyInfo
Link copied to clipboard
@NonNull
@WorkerThread
abstract fun getAllIds(): Set<Integer>
Get a Set of property ids that indicates all properties stored.
Link copied to clipboard
abstract fun getAllSearchPOIs(propertyId: Int): List<ISearchable>
get all search points of interest of property
Link copied to clipboard
@Nullable
abstract fun getCached(propertyId: Int): PropertyData
Get a property's cached PropertyData from core library based on property id.
Link copied to clipboard
@Nullable
abstract fun getCachedEntity(@NonNull entityZone: EntityZone): Entity
Get cached entity based on entity zone.
Link copied to clipboard
@Nullable
abstract fun getCachedPropertyData(propertyId: Int): PropertyData
Get a property's cached PropertyData from core library based on property id.
Link copied to clipboard
@NonNull
abstract fun getCachedPropertyIds(): Set<Integer>
Get a java.util.HashSet of property ids that indicates all properties cached.
Link copied to clipboard
abstract fun getCategories(propertyId: Int, resultCallback: Consumer<CategoriesResult>)
Get categories for the property
abstract fun getCategories(propertyIds: List<Integer>, resultCallback: Consumer<CategoriesResult>)
Get all categories associated with multiple properties
Link copied to clipboard
abstract fun getData(propertyId: Int, callback: Consumer<PropertyData>)
Gets cached PropertyData or triggers download, if necessary
Link copied to clipboard
@NonNull
abstract fun getDownloadStatus(propertyId: Int): DownloadStatus
Get the current DownloadStatus of a property.
Link copied to clipboard
abstract fun getEntity(entityZone: EntityZone, callback: Consumer<Entity>)
Get entity based on entity zone.
@Nullable
abstract fun getEntity(propertyId: Int, buildingId: Int, entityId: Int): Entity

abstract fun getEntity(propertyId: Int, buildingId: Int, entityId: Int, callback: Consumer<Entity>)
Get entity based on property, building and entity Ids.
Link copied to clipboard
abstract fun getIds(@NonNull consumer: Consumer<Set<Integer>>)
Async fetch the list of propertyIds
Link copied to clipboard
@Nullable
abstract fun getInfo(propertyId: Int): PropertyInfo
Get PropertyInfo corresponding to a specific property id.
Link copied to clipboard
abstract fun getInfoList(@NonNull consumer: Consumer<List<PropertyInfo>>)
Async fetch the list of PropertyInfo
Link copied to clipboard
abstract fun getInfoOptional(propertyId: Int): Optional<PropertyInfo>
Link copied to clipboard
@NonNull
@WorkerThread
abstract fun getInfos(): Map<Integer, PropertyInfo>
Get PropertyInfoMap stored in core library.
abstract fun getInfos(@NonNull consumer: Consumer<Map<Integer, PropertyInfo>>)
Async fetch the property Infos
Link copied to clipboard
abstract fun getLastSyncTime(propertyId: Int): Long
last sync time for given property
Link copied to clipboard
abstract fun getNumCachedProperties(): Int
Get the number of properties currently cached in memory
Link copied to clipboard
@WorkerThread
abstract fun getPropertyInfoList(): List<PropertyInfo>
Get property infos stored in core library as a list.
Link copied to clipboard
abstract fun getSearchEntityListByPropertyId(propertyId: Int, callback: Consumer<List<SearchEntity>>)
Method to retrieve the list of SearchEntity by a propertyID
Link copied to clipboard
abstract fun getSelectedProperty(): Int
Link copied to clipboard
abstract fun isCached(propertyId: Int): Boolean
Checks whether a given property is cached in memory
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract fun searchPoi(propertyId: Int, @Nullable poiFilter: PoiFilter, resultCallback: Consumer<List<out ISearchable>>)
searches for points of interest based on given PoiFilter.
Link copied to clipboard
abstract fun setSelectedPropertyId(propertyId: Int)
Link copied to clipboard
abstract fun startDownload(propertyId: Int, listener: PropertyDownloadManager.Listener)
Download a property map data.
Link copied to clipboard
abstract fun stopDownload(propertyId: Int)
Stop download property information.
Link copied to clipboard
abstract fun unload(propertyId: Int, onComplete: Consumer<Boolean>)
Unload property data from memory.
Generated by Dokka
© 2026 Copyright