Class REST/OAuth

Various methods for interacting with oauth. Located at Client#rest .oauth.

Index

Constructors

Methods

clientCredentialsGrant exchangeCode getApplication getCurrentAuthorizationInformation getCurrentConnections getCurrentGuildMember getCurrentGuilds getCurrentUser getHelper getRoleConnectionsMetadata getUserRoleConnection refreshToken revokeToken updateRoleConnectionsMetadata updateUserRoleConnection

Constructors

constructor

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

Methods

clientCredentialsGrant

clientCredentialsGrant(options): 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>
Caching
This method does not cache its result.
- Defined in lib/routes/OAuth.ts:48

exchangeCode

exchangeCode(options): Promise<ExchangeCodeResponse>
Exchange a code for an access token.
Parameters
- options: ExchangeCodeOptions
  The options for exchanging the code.
Returns Promise<ExchangeCodeResponse>
Caching
This method does not cache its result.
- Defined in lib/routes/OAuth.ts:71

getApplication

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

Returns Promise<OAuthApplication>
Caching
This method does not cache its result.
- Defined in lib/routes/OAuth.ts:96

getCurrentAuthorizationInformation

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

Note: OAuth only. Bots cannot use this.

Returns Promise<AuthorizationInformation>
Caching
This method does cache part of its result.

Caches
Client#users
- Defined in lib/routes/OAuth.ts:110

getCurrentConnections

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

Note: Requires the connections scope when using oauth.

Returns Promise<Connection[]>
Caching
This method does not cache its result.
- Defined in lib/routes/OAuth.ts:128

getCurrentGuildMember

getCurrentGuildMember(guild): 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>
Caching
This method does not cache its result.
- Defined in lib/routes/OAuth.ts:153

getCurrentGuilds

getCurrentGuilds(options?): 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[]>
Caching
This method does not cache its result.
- Defined in lib/routes/OAuth.ts:165

getCurrentUser

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

Returns Promise<ExtendedUser>
Caching
This method does not cache its result.
- Defined in lib/routes/OAuth.ts:190

getHelper

getHelper(token): 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): Promise<RoleConnectionMetadata[]>
Get an application's role connection metadata records.
Parameters
- applicationID: string
  The ID of the application.
Returns Promise<RoleConnectionMetadata[]>
Caching
This method does not cache its result.
- Defined in lib/routes/OAuth.ts:207

getUserRoleConnection

getUserRoleConnection(applicationID): 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>
Caching
This method does not cache its result.
- Defined in lib/routes/OAuth.ts:226

refreshToken

refreshToken(options): Promise<RefreshTokenResponse>
Refresh an existing access token.
Parameters
- options: RefreshTokenOptions
  The options for refreshing the token.
Returns Promise<RefreshTokenResponse>
Caching
This method does not cache its result.
- Defined in lib/routes/OAuth.ts:250

revokeToken

revokeToken(options): Promise<void>
Revoke an access token.
Parameters
- options: RevokeTokenOptions
  The options for revoking the token.
Returns Promise<void>
Caching
This method does not cache its result.
- Defined in lib/routes/OAuth.ts:275

updateRoleConnectionsMetadata

updateRoleConnectionsMetadata(applicationID, metadata): Promise<RoleConnectionMetadata[]>
Update an application's role connections metadata.
Parameters
- applicationID: string
  The ID of the application.
- metadata: RoleConnectionMetadata[]
  The metadata records.
Returns Promise<RoleConnectionMetadata[]>
Caching
This method does not cache its result.
- Defined in lib/routes/OAuth.ts:293

updateUserRoleConnection

updateUserRoleConnection(applicationID, data): 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>
Caching
This method does not cache its result.
- Defined in lib/routes/OAuth.ts:321

Class REST/OAuth

Index

Constructors

Methods

Constructors

constructor

Parameters

manager: RESTManager

Returns REST/OAuth

Methods

clientCredentialsGrant

Parameters

options: ClientCredentialsTokenOptions

Returns Promise<ClientCredentialsTokenResponse>

Caching

exchangeCode

Parameters

options: ExchangeCodeOptions

Returns Promise<ExchangeCodeResponse>

Caching

getApplication

Returns Promise<OAuthApplication>

Caching

getCurrentAuthorizationInformation

Returns Promise<AuthorizationInformation>

Caching

Caches

getCurrentConnections

Returns Promise<Connection[]>

Caching

getCurrentGuildMember

Parameters

guild: string

Returns Promise<Member>

Caching

getCurrentGuilds

Parameters

Optional options: GetCurrentGuildsOptions

Returns Promise<OAuthGuild[]>

Caching

getCurrentUser

Returns Promise<ExtendedUser>

Caching

getHelper

Parameters

token: string

Returns OAuthHelper

getRoleConnectionsMetadata

Parameters

applicationID: string

Returns Promise<RoleConnectionMetadata[]>

Caching

getUserRoleConnection

Parameters

applicationID: string

Returns Promise<RoleConnection>

Caching

refreshToken

Parameters

options: RefreshTokenOptions

Returns Promise<RefreshTokenResponse>

Caching

revokeToken

Parameters

options: RevokeTokenOptions

Returns Promise<void>

Caching

updateRoleConnectionsMetadata

Parameters

applicationID: string

metadata: RoleConnectionMetadata[]

Returns Promise<RoleConnectionMetadata[]>

Caching

updateUserRoleConnection

Parameters

applicationID: string

data: UpdateUserApplicationRoleConnectionOptions

Returns Promise<RoleConnection>

Caching

Settings

`Optional` options: GetCurrentGuildsOptions