Class ObservableUIRawMessage

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

Index

Constructors

Methods

getData setData subscribe unsubscribe

Constructors

constructor

new ObservableUIRawMessage(
data: UIRawMessage,
options?: ObservableOptions,
): ObservableUIRawMessage
Parameters
- data: UIRawMessage
  The initial UIRawMessage value for this observable.
- Optionaloptions: ObservableOptions
  Optional configuration for the observable, such as whether the value can be written by the client.
Returns ObservableUIRawMessage
Remarks
Creates a new ObservableUIRawMessage with the provided initial UIRawMessage value.

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Privilege
early-execution-allowed - This function can be called in early-execution mode.
- Defined in tmp/package/index.d.ts:1470

Methods

getData

getData(): UIRawMessage
Returns UIRawMessage
Remarks
Returns the current UIRawMessage value held by this observable.

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Privilege
early-execution-allowed - This function can be called in early-execution mode.
- Defined in tmp/package/index.d.ts:1481

setData

setData(data: UIRawMessage): void
Parameters
- data: UIRawMessage
  The new UIRawMessage value to set.
Returns void
Remarks
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.

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Privilege
early-execution-allowed - This function can be called in early-execution mode.
- Defined in tmp/package/index.d.ts:1495

subscribe(callback: (arg0: UIRawMessage) => void): (arg0: UIRawMessage) => void
Parameters
- callback: (arg0: UIRawMessage) => void
  A function that receives the new UIRawMessage value each time the observable changes.
Returns (arg0: UIRawMessage) => void
Remarks
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.

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Privilege
early-execution-allowed - This function can be called in early-execution mode.
- Defined in tmp/package/index.d.ts:1510

unsubscribe

unsubscribe(callback: (arg0: UIRawMessage) => void): boolean
Parameters
- callback: (arg0: UIRawMessage) => void
  The callback handle previously returned by subscribe.
Returns boolean
Remarks
Removes a previously registered listener from this observable. Returns true if the listener was found and removed, false if it was not found.

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Privilege
early-execution-allowed - This function can be called in early-execution mode.
- Defined in tmp/package/index.d.ts:1524