Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseBridgeEvent

Represents an event that occurs on the event bus bridge.

Please consult the documentation for a full explanation.

Hierarchy

  • any
    • BaseBridgeEvent

Index

Methods

Methods

complete

  • complete(arg0?: undefined | false | true): void

  • Parameters

    • Optional arg0: undefined | false | true

    Returns void

future

  • future(): PromiseLike<boolean>

  • Returns PromiseLike<boolean>

getRawMessage

  • getRawMessage(): {}

  • Get the raw JSON message for the event. This will be null for SOCKET_CREATED or SOCKET_CLOSED events as there is no message involved. If the returned message is modified, {@link BaseBridgeEvent#setRawMessage} should be called with the new message.

    Returns {}

    • [key: string]: any

setRawMessage

  • Override the raw JSON message for the event. It is ideally using it when publish back message from server to client in RECEIVE event

    Parameters

    • message: {}
      • [key: string]: any

    Returns BaseBridgeEvent

tryComplete

  • tryComplete(arg0?: undefined | false | true): boolean

  • Parameters

    • Optional arg0: undefined | false | true

    Returns boolean

type

  • Returns BridgeEventType

Generated using TypeDoc