Class default

Main class for accessing data in the MapsIndoors SDK.

Export

Constructors

constructor

Methods

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

Constructors

Private constructor

  • new default(): default
  • Private

    Creates an instance of MapsIndoors.

    Returns default

Methods

Static applyUserRoles

  • applyUserRoles(userRoles): Promise<void>

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

    Parameters

    Returns Promise<void>

    Static

    Async

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

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

Static disableEventLogging

  • disableEventLogging(disable): 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

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

Static getAppliedUserRoles

  • getAppliedUserRoles(): Promise<MPUserRole[]>

  • Returns the list of MPUserRoles that is currently applied.

    Returns Promise<MPUserRole[]>

    Static

    Async

Static getAvailableLanguages

  • getAvailableLanguages(): Promise<string[]>

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

    Returns Promise<string[]>

    Static

    Async

Static getBuildings

Static getCategories

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

Static getDefaultLanguage

  • getDefaultLanguage(): Promise<string>

  • Returns the default language for the current solution.

    Returns Promise<string>

    Static

    Async

Static getDefaultVenue

  • getDefaultVenue(): Promise<MPVenue>

  • Gets the default venue for this solution.

    Returns Promise<MPVenue>

    Static

    Async

Static getDisplayRuleByLocation

  • getDisplayRuleByLocation(location): Promise<MPDisplayRule>

  • Retrieve the display rule for the given location.

    Requires that load has successfully executed.

    Parameters

    Returns Promise<MPDisplayRule>

    Static

    Async

Static getDisplayRuleByName

  • getDisplayRuleByName(name): 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

Static getLanguage

  • getLanguage(): Promise<string>

  • Gets the language currently used in the SDK.

    Returns Promise<string>

    Static

    Async

Static getLocationById

  • getLocationById(id): Promise<MPLocation>

  • Retrieves a MPLocation by its id.

    Parameters

    • id: string

    Returns Promise<MPLocation>

    Static

    Async

Static getLocations

  • getLocations(): Promise<MPLocation[]>

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

    Returns Promise<MPLocation[]>

    Static

    Async

Static getLocationsAsync

  • getLocationsAsync(query, filter): Promise<MPLocation[]>

  • Run a query on all available locations with a query and filter.

    Parameters

    Returns Promise<MPLocation[]>

    Static

    Async

Static getLocationsByExternalIds

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

  • Retrieves a list of MPLocations by externalIds.

    Parameters

    • externalIds: string[]

    Returns Promise<MPLocation[]>

    Static

    Async

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

Static getMapStyles

  • getMapStyles(): Promise<MPMapStyle[]>

  • Gets a collection of available map styles.

    Returns Promise<MPMapStyle[]>

    Static

    Async

Static getSolution

  • getSolution(): Promise<MPSolution>

  • Gets the MPSolution for the current loaded api key.

    Returns Promise<MPSolution>

    Static

    Async

Static getSolutionDisplayRule

Static getUserRoles

  • getUserRoles(): Promise<MPUserRoleCollection>

  • Gets the User Roles for the current solution.

    Note that role names are localized.

    Returns Promise<MPUserRoleCollection>

    Static

    Async

Static getVenues

  • getVenues(): Promise<MPVenueCollection>

  • Gets a collection of all venues for the current solution.

    Returns Promise<MPVenueCollection>

    Static

    Async

Static isApiKeyValid

  • isApiKeyValid(): Promise<boolean>

  • Check if the current API key is valid.

    Returns Promise<boolean>

    Static

    Async

Static isInitialized

  • isInitialized(): Promise<boolean>

  • Check if load has been called.

    Returns Promise<boolean>

    Static

    Async

Static isReady

  • isReady(): Promise<boolean>

  • Check if the SDK is initialized and ready for use.

    Returns Promise<boolean>

    Static

    Async

Static load

  • load(apiKey): Promise<void>

  • Loads content from the MapsIndoors solution matching the given API apiKey.

    Parameters

    • apiKey: String

      The key to the MapsIndoors solution.

    Returns Promise<void>

    If the load fails for any reason, it will reject with a MPError.

    Static

    Async

Static setLanguage

  • setLanguage(language): 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

Static setPositionProvider

  • setPositionProvider(positonProvider?): Promise<void>

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

    Parameters

    Returns Promise<void>

    Static

    Async

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc