Class UserEventsClient

constructor

• new UserEventsClient(config): UserEventsClient

• Creates Donation Alerts Events client that allows listen to the various events.

  Parameters

  • config: UserEventsClientConfig

    Configuration for single user EventsClient.

  Returns UserEventsClient

Readonly onConnect

Readonly onDisconnect

clientId

• get clientId(): null | string

• Centrifugo current connection client ID.

  Returns null if no connection is established.

  Returns null | string

isConnected

• get isConnected(): boolean

• Checks whether the client is currently connected to the server.

  Returns boolean

userId

• get userId(): number

• The ID of the user the events client belongs to.

  Returns number

connect

• connect(restoreExistingListeners?): Promise<void>

• Connects to the Donation Alerts Centrifugo WebSocket server and subscribes to the topics.

  Parameters

  • restoreExistingListeners: boolean = true

    Whether to restore previously registered listeners on connect. Default is true.

  Returns Promise<void>

disconnect

• disconnect(removeListeners?): Promise<void>

• Disconnects from the Donation Alerts Centrifugo WebSocket server.

  Parameters

  • removeListeners: boolean = false

    Whether to remove all active listeners on disconnect. If you don't remove them, the client will try to restore them on the next connection. Default is false.

  Returns Promise<void>

onDonation

• onDonation(callback): Promise<EventsListener>

• Subscribes to Donation Alerts donation events.

  Parameters

  • callback: ((event) => void)

    A function to be called when a donation event is sent to the user.

    • • (event): void

      • Parameters

        • event: DonationAlertsDonationEvent

        Returns void

  Returns Promise<EventsListener>

onGoalUpdate

• onGoalUpdate(callback): Promise<EventsListener>

• Subscribes to Donation Alerts goal update events.

  Parameters

  • callback: ((event) => void)

    A function to be called when a goal update event is sent to the user.

    • • (event): void

      • Parameters

        • event: DonationAlertsGoalUpdateEvent

        Returns void

  Returns Promise<EventsListener>

onPollUpdate

• onPollUpdate(callback): Promise<EventsListener>

• Subscribes to Donation Alerts poll update events.

  Parameters

  • callback: ((event) => void)

    A function to be called when a poll update event is sent to the user.

    • • (event): void

      • Parameters

        • event: DonationAlertsPollUpdateEvent

        Returns void

  Returns Promise<EventsListener>

reconnect

• reconnect(removeListeners?): Promise<void>

• Reconnects to the Donation Alerts Centrifugo WebSocket server.

  Parameters

  • removeListeners: boolean = false

    Whether to remove all listeners on reconnect. If the listeners won't be removed, the client will restore all listeners on reconnect. Defaults to false.

  Returns Promise<void>

removeEventsListener

• removeEventsListener(listener): Promise<void>

• Unsubscribes from a channel and removes its listener.

  Parameters

  • listener: EventsListener

    The listener to remove.

  Returns Promise<void>