Class MPSolution

Readonly availableLanguages

Optional Readonly customerId

Readonly defaultLanguage

Readonly id

Optional Readonly locationTemplates

Optional mapClientUrl

Readonly name

Readonly solutionConfig

Optional Readonly types

hasLanguage

• hasLanguage(language?): boolean

• Check if the solution supports a language.

  Matching follows BCP-47 / RFC 4647 rather than string equality, so the tag does not have to be spelled exactly the way the CMS spells it. Casing is ignored (zh-hant matches zh-Hant), the ICU underscore form is accepted (zh_Hans), legacy region-only Chinese tags resolve to their script (zh-CN matches zh-Hans, zh-TW matches zh-Hant), and a more specific tag falls back to a less specific one (en-US matches en).

  Deliberately conservative about ambiguity: bare zh does not match a solution that advertises only zh-Hans and zh-Hant, because there is no way to tell which script is wanted. Pass the script explicitly in that case.

  true means the tag is safe to pass to MapsIndoors.setLanguage. false is not a guarantee that setLanguage will reject it - see that method for what its boolean means on each platform.

  Parameters

  • Optional language: string

    A BCP-47 language tag, for example en, zh-Hans or zh-CN.

  Returns boolean

is3DExtrusionsEnabled

• is3DExtrusionsEnabled(): boolean

• Check whether room extrusions are available for select map providers.

  Returns boolean

is3DWallsEnabled

• is3DWallsEnabled(): boolean

• Check whether wall extrusions are available for select map providers.

  Returns boolean

isZoom22Enabled

• isZoom22Enabled(): boolean

• Check whether the 22nd zoom level is available for select map providers.

  Returns boolean

parseMapClient

• parseMapClient(venueId, locationId): Promise<string>

• Parses a venue ID and a location ID to create a mapClientUrl.

  Parameters

  • venueId: string

  • locationId: string

  Returns Promise<string>

  Async

resolveLanguage

• resolveLanguage(language?): string

• Resolve a language tag to the exact tag this solution advertises.

  The companion to hasLanguage, for when a yes or no is not enough: given a device locale, this returns the tag to hand to MapsIndoors.setLanguage, spelled the way the CMS spells it. resolveLanguage("zh-Hant-TW") returns "zh-Hant" for a solution that publishes it.

  Parameters

  • Optional language: string

    A BCP-47 language tag, for example en, zh-Hans or zh-CN.

  Returns string

  The matching advertised tag, or undefined if there is none.

Static create

• create(object): MPSolution

• Creator for MPSolution, used to decode JSON from the MapsIndoors SDK.

  Parameters

  • object: MPSolutionParams

  Returns MPSolution

  Static