Class MPError

A class of errors that can occur when using the MapsIndoors SDK.

Export

Hierarchy

  • MPError

Constructors

constructor

Properties

code message status? tag? baseMapCacheNotRegistered baseMapCachingNotSupported invalidApiKey networkError sdkNotInitialized unknownError

Methods

create parse

Constructors

constructor

  • Creates an instance of MPError.

    Parameters

    • code: number

      The errors code, this will be a MapsIndoors error code.

      If unsure of the code, check the native SDK.

    • message: string

      A descriptive message of what caused the error.

    • Optional status: number

      An optional status code, this will in case of network issues be the response code.

    • Optional tag: any

      Optional object tag.

    Returns MPError

Properties

Readonly code

code: number

The errors code, this will be a MapsIndoors error code.

If unsure of the code, check the native SDK.

Readonly message

message: string

A descriptive message of what caused the error.

Optional Readonly status

status?: number

An optional status code, this will in case of network issues be the response code.

Optional Readonly tag

tag?: any

Optional object tag.

Static Readonly baseMapCacheNotRegistered

baseMapCacheNotRegistered: number = 9001

Occurs if base-map tile caching is attempted before a map provider's base-map cache has been registered with the SDK.

Static

Static Readonly baseMapCachingNotSupported

baseMapCachingNotSupported: number = 9000

Occurs if base-map tile caching is attempted on a map provider that cannot cache base-map tiles. The Mapbox provider supports it; the Google Maps provider does not.

Canonical copy. The same value is spelled out in Android's MIError.BASEMAP_CACHE_NOT_SUPPORTED and as a literal in iOS's doRejectBaseMapCache; drift silently reports "not supported" as a generic failure.

Static

Static Readonly invalidApiKey

invalidApiKey: number = 100

Occurs if the supplied API key is not a valid MapsIndoors key.

Static

Static Readonly networkError

networkError: number = 10

Occurs when an internet connection is required, or if the content server is unresponsive.

Static

Static Readonly sdkNotInitialized

sdkNotInitialized: number = 22

Occurs if some functions are called before the SDK has been initialized.

Static

Static Readonly unknownError

unknownError: number = 20

Occurs if an unknown exception is caught.

Static

Methods

Static create

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

    Parameters

    • object: MPErrorParams

    Returns MPError

    Static

Static parse

  • Turn a rejection from a native module into an MPError.

    The native modules reject with a JSON-encoded MPError, but a rejection reaching here can also come from the bridge itself or from JavaScript, and then the message is plain text. Parsing that blindly threw a SyntaxError and threw away the real message, so a caller saw "JSON Parse error: Unexpected character: E" instead of what actually went wrong. Fall back to wrapping the message as an unknown error, which keeps it readable and keeps this method's contract - it returns an MPError, it does not throw a different one.

    Parameters

    • error: Error

    Returns MPError

    Static

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc