MapsIndoorsSDK/com.mapsindoors.mapssdk/MapsIndoors

MapsIndoors

class MapsIndoors

MapsIndoors

Author

Types

OnAPIKeyErrorListener

interface OnAPIKeyErrorListener

Invoked in case of a INVALID_API_KEY error when performing an internal http request

Functions

addLocationSourceOnStatusChangedListener

open fun addLocationSourceOnStatusChangedListener(@Nullable listener: MPLocationSourceOnStatusChangedListener)

Adds the given listener that will be invoked each time a location source status changes

addOnMapsIndoorsReadyListener

open fun addOnMapsIndoorsReadyListener(@NonNull listener: OnMapsIndoorsReadyListener)

Add a one time listener to be invoked when MapsIndoors is ready

allowToDownloadData

open fun allowToDownloadData(allowToDownloadData: Boolean)

Allows or not the SDK to access the network (online data) This will directly affect the online state of the SDK (isOnline} will return false if this method is set to false)

applyUserRoles

open fun applyUserRoles(userRoles: List<UserRole>)

Applies a list of UserRole to the user that will get the UserRole specific locations.

checkOfflineDataAvailability

open fun checkOfflineDataAvailability(): Boolean

Checks if there is on device data (embedded/locally stored) available.

clearCachedData

open fun clearCachedData(force: Boolean)

Clean up all solution related data stored in memory.

disableEventLogging

open fun disableEventLogging(disableLogging: Boolean)

Disable SDK event logging through MapsIndoors.

enableOfflineTilesUpdates

open fun enableOfflineTilesUpdates(enable: Boolean)

Lets the SDK check for offline tile delta updates from MapsIndoors servers.

getAPIKey

@NonNull

open fun getAPIKey(): String

Retrieves the API Key that was set using either initialize or setAPIKey

getAppConfig

@Nullable

open fun getAppConfig(): AppConfig

Gets the AppConfig for the current API Key/language

getAppliedUserRoles

@Nullable

open fun getAppliedUserRoles(): List<UserRole>

Returns a list of UserRole that is applied to the user

getAuthenticationDetails

open fun getAuthenticationDetails(apiKey: String, onAuthDetailsReadyListener: OnAuthDetailsReadyListener)

getAuthToken

@Nullable

open fun getAuthToken(): String

Gets the MapsIndoors authentication token, if any has been set.

getAvailableDefaultLanguages

@Nullable

open fun getAvailableDefaultLanguages(): List<String>

Returns a list of the current available default languages - i.e.

getAvailableLanguages

@Nullable

open fun getAvailableLanguages(): List<String>

Returns the list of the current solution's available languages

getBadgedAvailabilityIcon

@Nullable

open fun getBadgedAvailabilityIcon( location: MPLocation, originalIcon: Bitmap, badgePosition: BadgePosition, state: Boolean, colorOn: Int, colorOff: Int, scaleFactor: Float): Bitmap

Returns an icon with an availability badge (checkmark or cross badge, with colors, usually green and red).

getBuildings

@Nullable

open fun getBuildings(): BuildingCollection

Gets the BuildingCollection for the current API Key/language

getCategories

@Nullable

open fun getCategories(): CategoryCollection

Gets the CategoryCollection for the current API Key/language

getDataSet

@Nullable

open fun getDataSet(): DataSet

getDefaultLanguage

@Nullable

open fun getDefaultLanguage(): String

Returns the current solution's default language

getGoogleAPIKey

@Nullable

open fun getGoogleAPIKey(): String

Retrieves the Google API key set using setGoogleAPIKey

getHighLightColor

open fun getHighLightColor(): Int

Get the current highlight color

getImageProvider

@NonNull

open fun getImageProvider(): ImageProvider

getLanguage

@Nullable

open fun getLanguage(): String

Gets the current SDK language

getLocale

@Nullable

open fun getLocale(): Locale

getLocationById

@Nullable

open fun getLocationById(@Nullable id: String): MPLocation

Retrieves a MPLocation by its id

getLocations

@NonNull

open fun getLocations(): List<MPLocation>

Gets all locations (a list of MPLocation objects) for the current API Key/language

getLocationsAsync

@AnyThread

open fun getLocationsAsync( @Nullable query: MPQuery, @Nullable filter: MPFilter, @Nullable listener: OnLocationsReadyListener)

Runs a query on all the available locations with optional MPQuery and MPFilter data

getMapsIndoorsLocationSource

@Nullable

open fun getMapsIndoorsLocationSource(): MPLocationSource

Gets the default location data source (MapsIndoors location data)

getMapStyles

@NonNull

open fun getMapStyles(): List<MapStyle>

Gets a list of available map styles

getPositionProvider

@Nullable

open fun getPositionProvider(): PositionProvider

Returns the current position provider, if any

getSDKVersion

@NonNull

open fun getSDKVersion(): String

Returns this SDK version string

getSDKVersionCode

open fun getSDKVersionCode(): Int

Returns this SDK's version code

getSolution

@Nullable

open fun getSolution(): Solution

Gets the Solution for the current API Key/language

getSolutionInfo

@Nullable

open fun getSolutionInfo(): SolutionInfo

Get the SolutionInfo data for the current API Key/language

getUserRoles

@Nullable

open fun getUserRoles(): List<UserRole>

Gets the User Roles for the current solution Note that role names are localized

getVenues

@Nullable

open fun getVenues(): VenueCollection

Gets the VenueCollection for the current API Key/language

hasSynchronizeContentBeenCalled

open fun hasSynchronizeContentBeenCalled(): Boolean

Returns true if synchronizeContent() has been called at least once

initialize

open fun initialize(@NonNull appContext: Context, @NonNull apiKey: String): Boolean

open fun initialize( @NonNull appContext: Context, @NonNull apiKey: String, @NonNull onLoadingDataReadyListener: OnLoadingDataReadyListener): Boolean

Initializes the SDK

isAllowedToDownloadData

open fun isAllowedToDownloadData(): Boolean

Checks if the SDK has been allowed to access the network

isAPIKeyValid

open fun isAPIKeyValid(): Boolean

Checks if the current api key is a valid one

isInitialized

open fun isInitialized(): Boolean

Returns true if at least, initialize has been already called

isOfflineLocationsEnabled

open fun isOfflineLocationsEnabled(): Boolean

Checks if location data is available for offline mode Offline location data will available if mapsindoors_offlinemode_locations_enabled is set to true in the mapsindoors_api resource file

isOfflineModeEnabled

open fun isOfflineModeEnabled(): Boolean

Checks if offline mode has been set Offline mode has to be set using mapsindoors_offlinemode_enabled in the mapsindoors_api.xml resource file

isOfflineRoutingEnabled

open fun isOfflineRoutingEnabled(): Boolean

Checks if offline routing has been enabled Offline Routing has to be set using mapsindoors_offlinemode_routing_enabled in the mapsindoors_api.xml resource file

isOfflineTilesEnabled

open fun isOfflineTilesEnabled(): Boolean

Checks if MapsIndoors tiles are present in offline mode Offline Tiles will available if mapsindoors_offlinemode_tiles_enabled is set to true in the mapsindoors_api.xml resource file

isOnline

open fun isOnline(): Boolean

Checks if the device is online and allowed to Note that even with a working network, this method will return false if network access was disallowed (by using allowDataDownload)

isReady

open fun isReady(): Boolean

Returns true if MapsIndoors has been initialized and data has already been loaded

isSynchronizingContent

open fun isSynchronizingContent(): Boolean

Returns true if synchronizeContent has been called and it hasn't yet finished

onApplicationConfigurationChanged

open fun onApplicationConfigurationChanged(@Nullable newConfig: Configuration)

Call this from your overridden onConfigurationChanged method

onApplicationLowMemory

@Deprecated

~~open~~ ~~fun~~ ~~onApplicationLowMemory~~()

Call this from your overridden onLowMemory method

onApplicationTerminate

@AnyThread

open fun onApplicationTerminate()

Call this from your overridden onTerminate method IMPORTANT: This will effectively remove the SDK data from memory.

onApplicationTrimMemory

open fun onApplicationTrimMemory(level: Int)

Call this from your overridden onTrimMemory method

removeLocationSourceOnStatusChangedListener

open fun removeLocationSourceOnStatusChangedListener(@Nullable listener: MPLocationSourceOnStatusChangedListener)

Removes the given listener

removeOnMapsIndoorsReadyListener

open fun removeOnMapsIndoorsReadyListener(@NonNull listener: OnMapsIndoorsReadyListener)

Remove a onMapsIndoorsReadyListener

setAPIKey

open fun setAPIKey(@NonNull apiKey: String): Boolean

open fun setAPIKey(@NonNull apiKey: String, @NonNull onLoadingDataReadyListener: OnLoadingDataReadyListener): Boolean

Sets the app's current MapsIndoors API Key When setting a new API key, current data will be cleared along with the active MapControl will have to be remade and initialized.

setAPIKeyValidityListener

open fun setAPIKeyValidityListener(@Nullable onAPIKeyErrorListener: MapsIndoors.OnAPIKeyErrorListener)

Sets a callback for when a call to our servers has been rejected because of the use of an invalidated API Key

setAuthToken

open fun setAuthToken(@NonNull authToken: String)

Sets the MapsIndoors authentication token.

setGoogleAPIKey

open fun setGoogleAPIKey(@Nullable googleAPIKey: String)

Sets the Google API Key used by the MPRoutingProvider

setHighLightColor

open fun setHighLightColor(@NonNull color: Int)

Set the highlight color

setImageProvider

open fun setImageProvider(@Nullable imageProvider: ImageProvider)

Sets the SDK to use a custom ImageProvider implementation

setLanguage

open fun setLanguage(@Nullable language: String): Boolean

Sets the SDK's internal language.

setLocationSources

@AnyThread

open fun setLocationSources(@NonNull locationSources: Array<MPLocationSource>, @Nullable onResultReadyListener: OnResultReadyListener)

Sets one or more location data sources Note that if this method is not invoked, a MapsIndoors data source will be usedWhen this method is invoked, getLocations() will be called on all the location sources registered

setNetworkOptions