Class default

Main class for accessing data in the MapsIndoors SDK.

Export

MapsIndoors

Methods

addVenuesToSync applyUserRoles cacheData checkOfflineDataAvailability destroy disableEventLogging getApiKey getAppliedUserRoles getAvailableLanguages getBuildings getCategories getDefaultDisplayRule getDefaultLanguage getDefaultVenue getDisplayRuleByLocation getDisplayRuleByName getLanguage getLocationById getLocations getLocationsAsync getLocationsByExternalIds getMainDisplayRule getMapStyles getSolution getSolutionDisplayRule getSyncedVenues getUserRoles getVenues isApiKeyValid isInitialized isReady load removeVenuesToSync setLanguage setPositionProvider synchronizeContent

Methods

StaticaddVenuesToSync

  • addVenuesToSync(venues: string[]): Promise<void>

    Add venues to the sync list.

    Parameters

    • venues: string[]

      list of venueIds to add to sync.

    Returns Promise<void>

StaticapplyUserRoles

  • applyUserRoles(userRoles: MPUserRole[]): Promise<void>

    Applies a list of MPUserRoles to the SDK which will get the UserRole specific locations..

    Parameters

    Returns Promise<void>

    Static

    Async

StaticcacheData

  • 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.

StaticcheckOfflineDataAvailability

  • 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

Staticdestroy

  • 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

StaticdisableEventLogging

  • 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

StaticgetApiKey

  • 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

StaticgetAppliedUserRoles

  • getAppliedUserRoles(): Promise<MPUserRole[]>

    Returns the list of MPUserRoles that is currently applied.

    Returns Promise<MPUserRole[]>

    Static

    Async

StaticgetAvailableLanguages

  • getAvailableLanguages(): Promise<string[]>

    Returns a list of the current solution's available languages.

    Returns Promise<string[]>

    Static

    Async

StaticgetBuildings

StaticgetCategories

StaticgetDefaultDisplayRule

  • 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

StaticgetDefaultLanguage

  • getDefaultLanguage(): Promise<string>

    Returns the default language for the current solution.

    Returns Promise<string>

    Static

    Async

StaticgetDefaultVenue

  • getDefaultVenue(): Promise<MPVenue>

    Gets the default venue for this solution.

    Returns Promise<MPVenue>

    Static

    Async

StaticgetDisplayRuleByLocation

StaticgetDisplayRuleByName

  • 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

StaticgetLanguage

  • getLanguage(): Promise<string>

    Gets the language currently used in the SDK.

    Returns Promise<string>

    Static

    Async

StaticgetLocationById

  • getLocationById(id: string): Promise<MPLocation>

    Retrieves a MPLocation by its id.

    Parameters

    • id: string

    Returns Promise<MPLocation>

    Static

    Async

StaticgetLocations

  • getLocations(): Promise<MPLocation[]>

    Gets all locations (a list of MPLocation objects) for the current solution.

    Returns Promise<MPLocation[]>

    Static

    Async

StaticgetLocationsAsync

StaticgetLocationsByExternalIds

  • getLocationsByExternalIds(externalIds: string[]): Promise<MPLocation[]>

    Retrieves a list of MPLocations by externalIds.

    Parameters

    • externalIds: string[]

    Returns Promise<MPLocation[]>

    Static

    Async

StaticgetMainDisplayRule

  • 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

StaticgetMapStyles

  • getMapStyles(): Promise<MPMapStyle[]>

    Gets a collection of available map styles.

    Returns Promise<MPMapStyle[]>

    Static

    Async

StaticgetSolution

  • getSolution(): Promise<MPSolution>

    Gets the MPSolution for the current loaded api key.

    Returns Promise<MPSolution>

    Static

    Async

StaticgetSolutionDisplayRule

StaticgetSyncedVenues

  • getSyncedVenues(): Promise<string[]>

    Get a list of venueIds that are synced.

    Returns Promise<string[]>

    Promise<string[]> A list of venueIds that are synced.

StaticgetUserRoles

  • getUserRoles(): Promise<MPUserRoleCollection>

    Gets the User Roles for the current solution.

    Note that role names are localized.

    Returns Promise<MPUserRoleCollection>

    Static

    Async

StaticgetVenues

  • getVenues(): Promise<MPVenueCollection>

    Gets a collection of all venues for the current solution.

    Returns Promise<MPVenueCollection>

    Static

    Async

StaticisApiKeyValid

  • isApiKeyValid(): Promise<boolean>

    Check if the current API key is valid.

    Returns Promise<boolean>

    Static

    Async

StaticisInitialized

  • isInitialized(): Promise<boolean>

    Check if load has been called.

    Returns Promise<boolean>

    Static

    Async

StaticisReady

  • isReady(): Promise<boolean>

    Check if the SDK is initialized and ready for use.

    Returns Promise<boolean>

    Static

    Async

Staticload

  • 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

StaticremoveVenuesToSync

  • removeVenuesToSync(venues: string[]): Promise<void>

    Remove venues from the sync list.

    Parameters

    • venues: string[]

      List of venueIds to remove from sync.

    Returns Promise<void>

StaticsetLanguage

  • 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

StaticsetPositionProvider

  • setPositionProvider(
        positonProvider?: MPPositionProviderInterface,
    ): Promise<void>

    Set a new position provider, or pass undefined to remove the current one.

    Parameters

    Returns Promise<void>

    Static

    Async

StaticsynchronizeContent

  • synchronizeContent(): Promise<void>

    Main data synchronization method.

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

    Returns Promise<void>

    Static

    Async

Settings

Member Visibility

On This Page

Methods