Edit

ObservableUIRawMessage Class

An observable that holds a UIRawMessage value. Listeners are notified whenever the value changes.

Methods

constructor

new ObservableUIRawMessage(data: UIRawMessage, options?: ObservableOptions)

Creates a new ObservableUIRawMessage with the provided initial UIRawMessage value.

Parameters

  • data: UIRawMessage

    The initial UIRawMessage value for this observable.

  • options?: ObservableOptions = null

    Optional configuration for the observable, such as whether the value can be written by the client.

Returns ObservableUIRawMessage

Notes:

  • This function can't be called in restricted-execution mode.
  • This function can be called in early-execution mode.

getData

getData(): UIRawMessage

Returns the current UIRawMessage value held by this observable.

Returns UIRawMessage

Notes:

  • This function can't be called in restricted-execution mode.
  • This function can be called in early-execution mode.

setData

setData(data: UIRawMessage): void

Updates the UIRawMessage value held by this observable. If the new value differs from the current value, all subscribed listeners are notified with the new value.

Parameters

Notes:

  • This function can't be called in restricted-execution mode.
  • This function can be called in early-execution mode.

subscribe

subscribe(callback: (arg0: UIRawMessage) => void): (arg0: UIRawMessage) => void

Registers a callback to be invoked whenever the observable's value changes. Returns the callback, which can be passed to unsubscribe to remove the listener.

Parameters

  • callback: (arg0: UIRawMessage) => void

    A function that receives the new UIRawMessage value each time the observable changes.

Returns (arg0: UIRawMessage) => void

Notes:

  • This function can't be called in restricted-execution mode.
  • This function can be called in early-execution mode.

unsubscribe

unsubscribe(callback: (arg0: UIRawMessage) => void): boolean

Removes a previously registered listener from this observable. Returns true if the listener was found and removed, false if it was not found.

Parameters

  • callback: (arg0: UIRawMessage) => void

    The callback handle previously returned by subscribe.

Returns boolean

Notes:

  • This function can't be called in restricted-execution mode.
  • This function can be called in early-execution mode.
  • Last updated on