Class OAuth

Various methods for interacting with oauth.

Hierarchy

OAuth

Index

Constructors

constructor

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

Accessors

updateRoleConnectionsMetata

get updateRoleConnectionsMetata(): ((applicationID: string, metadata: RoleConnectionMetadata[]) => Promise<RoleConnectionMetadata[]>)
An alias for OAuth#updateRoleConnectionsMetadata. This will be removed in 1.6.0.

Returns ((applicationID: string, metadata: RoleConnectionMetadata[]) => Promise<RoleConnectionMetadata[]>)
- - (applicationID: string, metadata: RoleConnectionMetadata[]): Promise<RoleConnectionMetadata[]>
  - Update an application's role connections metadata.
    Parameters
    - applicationID: string
    - metadata: RoleConnectionMetadata[]
      
      The metadata records.
    Returns Promise<RoleConnectionMetadata[]>
- Defined in lib/routes/OAuth.ts:46

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:54

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:76

getApplication

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

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

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:112

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:129

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:153

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:164

getCurrentUser

getCurrentUser(): Promise<ExtendedUser>
Get the currently authenticated user's information.

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

Returns Promise<ExtendedUser>
- 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:198

getRoleConnectionsMetadata

getRoleConnectionsMetadata(applicationID: string): Promise<RoleConnectionMetadata[]>
Get an application's role connection metadata records.
Parameters
- applicationID: string
Returns Promise<RoleConnectionMetadata[]>
- Defined in lib/routes/OAuth.ts:206

getUserRoleConnection

getUserRoleConnection(applicationID: string): Promise<RoleConnection>
Get the authenticated user's role connection object for an application. This requires the role_connections.write scope.
Parameters
- applicationID: string
  
  The ID of the application.
Returns Promise<RoleConnection>
- Defined in lib/routes/OAuth.ts:224

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:247

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:271

updateRoleConnectionsMetadata

updateRoleConnectionsMetadata(applicationID: string, metadata: RoleConnectionMetadata[]): Promise<RoleConnectionMetadata[]>
Update an application's role connections metadata.
Parameters
- applicationID: string
- metadata: RoleConnectionMetadata[]
  
  The metadata records.
Returns Promise<RoleConnectionMetadata[]>
- Defined in lib/routes/OAuth.ts:288

updateUserRoleConnection

updateUserRoleConnection(applicationID: string, data: UpdateUserApplicationRoleConnectionOptions): Promise<RoleConnection>
Update the authenticated user's role connection object for an application. This requires the role_connections.write scope.
Parameters
- applicationID: string
  
  The ID of the application.
- data: UpdateUserApplicationRoleConnectionOptions
  
  The metadata to update.
Returns Promise<RoleConnection>
- Defined in lib/routes/OAuth.ts:315

Class OAuth

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

manager: RESTManager

Returns OAuth

Accessors

updateRoleConnectionsMetata

Returns ((applicationID: string, metadata: RoleConnectionMetadata[]) => Promise<RoleConnectionMetadata[]>)

Parameters

applicationID: string

metadata: RoleConnectionMetadata[]

Returns Promise<RoleConnectionMetadata[]>

Methods

clientCredentialsGrant

Parameters

options: ClientCredentialsTokenOptions

Returns Promise<ClientCredentialsTokenResponse>

exchangeCode

Parameters

options: ExchangeCodeOptions

Returns Promise<ExchangeCodeResponse>

getApplication

Returns Promise<Application>

getCurrentAuthorizationInformation

Returns Promise<AuthorizationInformation>

getCurrentConnections

Returns Promise<Connection[]>

getCurrentGuildMember

Parameters

guild: string

Returns Promise<Member>

getCurrentGuilds

Parameters

Optional options: GetCurrentGuildsOptions

Returns Promise<OAuthGuild[]>

getCurrentUser

Returns Promise<ExtendedUser>

getHelper

Parameters

token: string

Returns OAuthHelper

getRoleConnectionsMetadata

Parameters

applicationID: string

Returns Promise<RoleConnectionMetadata[]>

getUserRoleConnection

Parameters

applicationID: string

Returns Promise<RoleConnection>

refreshToken

Parameters

options: RefreshTokenOptions

Returns Promise<RefreshTokenResponse>

revokeToken

Parameters

options: RevokeTokenOptions

Returns Promise<void>

updateRoleConnectionsMetadata

Parameters

applicationID: string

metadata: RoleConnectionMetadata[]

Returns Promise<RoleConnectionMetadata[]>

updateUserRoleConnection

Parameters

applicationID: string

data: UpdateUserApplicationRoleConnectionOptions

Returns Promise<RoleConnection>

Settings

Member Visibility

Theme

`Optional` options: GetCurrentGuildsOptions