Class OAuthApplication

Represents an oauth application.

Hierarchy

ClientApplication
- OAuthApplication

Constructors

constructor

new OAuthApplication(data: RESTOAuthApplication, client: Client<ClientEvents>): OAuthApplication
Parameters
- data: RESTOAuthApplication
- client: Client<ClientEvents>
Returns OAuthApplication
Overrides ClientApplication.constructor
- Defined in lib/structures/OAuthApplication.ts:57

Properties

botPublic

botPublic: boolean

When false, only the application's owners can invite the bot to guilds.

botRequireCodeGrant

botRequireCodeGrant: boolean

When true, the applications bot will only join upon the completion of the full oauth2 code grant flow.

client

client: Client<ClientEvents>

coverImage

coverImage: null | string

This application's rich presence invite cover image hash, if any.

`Optional` customInstallURL

customInstallURL?: string

This application's default custom authorization link, if any.

description

description: string

The description of the application.

flags

flags: number

This application's public flags.

guildID

guildID: null | string

If this application is a game sold on Discord, the ID of the guild to which it has been linked.

icon

icon: null | string

The icon hash of the application.

id

id: string

`Optional` installParams

installParams?: InstallParams

Settings for this application's in-app authorization link, if enabled.

name

name: string

The name of the application.

owner

owner: User

The owner of this application.

ownerID

ownerID: string

The ID of the owner of this application.

`Optional` primarySKUID

primarySKUID?: string

If this application is a game sold on Discord, the id of the Game's SKU.

`Optional` privacyPolicyURL

privacyPolicyURL?: string

A URL to this application's privacy policy.

`Optional` roleConnectionsVerificationURL

roleConnectionsVerificationURL?: string

This application's role connections verification url.

rpcOrigins

rpcOrigins: string[]

A list of rpc origin urls, if rpc is enabled.

`Optional` slug

slug?: string

If this application is a game sold on Discord, the slug that links to its store page.

`Optional` tags

tags?: string[]

The tags for this application.

team

team: null | Team

The team that owns this application, if any.

`Optional` termsOfServiceURL

termsOfServiceURL?: string

A URL to this application's terms of service.

type

type: null | number

The type of this application.

verifyKey

verifyKey: string

The bot's hex encoded public key.

Accessors

createdAt

get createdAt(): Date
Returns Date
Inherited from ClientApplication.createdAt
- Defined in lib/structures/Base.ts:31

guild

get guild(): null | Guild
If this application is a game sold on Discord, the guild to which it has been linked. This will throw an error if the guild is not cached.

Returns null | Guild
- Defined in lib/structures/OAuthApplication.ts:136

Methods

bulkEditGlobalCommands

bulkEditGlobalCommands(options: CreateApplicationCommandOptions[]): Promise<ApplicationCommand<ApplicationCommandTypes>[]>
Overwrite all existing global application commands.
Parameters
- options: CreateApplicationCommandOptions[]
  
  The commands.
Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>
Inherited from ClientApplication.bulkEditGlobalCommands
- Defined in lib/structures/ClientApplication.ts:40

bulkEditGuildCommands

bulkEditGuildCommands(guildID: string, options: CreateGuildApplicationCommandOptions[]): Promise<ApplicationCommand<ApplicationCommandTypes>[]>
Overwrite all existing application commands in a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- options: CreateGuildApplicationCommandOptions[]
  
  The commands.
Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>
Inherited from ClientApplication.bulkEditGuildCommands
- Defined in lib/structures/ClientApplication.ts:49

coverImageURL

coverImageURL(format?: "jpg" | "jpeg" | "png" | "webp" | "gif", size?: number): null | string
The url of this application's cover image.
Parameters
- Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"
  
  The format the url should be.
- Optional size: number
  
  The dimensions of the image.
Returns null | string
- Defined in lib/structures/OAuthApplication.ts:157

createGlobalCommand

createGlobalCommand<T>(options: T): Promise<ApplicationCommandOptionConversion<T>>
Create a global application command.
Type Parameters
- T extends CreateApplicationCommandOptions = CreateApplicationCommandOptions
Parameters
- options: T
  
  The options for creating the command.
Returns Promise<ApplicationCommandOptionConversion<T>>
Inherited from ClientApplication.createGlobalCommand
- Defined in lib/structures/ClientApplication.ts:57

createGuildCommand

createGuildCommand<T>(guildID: string, options: T): Promise<ApplicationCommandOptionConversion<T>>
Create a guild application command.
Type Parameters
- T extends CreateGuildApplicationCommandOptions = CreateGuildApplicationCommandOptions
Parameters
- guildID: string
  
  The ID of the guild.
- options: T
  
  The options for creating the command.
Returns Promise<ApplicationCommandOptionConversion<T>>
Inherited from ClientApplication.createGuildCommand
- Defined in lib/structures/ClientApplication.ts:66

deleteGlobalCommand

deleteGlobalCommand(commandID: string): Promise<void>
Delete a global application command.
Parameters
- commandID: string
  
  The ID of the command.
Returns Promise<void>
Inherited from ClientApplication.deleteGlobalCommand
- Defined in lib/structures/ClientApplication.ts:74

deleteGuildCommand

deleteGuildCommand(guildID: string, commandID: string): Promise<void>
Delete a guild application command.
Parameters
- guildID: string
  
  The ID of the guild.
- commandID: string
  
  The ID of the command.
Returns Promise<void>
Inherited from ClientApplication.deleteGuildCommand
- Defined in lib/structures/ClientApplication.ts:83

editGlobalCommand

editGlobalCommand<T>(commandID: string, options: T): Promise<ApplicationCommandOptionConversion<T>>
Edit a global application command.
Type Parameters
- T extends EditApplicationCommandOptions = EditApplicationCommandOptions
Parameters
- commandID: string
  
  The ID of the command.
- options: T
  
  The options for editing the command.
Returns Promise<ApplicationCommandOptionConversion<T>>
Inherited from ClientApplication.editGlobalCommand
- Defined in lib/structures/ClientApplication.ts:92

editGuildCommand

editGuildCommand<T>(guildID: string, commandID: string, options: T): Promise<ApplicationCommandOptionConversion<T>>
Edit a guild application command.
Type Parameters
- T extends EditGuildApplicationCommandOptions = EditGuildApplicationCommandOptions
Parameters
- guildID: string
  
  The ID of the guild.
- commandID: string
  
  The ID of the command.
- options: T
  
  The options for editing the command.
Returns Promise<ApplicationCommandOptionConversion<T>>
Inherited from ClientApplication.editGuildCommand
- Defined in lib/structures/ClientApplication.ts:102

editGuildCommandPermissions

editGuildCommandPermissions(guildID: string, commandID: string, options: EditApplicationCommandPermissionsOptions): Promise<RESTGuildApplicationCommandPermissions>
Edit a guild application command's permissions. This requires a bearer token with the applications.commands.permissions.update scope.
Parameters
- guildID: string
  
  The ID of the guild.
- commandID: string
  
  The ID of the command.
- options: EditApplicationCommandPermissionsOptions
  
  The options for editing the permissions.
Returns Promise<RESTGuildApplicationCommandPermissions>
Inherited from ClientApplication.editGuildCommandPermissions
- Defined in lib/structures/ClientApplication.ts:112

getGlobalCommand

getGlobalCommand<T>(commandID: string, options?: GetApplicationCommandOptions): Promise<T>
Get a global application command.
Type Parameters
- T extends AnyApplicationCommand = AnyApplicationCommand
Parameters
- commandID: string
  
  The ID of the command.
- Optional options: GetApplicationCommandOptions
  
  The options for getting the command.
Returns Promise<T>
Inherited from ClientApplication.getGlobalCommand
- Defined in lib/structures/ClientApplication.ts:121

getGlobalCommands

getGlobalCommands(options?: GetApplicationCommandOptions): Promise<AnyApplicationCommand[]>
Get this application's global commands.
Parameters
- Optional options: GetApplicationCommandOptions
  
  The options for getting the command.
Returns Promise<AnyApplicationCommand[]>
Inherited from ClientApplication.getGlobalCommands
- Defined in lib/structures/ClientApplication.ts:129

getGuildCommand

getGuildCommand<T>(guildID: string, commandID: string, options?: GetApplicationCommandOptions): Promise<T>
Get a global application command.
Type Parameters
- T extends AnyApplicationCommand = AnyApplicationCommand
Parameters
- guildID: string
  
  The ID of the guild.
- commandID: string
  
  The ID of the command.
- Optional options: GetApplicationCommandOptions
  
  The options for getting the command.
Returns Promise<T>
Inherited from ClientApplication.getGuildCommand
- Defined in lib/structures/ClientApplication.ts:139

getGuildCommands

getGuildCommands(guildID: string, options?: GetApplicationCommandOptions): Promise<AnyApplicationCommand[]>
Get this application's commands in a specific guild.
Parameters
- guildID: string
  
  The ID of the guild.
- Optional options: GetApplicationCommandOptions
  
  The options for getting the command.
Returns Promise<AnyApplicationCommand[]>
Inherited from ClientApplication.getGuildCommands
- Defined in lib/structures/ClientApplication.ts:148

getGuildPermission

getGuildPermission(guildID: string, commandID: string): Promise<RESTGuildApplicationCommandPermissions>
Get a command's permissions in a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- commandID: string
  
  The ID of the command.
Returns Promise<RESTGuildApplicationCommandPermissions>
Inherited from ClientApplication.getGuildPermission
- Defined in lib/structures/ClientApplication.ts:157

getGuildPermissions

getGuildPermissions(guildID: string): Promise<RESTGuildApplicationCommandPermissions[]>
Get the permissions for all commands in a guild.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<RESTGuildApplicationCommandPermissions[]>
Inherited from ClientApplication.getGuildPermissions
- Defined in lib/structures/ClientApplication.ts:165

getRoleConnectionsMetadata

getRoleConnectionsMetadata(): Promise<RoleConnectionMetadata[]>
Get this application's role connection metadata records.

Returns Promise<RoleConnectionMetadata[]>
Inherited from ClientApplication.getRoleConnectionsMetadata
- Defined in lib/structures/ClientApplication.ts:172

getUserRoleConnection

getUserRoleConnection(): Promise<RoleConnection>
Get the authenticated user's role connection object for this application. This requires the role_connections.write scope.

Returns Promise<RoleConnection>
Inherited from ClientApplication.getUserRoleConnection
- Defined in lib/structures/ClientApplication.ts:179

toJSON

toJSON(): JSONOAuthApplication
Returns JSONOAuthApplication
Overrides ClientApplication.toJSON
- Defined in lib/structures/OAuthApplication.ts:161

toString

toString(): string
Returns string
Inherited from ClientApplication.toString
- Defined in lib/structures/Base.ts:56

updateRoleConnectionsMetadata

updateRoleConnectionsMetadata(metadata: RoleConnectionMetadata[]): Promise<RoleConnectionMetadata[]>
Update this application's role connections metadata.
Parameters
- metadata: RoleConnectionMetadata[]
  
  The metadata records.
Returns Promise<RoleConnectionMetadata[]>
Inherited from ClientApplication.updateRoleConnectionsMetadata
- Defined in lib/structures/ClientApplication.ts:194

updateUserRoleConnection

updateUserRoleConnection(data: UpdateUserApplicationRoleConnectionOptions): Promise<RoleConnection>
Update the authenticated user's role connection object for an application. This requires the role_connections.write scope.
Parameters
- data: UpdateUserApplicationRoleConnectionOptions
  
  The metadata to update.
Returns Promise<RoleConnection>
Inherited from ClientApplication.updateUserRoleConnection
- Defined in lib/structures/ClientApplication.ts:202

`Static` getCreatedAt

getCreatedAt(id: string): Date
Parameters
- id: string
Returns Date
Inherited from ClientApplication.getCreatedAt
- Defined in lib/structures/Base.ts:20

`Static` getDiscordEpoch

getDiscordEpoch(id: string): number
Parameters
- id: string
Returns number
Inherited from ClientApplication.getDiscordEpoch
- Defined in lib/structures/Base.ts:24

Class OAuthApplication

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

data: RESTOAuthApplication

client: Client<ClientEvents>

Returns OAuthApplication

Properties

botPublic

botRequireCodeGrant

client

coverImage

Optional customInstallURL

description

flags

guildID

icon

id

Optional installParams

name

owner

ownerID

Optional primarySKUID

Optional privacyPolicyURL

Optional roleConnectionsVerificationURL

rpcOrigins

Optional slug

Optional tags

team

Optional termsOfServiceURL

type

verifyKey

Accessors

createdAt

Returns Date

guild

Returns null | Guild

Methods

bulkEditGlobalCommands

Parameters

options: CreateApplicationCommandOptions[]

Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>

bulkEditGuildCommands

Parameters

guildID: string

options: CreateGuildApplicationCommandOptions[]

Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>

coverImageURL

Parameters

Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"

Optional size: number

Returns null | string

createGlobalCommand

Type Parameters

T extends CreateApplicationCommandOptions = CreateApplicationCommandOptions

Parameters

options: T

Returns Promise<ApplicationCommandOptionConversion<T>>

createGuildCommand

Type Parameters

T extends CreateGuildApplicationCommandOptions = CreateGuildApplicationCommandOptions

Parameters

guildID: string

options: T

Returns Promise<ApplicationCommandOptionConversion<T>>

deleteGlobalCommand

Parameters

commandID: string

Returns Promise<void>

deleteGuildCommand

Parameters

guildID: string

commandID: string

Returns Promise<void>

`Optional` customInstallURL

`Optional` installParams

`Optional` primarySKUID

`Optional` privacyPolicyURL

`Optional` roleConnectionsVerificationURL

`Optional` slug

`Optional` tags

`Optional` termsOfServiceURL

`Optional` format: "jpg" | "jpeg" | "png" | "webp" | "gif"

`Optional` size: number

`Optional` options: GetApplicationCommandOptions

`Optional` options: GetApplicationCommandOptions

`Optional` options: GetApplicationCommandOptions

`Optional` options: GetApplicationCommandOptions