@magiclane/maps-sdk
    Preparing search index...

    Class ExternalInfoHandlerInternal

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    id notifyProgressInterval progressMultiplier

    Methods

    cancelWikiInfo dispose handleEvent notifyComplete notifyCompleteWithData notifyProgress notifyStart notifyStatusChanged registerOnCompleteWithDataCallback registerOnNotifyStatusChanged registerOnProgressCallback init

    Constructors

    Accessors

    • get id(): any

      Returns any

    • get notifyProgressInterval(): number

      The interval in ms to receive progress updates.

      SDK uses this interval to notify the progress. Default is 200ms (5 times per second).

      Returns number

      The progress interval in milliseconds

    • set notifyProgressInterval(ms: number): void

      The interval in ms to receive progress updates.

      SDK uses this interval to notify the progress. Default is 200ms (5 times per second).

      Parameters

      • ms: number

      Returns void

      The progress interval in milliseconds

    • get progressMultiplier(): number

      Get the progress multiplier.

      SDK uses floating point values in the [0, 1] interval for progress tracking. The values received in the notifyProgress notification are integers obtained by multiplying the internal floating point value with the value returned by progressMultiplier.

      Returns number

      The progress multiplier

    Methods

    • Returns void

    • Method called when an event is triggered from the native side.

      Should not be called by the user.

      Parameters

      • args: Record<string, any>

        The event data.

      Returns void

    • Parameters

      • err: number
      • hint: string
      • json: Record<string, any>

      Returns void

    • Registers a callback to be invoked when the operation is completed.

      Parameters

      • callback: (err: number, hint: string, json: Record<string, any>) => void

        The function to call on completion. The callback receives:

        • err: The error code.
        • hint: Additional information about the completion.
        • json: Additional data for the completion.

      Returns void

    • Registers a callback to be invoked when the status of the operation changes.

      Parameters

      • callback: (status: number) => void

        The function to call when the status changes. The callback receives:

        • status: The new status.

      Returns void

    • Registers a callback to be invoked when the progress is updated.

      Parameters

      • callback: (progress: number) => void

        The function to call on progress update. The callback receives:

        • progress: The progress value.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods