Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MessageClient

Communication channel for sending messages to GMAF. Includes handling of long running jobs, progress reporting, and cancellation.

Hierarchy

  • MessageClient

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

app

app: ViewerApplication

Methods

Private _postMessage

  • _postMessage(messageType: string, content: string): void

  • Intended to be called by GMAF only.

    Parameters

    • messageType: string
    • content: string

    Returns void

message

  • message(messageType: string, payload: any, cancellationToken?: CancellationToken, progress?: function): Promise<any>

  • Sends a message to GMAF and returns a Promise that will be resolved when the operation is complete. Operations can be short running (if there is no cancellation token) or long running (if there is a cancellation token).

    Parameters

    • messageType: string
    • payload: any
    • Optional cancellationToken: CancellationToken
    • Optional progress: function
        • (status: any): void

        • Parameters

          • status: any

          Returns void

    Returns Promise<any>

subscribe

  • subscribe(messageType: string, handler: function): void

  • Parameters

    Returns void

unsubscribe

  • unsubscribe(messageType: string, handler: function): void

  • Parameters

    Returns void