Maps Indoors

addOnMapsIndoorsReadyListener

open fun addLocationSources(@NonNull locationSources: List<MPLocationSource>, @Nullable onResultReadyListener: OnResultReadyListener)

Adds one or more location data sources Note that if this method or setLocationSources is not invoked, a MapsIndoors data source will be usedWhen this method is invoked, getLocations will be called on all the location sources registered only if any new sources has been added

open fun addOnMapsIndoorsReadyListener(@NonNull listener: OnMapsIndoorsReadyListener)

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

applyUserRoles

open fun applyUserRoles(userRoles: List<MPUserRole>)

Applies a list of MPUserRole 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.

destroy

open fun destroy()

Clears the internal state of MapsIndoors SDK.

disableEventLogging

open fun disableEventLogging(disableLogging: Boolean)

Disable SDK event logging through MapsIndoors.

getAPIKey

open fun getAPIKey(): String

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

getAppConfig

open fun getAppConfig(): MPAppConfig

Gets the MPAppConfig for the current API Key/language

getAppliedUserRoles

open fun getAppliedUserRoles(): List<MPUserRole>

Returns a list of MPUserRole that is applied to the user

getAuthenticationDetails

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

getAuthToken

open fun getAuthToken(): String

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

getAvailableLanguages

open fun getAvailableLanguages(): List<String>

Returns the list of the current solution's available languages

getBuildings

open fun getBuildings(): MPBuildingCollection

Gets the MPBuildingCollection for the current API Key/language

getCategories

open fun getCategories(): MPCategoryCollection

Gets the MPCategoryCollection for the current API Key/language

getDataSet

open fun getDataSet(): MPDataSet

getDefaultDisplayRule

open fun getDefaultDisplayRule(): MPDisplayRule

Retrieve the default display rule (hardcoded display rule in the SDK).

getDefaultLanguage

open fun getDefaultLanguage(): String

Returns the current solution's default language

getDisplayRule

open fun getDisplayRule(@NonNull location: MPLocation): MPDisplayRule

Retrieve the display rule for the given MPLocation Requires that a solution is loaded.

open fun getDisplayRule(@NonNull solutionDisplayRule: MPSolutionDisplayRule): MPDisplayRule

Retrieve the display rule for the given MPSolutionDisplayRule enum.

open fun getDisplayRule(@NonNull name: String): MPDisplayRule

Retrieve the display rule with a given name.

getImageProvider

open fun getImageProvider(): MPImageProviderInterface

getLanguage

open fun getLanguage(): String

Gets the current SDK language

getLocationById

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

Retrieves a MPLocation by its id

getLocations

open fun getLocations(): List<MPLocation>

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

getLocationsAsync

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

getMainDisplayRule

getMapsIndoorsLocationSource

open fun getMainDisplayRule(): MPDisplayRule

Retrieve the main display rule (defined in backend data and can be configured in the CMS).

open fun getMapsIndoorsLocationSource(): MPLocationSource

Gets the default location data source (MapsIndoors location data)

getMapStyles

open fun getMapStyles(): List<MPMapStyle>

Gets a list of available map styles

getNetworkOptions

open fun getNetworkOptions(): MPNetworkOptions

getPositionProvider

open fun getPositionProvider(): MPPositionProvider

Returns the current position provider, if any

getSolution

open fun getSolution(): MPSolution

Gets the MPSolution for the current API Key/language

getSolutionInfo

open fun getSolutionInfo(): MPSolutionInfo

Get the MPSolutionInfo data for the current API Key/language

getUserRoles

open fun getUserRoles(): MPUserRoleCollection

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

getVenues

removeDisplayRuleForLocation

open fun getVenues(): MPVenueCollection

Gets the MPVenueCollection for the current API Key/language

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

isOfflineMode

open fun isOfflineMode(): Boolean

Checks if the SDK has been allowed to access the network

isReady

open fun isReady(): Boolean

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

load

open fun load( @NonNull applicationContext: Context, @NonNull apiKey: String, @Nullable onMapsIndoorsReadyListener: OnMapsIndoorsReadyListener)

Loads content from the MapsIndoors solution matching the given API key.

open fun removeDisplayRuleForLocation(@NonNull location: MPLocation): Boolean

Remove a relation between a MPLocation and a MPDisplayRule.

removeLocationSourceOnStatusChangedListener

open fun removeLocationSourceOnStatusChangedListener(@Nullable listener: MPLocationSourceOnStatusChangedListener)

Removes the given listener

removeLocationSources

removeOnMapsIndoorsReadyListener

open fun removeLocationSources(@NonNull locationSources: List<MPLocationSource>, @Nullable onResultReadyListener: OnResultReadyListener)

Removes one or more location data sources When this method is invoked, getLocations will be called on all the location sources registered only if any sources has been removed

open fun removeOnMapsIndoorsReadyListener(@NonNull listener: OnMapsIndoorsReadyListener)

Remove a onMapsIndoorsReadyListener

setAuthToken

open fun setAuthToken(@NonNull authToken: String)

Sets the MapsIndoors authentication token.

setLanguage

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

Sets the SDK's internal language.

setLocationSources

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

Sets one or more location data sources Note that if this method or addLocationSources 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

open fun setNetworkOptions(@NonNull mpNetworkOptions: MPNetworkOptions)

Sets a MPNetworkOptions to use for all internal Backend Requests.

setOfflineMode

open fun setOfflineMode(offlineMode: Boolean)

Allows or not the SDK to access the network (online data) This will directly affect the online state of the SDK

setPositionProvider

open fun setPositionProvider(@Nullable positionProvider: MPPositionProvider)

synchronizeContent