Class OAuthHelper

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

Index

Constructors

Methods

addGuildMember deleteRoleConnection getApplication getCurrentAuthorizationInformation getCurrentConnections getCurrentGuildMember getCurrentGuilds getCurrentUser getEntitlements getOIDCUserInfo revokeToken updateRoleConnection constructURL

Constructors

constructor

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

Methods

addGuildMember

addGuildMember(guildID, userID, options?): Promise<undefined | Member>
Parameters
- guildID: string
- userID: string
- Optional options: Omit<AddMemberOptions, "accessToken">
Returns Promise<undefined | Member>
- Defined in lib/rest/OAuthHelper.ts:58

deleteRoleConnection

deleteRoleConnection(applicationID): Promise<void>
Delete 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<void>
Caching
This method does not cache its result.
- Defined in lib/rest/OAuthHelper.ts:67

getApplication

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

Returns Promise<OAuthApplication>
- Defined in lib/rest/OAuthHelper.ts:78

getCurrentAuthorizationInformation

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

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

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

getCurrentGuildMember

getCurrentGuildMember(guild): 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:132

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

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/rest/OAuthHelper.ts:156

getEntitlements

getEntitlements(applicationID): Promise<(Entitlement | TestEntitlement)[]>
Get the currently authenticated user's entitlements for an application.
Parameters
- applicationID: string
Returns Promise<(Entitlement | TestEntitlement)[]>
Caching
This method does not cache its result. If an entitlement's application id is the client's application id.

Caches
ClientApplication#entitlements
- Defined in lib/rest/OAuthHelper.ts:169

getOIDCUserInfo

getOIDCUserInfo(): Promise<OIDCUserInfo>
Get the OIDC userinfo.

Note: requires the openid scope.

Returns Promise<OIDCUserInfo>
- Defined in lib/rest/OAuthHelper.ts:182

revokeToken

revokeToken(options): 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:203

updateRoleConnection

updateRoleConnection(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>
- Defined in lib/rest/OAuthHelper.ts:220

`Static` constructURL

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