Class default

Main class for accessing data in the MapsIndoors SDK.

Export

MapsIndoors

Methods

`Static`addVenuesToSync

addVenuesToSync(venues: string[]): Promise<void>
Add venues to the sync list.
Parameters
- venues: string[]
  list of venueIds to add to sync.
Returns Promise<void>
- Defined in MapsIndoors.ts:536

`Static`applyUserRoles

applyUserRoles(userRoles: MPUserRole[]): Promise<void>
Applies a list of MPUserRoles to the SDK which will get the UserRole specific locations..
Parameters
- userRoles: MPUserRole[]
Returns Promise<void>
Static
Async
- Defined in MapsIndoors.ts:512

`Static`cacheData

cacheData(apiKey: String): Promise<boolean>
Cache all data for the current solution. Including tiles and images if present on the solution.
Parameters
- apiKey: String
  The key to the MapsIndoors solution.
Returns Promise<boolean>
Promise True if the caching was successful, otherwise false.
- Defined in MapsIndoors.ts:568

`Static`checkOfflineDataAvailability

checkOfflineDataAvailability(): Promise<boolean>
Checks if there is on device data (embedded/locally stored) available. For this to return true, data has to be available for all solution data types (MPLocation, MPBuilding...).

Returns true if data is available, otherwise returns false.

Returns Promise<boolean>
Static
Async
- Defined in MapsIndoors.ts:415

`Static`destroy

destroy(): Promise<void>
Clears the internal state of MapsIndoors SDK. Any loaded content is purged from memory.

Invoke load to start the SDK anew.

Returns Promise<void>
Static
Async
- Defined in MapsIndoors.ts:429

`Static`disableEventLogging

disableEventLogging(disable: boolean): Promise<void>
disable SDK event logging through MapsIndoors. No logs will be created or send with this disabled.

By default it is enabled. But disabled in the CMS meaning logs will be created but never uploaded.
Parameters
- disable: boolean
Returns Promise<void>
Static
Async
- Defined in MapsIndoors.ts:138

`Static`getApiKey

getApiKey(): Promise<string>
Retrieves the API key that was set when calling load.

Will return empty string if no key has been set.

Returns Promise<string>
Static
Async
- Defined in MapsIndoors.ts:152

`Static`getAppliedUserRoles

getAppliedUserRoles(): Promise<MPUserRole[]>
Returns the list of MPUserRoles that is currently applied.

Returns Promise<MPUserRole[]>
Static
Async
- Defined in MapsIndoors.ts:524

`Static`getAvailableLanguages

getAvailableLanguages(): Promise<string[]>
Returns a list of the current solution's available languages.

Returns Promise<string[]>
Static
Async
- Defined in MapsIndoors.ts:164

`Static`getBuildings

getBuildings(): Promise<MPBuildingCollection>
Gets a collection of all building for the current solution.

Returns Promise<MPBuildingCollection>
Static
Async
- Defined in MapsIndoors.ts:84

`Static`getCategories

getCategories(): Promise<MPCategoryCollection>
Gets a collection of all categories for the current solution.

Returns Promise<MPCategoryCollection>
Static
Async
- Defined in MapsIndoors.ts:101

`Static`getDefaultDisplayRule

getDefaultDisplayRule(): Promise<MPDisplayRule>
Retrieve the default display rule (fallback rule in case the main rule has not loaded/ has errors).

Returns Promise<MPDisplayRule>
Static
Async
- Defined in MapsIndoors.ts:349

`Static`getDefaultLanguage

getDefaultLanguage(): Promise<string>
Returns the default language for the current solution.

Returns Promise<string>
Static
Async
- Defined in MapsIndoors.ts:177

`Static`getDefaultVenue

getDefaultVenue(): Promise<MPVenue>
Gets the default venue for this solution.

Returns Promise<MPVenue>
Static
Async
- Defined in MapsIndoors.ts:52

`Static`getDisplayRuleByLocation

getDisplayRuleByLocation(location: MPLocation): Promise<MPDisplayRule>
Retrieve the display rule for the given location.

Requires that load has successfully executed.
Parameters
- location: MPLocation
Returns Promise<MPDisplayRule>
Static
Async
- Defined in MapsIndoors.ts:289

`Static`getDisplayRuleByName

getDisplayRuleByName(name: string): Promise<MPDisplayRule>
Retrieve the display rule with a given [@link name}.

Requires that load has successfully executed.
Parameters
- name: string
  The ID of the DisplayRule
Returns Promise<MPDisplayRule>
Static
Async
- Defined in MapsIndoors.ts:306

`Static`getLanguage

getLanguage(): Promise<string>
Gets the language currently used in the SDK.

Returns Promise<string>
Static
Async
- Defined in MapsIndoors.ts:189

`Static`getLocationById

getLocationById(id: string): Promise<MPLocation>
Retrieves a MPLocation by its id.
Parameters
- id: string
Returns Promise<MPLocation>
Static
Async
- Defined in MapsIndoors.ts:202

`Static`getLocations

getLocations(): Promise<MPLocation[]>
Gets all locations (a list of MPLocation objects) for the current solution.

Returns Promise<MPLocation[]>
Static
Async
- Defined in MapsIndoors.ts:118

`Static`getLocationsAsync

getLocationsAsync(query: MPQuery, filter: MPFilter): Promise<MPLocation[]>
Run a query on all available locations with a query and filter.
Parameters
- query: MPQuery
- filter: MPFilter
Returns Promise<MPLocation[]>
Static
Async
- Defined in MapsIndoors.ts:269

`Static`getLocationsByExternalIds

getLocationsByExternalIds(externalIds: string[]): Promise<MPLocation[]>
Retrieves a list of MPLocations by externalIds.
Parameters
- externalIds: string[]
Returns Promise<MPLocation[]>
Static
Async
- Defined in MapsIndoors.ts:222

`Static`getMainDisplayRule

getMainDisplayRule(): Promise<MPDisplayRule>
Retrieve the main display rule (can be configured in the CMS).

Requires that load has successfully executed.

Returns Promise<MPDisplayRule>
Static
Async
- Defined in MapsIndoors.ts:322

`Static`getMapStyles

getMapStyles(): Promise<MPMapStyle[]>
Gets a collection of available map styles.

Returns Promise<MPMapStyle[]>
Static
Async
- Defined in MapsIndoors.ts:237

`Static`getSolution

getSolution(): Promise<MPSolution>
Gets the MPSolution for the current loaded api key.

Returns Promise<MPSolution>
Static
Async
- Defined in MapsIndoors.ts:252

`Static`getSolutionDisplayRule

getSolutionDisplayRule(
solutionDisplayRule: MPSolutionDisplayRule,
): Promise<MPDisplayRule>
Retrieve the corresponding display rule for the given MPSolutionDisplayRule.

Requires that load has successfully executed.
Parameters
- solutionDisplayRule: MPSolutionDisplayRule
Returns Promise<MPDisplayRule>
Static
Async
- Defined in MapsIndoors.ts:337

`Static`getSyncedVenues

getSyncedVenues(): Promise<string[]>
Get a list of venueIds that are synced.

Returns Promise<string[]>
Promise<string[]> A list of venueIds that are synced.
- Defined in MapsIndoors.ts:553

`Static`getUserRoles

getUserRoles(): Promise<MPUserRoleCollection>
Gets the User Roles for the current solution.

Note that role names are localized.

Returns Promise<MPUserRoleCollection>
Static
Async
- Defined in MapsIndoors.ts:397

`Static`getVenues

getVenues(): Promise<MPVenueCollection>
Gets a collection of all venues for the current solution.

Returns Promise<MPVenueCollection>
Static
Async
- Defined in MapsIndoors.ts:67

`Static`isApiKeyValid

isApiKeyValid(): Promise<boolean>
Check if the current API key is valid.

Returns Promise<boolean>
Static
Async
- Defined in MapsIndoors.ts:441

`Static`isInitialized

isInitialized(): Promise<boolean>
Check if load has been called.

Returns Promise<boolean>
Static
Async
- Defined in MapsIndoors.ts:453

`Static`isReady

isReady(): Promise<boolean>
Check if the SDK is initialized and ready for use.

Returns Promise<boolean>
Static
Async
- Defined in MapsIndoors.ts:465

`Static`load

load(apiKey: String, venues?: String[]): Promise<void>
Loads content from the MapsIndoors solution matching the given API apiKey.
Parameters
- apiKey: String
  The key to the MapsIndoors solution.
- Optionalvenues: String[] = null
  An optional list of venueIds as strings.
Returns Promise<void>
If the load fails for any reason, it will reject with a MPError.

Static
Async
- Defined in MapsIndoors.ts:38

`Static`removeVenuesToSync

removeVenuesToSync(venues: string[]): Promise<void>
Remove venues from the sync list.
Parameters
- venues: string[]
  List of venueIds to remove from sync.
Returns Promise<void>
- Defined in MapsIndoors.ts:545

`Static`setLanguage

setLanguage(language: string): Promise<boolean>
Sets the SDK's internal language.

By default, the SDK language can be:
- the solution's default language (MPSolutionInfo#getDefaultLanguage()).
- the current device language, if the MapsIndoors data isn't available (ie: first app run without network access).
Parameters
- language: string
Returns Promise<boolean>
Static
Async
- Defined in MapsIndoors.ts:483

`Static`setPositionProvider

setPositionProvider(
positonProvider?: MPPositionProviderInterface,
): Promise<void>
Set a new position provider, or pass undefined to remove the current one.
Parameters
- OptionalpositonProvider: MPPositionProviderInterface
Returns Promise<void>
Static
Async
- Defined in MapsIndoors.ts:363

`Static`synchronizeContent

synchronizeContent(): Promise<void>
Main data synchronization method.

If not manually invoked, [MapControl.create(config, listener)] will invoke it.

Returns Promise<void>
Static
Async
- Defined in MapsIndoors.ts:497