Class Realtime

Constructors

constructor

Methods

addConnectListener addHandshakeListener disconnect isDisconnected removeListener resubscribe subscribe unsubscribe

Constructors

constructor

  • new Realtime(client, url?, handshakeCallback?): Realtime

  • Allows to set up a realtime (websocket or long-polling) connection to the platform.

    Parameters

    • client: IFetchClient

      The fetch client instance to use

    • url: string = '/notification/realtime'

      The URL to connect to

    • OptionalhandshakeCallback: ((msg: HandshakeMessage) => void)

      A function which is called on succeeded or failed handshake

        • (msg): void

        • Parameters

          • msg: HandshakeMessage

          Returns void

    Returns Realtime

Methods

addConnectListener

  • addConnectListener(callback): SubscriptionHandle

  • Allows to listen to Cometd connection to e.g. detect when connection was lost.

    Parameters

    • callback: ((msg: Message) => void)
        • (msg): void

        • Parameters

          • msg: Message

          Returns void

    Returns SubscriptionHandle

addHandshakeListener

  • addHandshakeListener(callback): SubscriptionHandle

  • Allows to listen to Cometd handshake to find out if e.g. the connection was reestablished.

    Parameters

    • callback: ((msg: HandshakeMessage) => void)
        • (msg): void

        • Parameters

          • msg: HandshakeMessage

          Returns void

    Returns SubscriptionHandle

disconnect

isDisconnected

removeListener

  • removeListener(subscriptionHandle): void

  • Removes the subscription obtained with a call to addHandshakeListener or addConnectListener.

    Parameters

    • subscriptionHandle: SubscriptionHandle

    Returns void

resubscribe

  • resubscribe(subscriptionHandle): SubscriptionHandle

  • Resubscribes as necessary in case of a re-handshake.

    Parameters

    • subscriptionHandle: SubscriptionHandle

    Returns SubscriptionHandle

subscribe

  • subscribe(channel, callback): SubscriptionHandle

  • Subscribes to a realtime channel to listen for data.

    Parameters

    • channel: string

      The channel to connect to

    • callback: Callback

      A function to call when data is received

    Returns SubscriptionHandle

unsubscribe

  • unsubscribe(subscription): void

  • Cancels the listening to a channel.

    Parameters

    • subscription: SubscriptionHandle

      The subscription object returned by subscribe()

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods