Event Types

• BotAction

  Defines a union type for all the possible common events.

  A BotAction can be one of the following values:

  • BotActions
  • TransactionAction
  • ExtraActions
  • AsyncActions
  • RemoteAction
  • RemoteActionResult
  • RemoteActionError
  • DeviceAction

• RejectAction

  Defines an event that prevents the execution of an action.

  Members

  • actions Action[]

    The actions to prevent.

  • type "reject"

• RemoteAction

  An event that is used to send events from this device to a remote device.

  Members

  • allowBatching? boolean

    Whether this action is allowed to be batched with other remote actions. Batching will preserve ordering between remote actions but may break ordering with respect to bot actions. Defaults to true.

  • broadcast? boolean

    Whether the event should be broadcast to all users.

  • connectionId? string

    The ID of the connection that the event should be sent to.

  • event Action

    The event that should be sent to the device.

  • sessionId? string

    The ID of the session that the event should be sent to.

  • taskId? (string | number)

    The ID of the task.

  • type "remote"

  • uncopiable? boolean

    Whether the action can be structure cloned. If true, then the action should not be passed across message ports without special handling.

  • userId? string

    The ID of the user that the event should be sent to.

• SessionSelector

  An interface that is used to say which user/device/session an event should be sent to.

  Members

  • broadcast? boolean

  • connectionId? string

  • sessionId? string

  • userId? string