MapsIndoorsSDK/com.mapsindoors.core/MapsIndoors

MapsIndoors

class MapsIndoors

MapsIndoors

Types

Link copied to clipboard
interface OnAPIKeyErrorListener
Invoked in case of a INVALID_API_KEY error when performing an internal http request

Functions

Link copied to clipboard
open fun addDisplayRuleForLocation(@NonNull location: MPLocation, @NonNull displayRule: MPDisplayRule): Boolean
Add a relation between a MPLocation and a MPDisplayRule.
Link copied to clipboard
open fun addLocationSourceOnStatusChangedListener(@Nullable listener: MPLocationSourceOnStatusChangedListener)
Adds the given listener that will be invoked each time a location source status changes
Link copied to clipboard
@AnyThread
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
Link copied to clipboard
open fun addOnMapsIndoorsReadyListener(@NonNull listener: OnMapsIndoorsReadyListener)
Add a one time listener to be invoked when MapsIndoors is ready
Link copied to clipboard
open fun applyUserRoles(userRoles: List<MPUserRole>)
Applies a list of MPUserRole to the user that will get the UserRole specific locations.
Link copied to clipboard
open fun checkOfflineDataAvailability(): Boolean
Checks if there is on device data (embedded/locally stored) available.
Link copied to clipboard
open fun destroy()
Clears the internal state of MapsIndoors SDK.
Link copied to clipboard
open fun disableEventLogging(disableLogging: Boolean)
Disable SDK event logging through MapsIndoors.
Link copied to clipboard
@NonNull
open fun getAPIKey(): String
Retrieves the API Key that was set by using load
Link copied to clipboard
@Nullable
open fun getAppConfig(): MPAppConfig
Gets the MPAppConfig for the current API Key/language
Link copied to clipboard
@Nullable
open fun getAppliedUserRoles(): List<MPUserRole>
Returns a list of MPUserRole that is applied to the user
Link copied to clipboard
open fun getAuthenticationDetails(apiKey: String, onAuthDetailsReadyListener: OnAuthDetailsReadyListener)
Link copied to clipboard
@Nullable
open fun getAuthToken(): String
Gets the MapsIndoors authentication token, if any has been set.
Link copied to clipboard
@Nullable
open fun getAvailableLanguages(): List<String>
Returns the list of the current solution's available languages
Link copied to clipboard
@Nullable
open fun getBuildings(): MPBuildingCollection
Gets the MPBuildingCollection for the current API Key/language
Link copied to clipboard
@Nullable
open fun getCategories(): MPCategoryCollection
Gets the MPCategoryCollection for the current API Key/language
Link copied to clipboard
Link copied to clipboard
@Nullable
open fun getDefaultDisplayRule(): MPDisplayRule
Retrieve the default display rule (hardcoded display rule in the SDK).
Link copied to clipboard
@Nullable
open fun getDefaultLanguage(): String
Returns the current solution's default language
Link copied to clipboard
@Nullable
open fun getDisplayRule(@NonNull location: MPLocation): MPDisplayRule
Retrieve the display rule for the given MPLocation Requires that a solution is loaded.
@Nullable
open fun getDisplayRule(@NonNull solutionDisplayRule: MPSolutionDisplayRule): MPDisplayRule
Retrieve the display rule for the given MPSolutionDisplayRule enum.
@Nullable
open fun getDisplayRule(@NonNull name: String): MPDisplayRule
Retrieve the display rule with a given name.
Link copied to clipboard
Link copied to clipboard
@NonNull
open fun getLanguage(): String
Gets the current SDK language
Link copied to clipboard
@Nullable
open fun getLocationById(@Nullable id: String): MPLocation
Retrieves a MPLocation by its id
Link copied to clipboard
@NonNull
open fun getLocations(): List<MPLocation>
Gets all locations (a list of MPLocation objects) for the current API Key/language
Link copied to clipboard
@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
Link copied to clipboard
@NonNull
open fun getLocationsByExternalIds(@NonNull externalIds: List<String>): List<MPLocation>
Retrieves a list of MPLocation by external id(s)
Link copied to clipboard
@Nullable
open fun getMainDisplayRule(): MPDisplayRule
Retrieve the main display rule (defined in backend data and can be configured in the CMS).
Link copied to clipboard
@Nullable
open fun getMapsIndoorsLocationSource(): MPLocationSource
Gets the default location data source (MapsIndoors location data)
Link copied to clipboard
@NonNull
open fun getMapStyles(): List<MPMapStyle>
Gets a list of available map styles
Link copied to clipboard
Link copied to clipboard
@Nullable
open fun getPositionProvider(): MPPositionProvider
Returns the current position provider, if any
Link copied to clipboard
@Nullable
open fun getSolution(): MPSolution
Gets the MPSolution for the current API Key/language
Link copied to clipboard
@Nullable
open fun getSolutionInfo(): MPSolutionInfo
Get the MPSolutionInfo data for the current API Key/language
Link copied to clipboard
@Nullable
open fun getUserRoles(): MPUserRoleCollection
Gets the User Roles for the current solution Note that role names are localized
Link copied to clipboard
@Nullable
open fun getVenues(): MPVenueCollection
Gets the MPVenueCollection for the current API Key/language
Link copied to clipboard
open fun isAPIKeyValid(): Boolean
Checks if the current api key is a valid one
Link copied to clipboard
open fun isInitialized(): Boolean
Returns true if at least, initialize has been already called
Link copied to clipboard
open fun isOfflineMode(): Boolean
Checks if the SDK has been allowed to access the network
Link copied to clipboard
open fun isReady(): Boolean
Returns true if MapsIndoors has been initialized and data has already been loaded
Link copied to clipboard
open fun load(@NonNull applicationContext: Context, @NonNull apiKey: String, @Nullable onMapsIndoorsReadyListener: OnMapsIndoorsReadyListener)
Loads content from the MapsIndoors solution matching the given API key.
Link copied to clipboard
open fun removeDisplayRuleForLocation(@NonNull location: MPLocation): Boolean
Remove a relation between a MPLocation and a MPDisplayRule.
Link copied to clipboard
@AnyThread
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
Link copied to clipboard
open fun removeOnMapsIndoorsReadyListener(@NonNull listener: OnMapsIndoorsReadyListener)
Remove a onMapsIndoorsReadyListener
Link copied to clipboard
open fun reverseGeoCode(@NonNull point: MPPoint, onGeoCodeResultReadyListener: OnGeoCodeResultReadyListener)
Get a MPGeoCodeResult that contains lists of MPLocation by MPLocationBaseType, where the MPPoint is inside the geometry.
Link copied to clipboard
open fun setAuthToken(@NonNull authToken: String)
Sets the MapsIndoors authentication token.
Link copied to clipboard
open fun setLanguage(@NonNull language: String): Boolean
Sets the SDK's internal language.
Link copied to clipboard
@AnyThread
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
Link copied to clipboard
open fun setNetworkOptions(@NonNull mpNetworkOptions: MPNetworkOptions)
Sets a MPNetworkOptions to use for all internal Backend Requests.
Link copied to clipboard
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
Link copied to clipboard
open fun setPositionProvider(@Nullable positionProvider: MPPositionProvider)
Link copied to clipboard
@AnyThread
open fun synchronizeContent(@Nullable onSyncDataReadyListener: OnSyncDataReadyListener): Boolean
Main data synchronization method If not manually invoked, MapControl.create() will