Class OAuth

Various methods for interacting with oauth.

Hierarchy

OAuth

Index

Constructors

Accessors

Methods

clientCredentialsGrant exchangeCode getApplication getCurrentAuthorizationInformation getCurrentConnections getCurrentGuildMember getCurrentGuilds getHelper refreshToken revokeToken constructURL

Constructors

constructor

new OAuth(manager: RESTManager): OAuth
Parameters
- manager: RESTManager
Returns OAuth
- Defined in lib/routes/OAuth.ts:37

Accessors

constructURL

get constructURL(): ((options: OAuthURLOptions) => string)
Returns ((options: OAuthURLOptions) => string)
- - (options: OAuthURLOptions): string
  - Construct an oauth authorization url.
    Parameters
    - options: OAuthURLOptions
      
      The options to construct the url with.
    Returns string
- Defined in lib/routes/OAuth.ts:72

Methods

clientCredentialsGrant

clientCredentialsGrant(options: ClientCredentialsTokenOptions): Promise<ClientCredentialsTokenResponse>
Get an access token for the application owner. If the application is owned by a team, this is restricted to identify & applications.commands.update.
Parameters
- options: ClientCredentialsTokenOptions
  
  The options to for the client credentials grant.
Returns Promise<ClientCredentialsTokenResponse>
- Defined in lib/routes/OAuth.ts:80

exchangeCode

exchangeCode(options: ExchangeCodeOptions): Promise<ExchangeCodeResponse>
Exchange a code for an access token.
Parameters
- options: ExchangeCodeOptions
  
  The options for exchanging the code.
Returns Promise<ExchangeCodeResponse>
- Defined in lib/routes/OAuth.ts:102

getApplication

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

Returns Promise<Application>
- Defined in lib/routes/OAuth.ts:126

getCurrentAuthorizationInformation

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

Note: OAuth only. Bots cannot use this.

Returns Promise<AuthorizationInformation>
- Defined in lib/routes/OAuth.ts:138

getCurrentConnections

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

Note: Requires the connections scope when using oauth.

Returns Promise<Connection[]>
- Defined in lib/routes/OAuth.ts:155

getCurrentGuildMember

getCurrentGuildMember(guild: string): Promise<Member>
Get the guild member information about the currently authenticated user.

Note: OAuth only. Requires the guilds.members.read scope. Bots cannot use this.
Parameters
- guild: string
  
  the ID of the guild
Returns Promise<Member>
- Defined in lib/routes/OAuth.ts:179

getCurrentGuilds

getCurrentGuilds(options?: GetCurrentGuildsOptions): Promise<OAuthGuild[]>
Get the currently authenticated user's guilds. Note these are missing several properties gateway guilds have.
Parameters
- Optional options: GetCurrentGuildsOptions
  
  The options for getting the current user's guilds.
Returns Promise<OAuthGuild[]>
- Defined in lib/routes/OAuth.ts:190

getHelper

getHelper(token: string): OAuthHelper
Get a helper instance that can be used with a specific bearer token.
Parameters
- token: string
Returns OAuthHelper
- Defined in lib/routes/OAuth.ts:212

refreshToken

refreshToken(options: RefreshTokenOptions): Promise<RefreshTokenResponse>
Refresh an existing access token.
Parameters
- options: RefreshTokenOptions
  
  The options for refreshing the token.
Returns Promise<RefreshTokenResponse>
- Defined in lib/routes/OAuth.ts:220

revokeToken

revokeToken(options: RevokeTokenOptions): Promise<void>
Revoke an access token.
Parameters
- options: RevokeTokenOptions
  
  The options for revoking the token.
Returns Promise<void>
- Defined in lib/routes/OAuth.ts:244

`Static` constructURL

constructURL(options: OAuthURLOptions): string
Construct an oauth authorization url.
Parameters
- options: OAuthURLOptions
  
  The options to construct the url with.
Returns string
- Defined in lib/routes/OAuth.ts:45