Class DonationAlertsCentrifugoApi

Donation Alerts Centrifugo API.

Provides methods to manage user subscriptions to Centrifugo private channels. These channels allow receiving real-time updates about specific events such as donations, goals, and polls.

Hierarchy

BaseApi
- DonationAlertsCentrifugoApi

Index

Methods

subscribeUserToDonationAlertEvents subscribeUserToGoalUpdateEvents subscribeUserToPollUpdateEvents subscribeUserToPrivateChannels

Methods

subscribeUserToDonationAlertEvents

subscribeUserToDonationAlertEvents(
    user: UserIdResolvable,
    clientId: string,
    options?: DonationAlertsCentrifugoSubscribeOptions,
    rateLimiterOptions?: RateLimiterRequestOptions,
): Promise<DonationAlertsCentrifugoChannel>
Subscribes a user to donation alert events.

Donation alert events notify when a new donation is made. This requires the user to be subscribed to the $alerts:donation private channel.
Parameters
- user: UserIdResolvable
  The Donation Alerts user ID.
- clientId: string
  The Client ID obtained beforehand.
- Optionaloptions: DonationAlertsCentrifugoSubscribeOptions
  Additional options for subscription, such as formatting channel names.
- OptionalrateLimiterOptions: RateLimiterRequestOptions
  Options for rate limiting during the subscription.
Returns Promise<DonationAlertsCentrifugoChannel>
A promise resolving with the DonationAlertsCentrifugoChannel object.
Remarks
Requires oauth-donation-subscribe scope.

See the official documentation for more details: https://www.donationalerts.com/apidoc#introduction__centrifugo

Alternatively, the @donation-alerts/events library can simplify the process of subscribing and listening to events.

Throws
HttpError If the HTTP status code is outside the range of 200–299.

Throws
UnregisteredUserError If the user provided is not registered in the auth provider.
Example
```
const channel = await apiClient.centrifugo.subscribeUserToDonationAlertEvents(userId, clientId);
console.log(`Subscribed to channel: ${channel.channel}; token: ${channel.token}`);
```
- Defined in api/src/api/centrifugo/donation-alerts-centrifugo-api.ts:118

subscribeUserToGoalUpdateEvents

subscribeUserToGoalUpdateEvents(
    user: UserIdResolvable,
    clientId: string,
    options?: DonationAlertsCentrifugoSubscribeOptions,
    rateLimiterOptions?: RateLimiterRequestOptions,
): Promise<DonationAlertsCentrifugoChannel>
Subscribes a user to goal update events.

Goal update events provide information about the progress and completion of goals. This requires the user to be subscribed to the $goals:goal private channel.
Parameters
- user: UserIdResolvable
  The Donation Alerts user ID.
- clientId: string
  The Client ID obtained beforehand.
- Optionaloptions: DonationAlertsCentrifugoSubscribeOptions
  Additional options for subscription, such as formatting channel names.
- OptionalrateLimiterOptions: RateLimiterRequestOptions
  Options for rate limiting during the subscription.
Returns Promise<DonationAlertsCentrifugoChannel>
A promise resolving with the successfully subscribed channel object.
Remarks
Requires oauth-goal-subscribe scope.

See the official documentation for more details: https://www.donationalerts.com/apidoc#introduction__centrifugo

Alternatively, the @donation-alerts/events library can simplify the process of subscribing and listening to events.

Throws
HttpError If the HTTP status code is outside the range of 200–299.

Throws
UnregisteredUserError If the user provided is not registered in the auth.
Example
```
const channel = await apiClient.centrifugo.subscribeUserToGoalUpdateEvents(userId, clientId);
console.log(`Subscribed to channel: ${channel.channel}; token: ${channel.token}`);
```
- Defined in api/src/api/centrifugo/donation-alerts-centrifugo-api.ts:165

subscribeUserToPollUpdateEvents

subscribeUserToPollUpdateEvents(
    user: UserIdResolvable,
    clientId: string,
    options?: DonationAlertsCentrifugoSubscribeOptions,
    rateLimiterOptions?: RateLimiterRequestOptions,
): Promise<DonationAlertsCentrifugoChannel>
Subscribes a user to poll update events.

Poll update events notify about ongoing poll progress or results. This requires the user to be subscribed to the $polls:poll private channel.
Parameters
- user: UserIdResolvable
  The Donation Alerts user ID.
- clientId: string
  The Client ID obtained beforehand.
- Optionaloptions: DonationAlertsCentrifugoSubscribeOptions
  Additional options for subscription, such as formatting channel names.
- OptionalrateLimiterOptions: RateLimiterRequestOptions
  Options for rate limiting during the subscription.
Returns Promise<DonationAlertsCentrifugoChannel>
A promise resolving with the successfully subscribed channel object.
Remarks
Requires oauth-poll-subscribe scope.

See the official documentation for more details: https://www.donationalerts.com/apidoc#introduction__centrifugo

Alternatively, the @donation-alerts/events library can simplify the process of subscribing and listening to events.

Throws
HttpError If the HTTP status code is outside the range of 200–299.

Throws
UnregisteredUserError If the user provided is not registered in the auth provider.
Example
```
const channel = await apiClient.centrifugo.subscribeUserToPollUpdateEvents(userId, clientId);
console.log(`Subscribed to channel: ${channel.channel}; token: ${channel.token}`);
```
- Defined in api/src/api/centrifugo/donation-alerts-centrifugo-api.ts:212

subscribeUserToPrivateChannels

subscribeUserToPrivateChannels(
    user: UserIdResolvable,
    clientId: string,
    channels: string[],
    options?: DonationAlertsCentrifugoSubscribeOptions,
    rateLimiterOptions?: RateLimiterRequestOptions,
): Promise<DonationAlertsCentrifugoChannel[]>
Subscribes a user to the specified Centrifugo private channels.
Parameters
- user: UserIdResolvable
  The Donation Alerts user ID.
- clientId: string
  The Client ID obtained beforehand.
- channels: string[]
  List of private channel names to subscribe the user to. Channel names should not include the user ID – the library will format them automatically if needed.
- Optionaloptions: DonationAlertsCentrifugoSubscribeOptions
  Additional options for subscription, such as formatting channel names.
- OptionalrateLimiterOptions: RateLimiterRequestOptions
  Options for controlling the request rate using a rate limiter.
Returns Promise<DonationAlertsCentrifugoChannel[]>
A promise resolving with a list of DonationAlertsCentrifugoChannel.
Remarks
To subscribe a user, you must first obtain the Client ID (UUIDv4) via WebSockets.

The full subscription flow is described in the official documentation: https://www.donationalerts.com/apidoc#introduction__centrifugo

Alternatively, the @donation-alerts/events library can simplify the process of subscribing and listening to events.

Throws
HttpError If the HTTP status code is outside the range of 200–299.

Throws
UnregisteredUserError If the user provided is not registered in the auth provider.
Example
```
const subscribedChannels = await apiClient.centrifugo.subscribeUserToPrivateChannels(userId, clientId, [
  '$alerts:donation',
  '$goals:goal'
]);
subscribedChannels.forEach(channel =>
  console.log(`Subscribed to ${channel.channel}; token: ${channel.token}`)
);
```
- Defined in api/src/api/centrifugo/donation-alerts-centrifugo-api.ts:71

Class DonationAlertsCentrifugoApi

Hierarchy

Index

Methods

Methods

subscribeUserToDonationAlertEvents

Parameters

Returns Promise<DonationAlertsCentrifugoChannel>

Remarks

Throws

Throws

Example

subscribeUserToGoalUpdateEvents

Parameters

Returns Promise<DonationAlertsCentrifugoChannel>

Remarks

Throws

Throws

Example

subscribeUserToPollUpdateEvents

Parameters

Returns Promise<DonationAlertsCentrifugoChannel>

Remarks

Throws

Throws

Example

subscribeUserToPrivateChannels

Parameters

Returns Promise<DonationAlertsCentrifugoChannel[]>

Remarks

Throws

Throws

Example

Settings

On This Page