Class ARMessage

ARMessage is a helper class to send and receive messages between Client App and Map Webview

Constructors

constructor

Properties

authSocket createSocket destroySocket getAuthor getDefaultRecipients getDefaultTarget getSocket on send setAuthor setDefaultRecipients setDefaultTarget

Constructors

constructor

Properties

Static authSocket

authSocket: ((recipients?) => void) = authSocket

Type declaration

    • (recipients?): void

    • Identify the current Author (User/Application) on the current websocket

      Parameters

      • recipients: string[] = []

        recipients which should receive a notification this author has logged in

      Returns void

Static createSocket

createSocket: ((server) => undefined | WebSocket) = createSocket

Type declaration

    • (server): undefined | WebSocket

    • Create a new websocket client to the given server

      Parameters

      • server: string

      Returns undefined | WebSocket

      the new websocket client

Static destroySocket

destroySocket: (() => void) = destroySocket

Type declaration

    • (): void

    • Destroy the current websocket client

      Returns void

Static getAuthor

getAuthor: (() => string) = getARMessageAuthor

Type declaration

    • (): string

    • Returns string

Static getDefaultRecipients

getDefaultRecipients: (() => string[]) = getDefaultRecipients

Type declaration

    • (): string[]

    • Get the current default recipients for ARMessage.send

      Returns string[]

      the current default recipients for ARMessage.send

Static getDefaultTarget

getDefaultTarget: (() => ARMessageTarget) = getDefaultTarget

Type declaration

    • (): ARMessageTarget

    • Get the current default target for ARMessage.send

      Returns ARMessageTarget

      the current default target for ARMessage.send

Static getSocket

getSocket: (() => null | WebSocket) = getSocket

Type declaration

    • (): null | WebSocket

    • Get the current websocket client

      Returns null | WebSocket

      the current websocket client

Static on

on: ((eventType, handler) => undefined | ARMessageHandlerCleanup) = onARMessage

Type declaration

Static send

send: ((message, options?) => ARMessageEvent) = sendARMessage

Type declaration

Static setAuthor

setAuthor: ((author) => void) = setARMessageAuthor

Type declaration

    • (author): void

    • Assume a new Author name (User/Application) on the current websocket

      Parameters

      • author: string

        the new author name

      Returns void

Static setDefaultRecipients

setDefaultRecipients: ((recipients) => void) = setDefaultRecipients

Type declaration

    • (recipients): void

    • Set the new default recipients for ARMessage.send

      Parameters

      • recipients: string[]

        the new default recipients for ARMessage.send

      Returns void

Static setDefaultTarget

setDefaultTarget: ((targets) => ARMessageTarget) = setDefaultARMessageTarget

Type declaration

    • (targets): ARMessageTarget

    • Set the new default targets for ARMessage.send

      Parameters

      • targets: ARMessageTarget

        the new default targets for ARMessage.send

      Returns ARMessageTarget

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc