Class DonationAlertsUsersApi

Donation Alerts Users API.

Remarks

Provides methods to interact with Donation Alerts users, including retrieving user profiles and socket connection tokens.

Hierarchy

  • BaseApi
    • DonationAlertsUsersApi

Methods

getSocketConnectionToken getUser

Methods

getSocketConnectionToken

  • getSocketConnectionToken(
        user: UserIdResolvable,
        rateLimiterOptions?: RateLimiterRequestOptions,
    ): Promise<string>

    Fetches a Centrifugo connection token required for establishing real-time socket connections for the specified user.

    Parameters

    • user: UserIdResolvable

      The ID of the user for whom the token is being fetched.

    • OptionalrateLimiterOptions: RateLimiterRequestOptions

      Optional rate limiter configuration to control API requests.

    Returns Promise<string>

    A string containing the user's socket connection token.

    Remarks

    This method internally uses getUser method to fetch the profile of the user, then extracts the socketConnectionToken property.

    Throws

    HttpError if the response status code falls outside the 200–299 range.

    Throws

    UnregisteredUserError if the specified user is not registered in the authentication provider.

    Throws

    MissingScopeError if the provided access token is missing the required oauth-user-show scope.

    Example

    const token = await apiClient.users.getSocketConnectionToken(authenticatedUserId);
    console.log(`Socket connection token: ${token}`);

getUser

  • getUser(
        user: UserIdResolvable,
        rateLimiterOptions?: RateLimiterRequestOptions,
    ): Promise<DonationAlertsUser>

    Fetches the authenticated user's information based on the provided user ID.

    Parameters

    • user: UserIdResolvable

      The ID of the user whose profile needs to be fetched.

    • OptionalrateLimiterOptions: RateLimiterRequestOptions

      Optional rate limiter configuration to control API requests.

    Returns Promise<DonationAlertsUser>

    A DonationAlertsUser instance containing the user's profile information.

    Remarks

    Requires oauth-user-show scope.

    Throws

    HttpError if the response status code falls outside the 200–299 range.

    Throws

    UnregisteredUserError if the specified user is not registered in the authentication provider.

    Throws

    MissingScopeError if the provided access token is missing the required oauth-user-show scope.

    Example

    const user = await apiClient.users.getUser(userId);
    console.log(`User ID: ${user.id}, Name: ${user.name}`);

Settings

Member Visibility

On This Page

Methods