Class OAuthHelper

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

Hierarchy

OAuthHelper

Index

Constructors

Methods

getApplication getCurrentAuthorizationInformation getCurrentConnections getCurrentGuildMember getCurrentGuilds revokeToken

Constructors

constructor

new OAuthHelper(manager: RESTManager, token: string): OAuthHelper
Parameters
- manager: RESTManager
- token: string
Returns OAuthHelper
- Defined in lib/rest/OAuthHelper.ts:24

Methods

getApplication

getApplication(): Promise<Application>
Get the current OAuth2 application's information.

Returns Promise<Application>
- Defined in lib/rest/OAuthHelper.ts:32

getCurrentAuthorizationInformation

getCurrentAuthorizationInformation(): Promise<AuthorizationInformation>
Get information about the current authorization.

Returns Promise<AuthorizationInformation>
- Defined in lib/rest/OAuthHelper.ts:43

getCurrentConnections

getCurrentConnections(): Promise<Connection[]>
Get the connections of the currently authenticated user.

Note: Requires the connections scope.

Returns Promise<Connection[]>
- Defined in lib/rest/OAuthHelper.ts:61

getCurrentGuildMember

getCurrentGuildMember(guild: string): Promise<Member>
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>
- Defined in lib/rest/OAuthHelper.ts:86

getCurrentGuilds

getCurrentGuilds(): Promise<OAuthGuild[]>
Get the currently authenticated user's guilds. Note these are missing several properties gateway guilds have.

Returns Promise<OAuthGuild[]>
- Defined in lib/rest/OAuthHelper.ts:97

revokeToken

revokeToken(options: Omit<RevokeTokenOptions, "token">): Promise<void>
Revoke the used access token.
Parameters
- options: Omit<RevokeTokenOptions, "token">
  
  The options for revoking the token.
Returns Promise<void>
- Defined in lib/rest/OAuthHelper.ts:110