Subscribes a user to the donation alert events.
You must obtain the UUIDv4 Client ID via WebSockets to subscribe to Centrifugo private channels.
See the complete subscription flow in the official documentation: https://www.donationalerts.com/apidoc#introduction__centrifugo
Also, consider using the @donation-alerts/events library which makes it very easy to subscribe and listen
to events.
The Donation Alerts user ID.
The previously obtained Client ID.
Optional options: DonationAlertsCentrifugoSubscribeOptionsAdditional subscribe options.
Optional rateLimiterOptions: RateLimiterRequestOptionsThe rate limiter options.
HttpError if response status code is out of 200-299 range.
UnregisteredUserError if the user you are trying to get is not registered in authentication provider.
Subscribes a user to the goal update events.
You must obtain the UUIDv4 Client ID via WebSockets to subscribe to Centrifugo private channels.
See the complete subscription flow in the official documentation: https://www.donationalerts.com/apidoc#introduction__centrifugo
Also, consider using the "@donation-alerts/events" library which makes it very easy to subscribe and listen to events.
The Donation Alerts user ID.
The previously obtained Client ID.
Optional options: DonationAlertsCentrifugoSubscribeOptionsAdditional subscribe options.
Optional rateLimiterOptions: RateLimiterRequestOptionsThe rate limiter options.
HttpError if response status code is out of 200-299 range.
UnregisteredUserError if the user you are trying to get is not registered in authentication provider.
Subscribes a user to the poll update events.
You must obtain the UUIDv4 Client ID via WebSockets to subscribe to Centrifugo private channels.
See the complete subscription flow in the official documentation: https://www.donationalerts.com/apidoc#introduction__centrifugo
Also, consider using the "@donation-alerts/events" library which makes it very easy to subscribe and listen to events.
The Donation Alerts user ID.
The previously obtained Client ID.
Optional options: DonationAlertsCentrifugoSubscribeOptionsAdditional subscribe options.
Optional rateLimiterOptions: RateLimiterRequestOptionsThe rate limiter options.
HttpError if response status code is out of 200-299 range.
UnregisteredUserError if the user you are trying to get is not registered in authentication provider.
Subscribes a user to the given Centrifugo private channels.
You must obtain the UUIDv4 Client ID via WebSockets to subscribe user to Centrifugo private channels.
See the complete subscription flow in the official documentation: https://www.donationalerts.com/apidoc#introduction__centrifugo
Also, consider using the "@donation-alerts/events" library which makes it very easy to subscribe and listen to events.
The Donation Alerts user ID.
The previously obtained Client ID.
The private channel names the user should be subscribed to. The channel names must not contain the user IDs. The library will properly format channel names itself.
Optional options: DonationAlertsCentrifugoSubscribeOptionsAdditional subscribe options.
Optional rateLimiterOptions: RateLimiterRequestOptionsThe rate limiter options.
HttpError if response status code is out of 200-299 range.
UnregisteredUserError if the user you are trying to get is not registered in authentication provider.
Generated using TypeDoc
Donation Alerts Centrifugo API.
Allows to subscribe a user to the Centrifugo private channels.