Class EventsClient

constructor

• new EventsClient(config): EventsClient

• Creates the Donation Alerts events client that allows listen to various events, such as new donations, goal updates, and poll updates.

  Parameters

  • config: EventsClientConfig

  Returns EventsClient

Readonly onConnect

Readonly onDisconnect

addUser

• addUser(user): UserEventsClient

• Registers a user in the client.

  Parameters

  • user: UserIdResolvable

    The ID of the user to register.

  Returns UserEventsClient

getUserClient

• getUserClient(user): UserEventsClient

• Returns a UserEventsClient by user ID.

  Parameters

  • user: UserIdResolvable

    The user to get the UserEventsClient instance of.

  Returns UserEventsClient

hasUser

• hasUser(user): boolean

• Checks whether a user was added to the client.

  Parameters

  • user: UserIdResolvable

  Returns boolean

onDonation

• onDonation(user, callback): Promise<EventsListener>

• Creates a listener for user for donation events.

  Parameters

  • user: UserIdResolvable

    The ID of the user to listen donation events to.

  • callback: ((event) => void)

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

    • • (event): void

      • Parameters

        • event: DonationAlertsDonationEvent

        Returns void

  Returns Promise<EventsListener>

onGoalUpdate

• onGoalUpdate(user, callback): Promise<EventsListener>

• Creates a listener for user for goal update events.

  Parameters

  • user: UserIdResolvable

    The ID of the user to listen goal update events to.

  • callback: ((event) => void)

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

    • • (event): void

      • Parameters

        • event: DonationAlertsGoalUpdateEvent

        Returns void

  Returns Promise<EventsListener>

onPollUpdate

• onPollUpdate(user, callback): Promise<EventsListener>

• Creates a listener for user for poll update events.

  Parameters

  • user: UserIdResolvable

    The ID of the user to listen poll update events to.

  • callback: ((event) => void)

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

    • • (event): void

      • Parameters

        • event: DonationAlertsPollUpdateEvent

        Returns void

  Returns Promise<EventsListener>

removeUser

• removeUser(user): Promise<void>

• Removes a user and the listeners from the client.

  If the user client doesn't have active channels, the connection will be closed.

  Parameters

  • user: UserIdResolvable

    The ID of the user to remove.

  Returns Promise<void>