Class OAuthHelper

A helper to make using authenticated oauth requests without needing a new client instance.

Hierarchy

  • OAuthHelper

Constructors

constructor

Properties

#private

Methods

getApplication getCurrentAuthorizationInformation getCurrentConnections getCurrentGuildMember getCurrentGuilds getCurrentUser revokeToken updateRoleConnection constructURL

Constructors

constructor

  • Parameters

    Returns OAuthHelper

Properties

Private #private

#private: any

Methods

getApplication

  • Get the current OAuth2 application's information.

    Returns Promise<Application>

getCurrentAuthorizationInformation

  • Get information about the current authorization.

    Returns Promise<AuthorizationInformation>

getCurrentConnections

  • Get the connections of the currently authenticated user.

    Note: Requires the connections scope.

    Returns Promise<Connection[]>

getCurrentGuildMember

  • Get the guild member information about the currently authenticated user.

    Note: Requires the guilds.members.read scope.

    Parameters

    • guild: string

      the ID of the guild

    Returns Promise<Member>

getCurrentGuilds

  • Get the currently authenticated user's guilds. Note these are missing several properties gateway guilds have.

    Returns Promise<OAuthGuild[]>

getCurrentUser

  • Get the currently authenticated user's information.

    Note: This does not touch the client's cache in any way.

    Returns Promise<ExtendedUser>

revokeToken

  • Revoke the used access token.

    Parameters

    Returns Promise<void>

updateRoleConnection

  • Update the authenticated user's role connection object for an application. This requires the role_connections.write scope.

    Parameters

    Returns Promise<RoleConnection>

Static constructURL

  • Construct an oauth authorization url.

    Parameters

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc