Class ClientApplication

A representation of the authorized client's application (typically received via gateway).

Hierarchy

Base
- ClientApplication
  - Application

Constructors

constructor

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

Properties

client

client: Client<ClientEvents>

flags

flags: number

This application's public flags.

id

id: string

Accessors

createdAt

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

updateRoleConnectionsMetata

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

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

Methods

bulkEditGlobalCommands

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

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>[]>
- Defined in lib/structures/ClientApplication.ts:54

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>>
- Defined in lib/structures/ClientApplication.ts:62

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>>
- Defined in lib/structures/ClientApplication.ts:71

deleteGlobalCommand

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

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>
- Defined in lib/structures/ClientApplication.ts:88

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>>
- Defined in lib/structures/ClientApplication.ts:97

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>>
- Defined in lib/structures/ClientApplication.ts:107

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>
- Defined in lib/structures/ClientApplication.ts:117

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>
- Defined in lib/structures/ClientApplication.ts:126

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[]>
- Defined in lib/structures/ClientApplication.ts:134

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>
- Defined in lib/structures/ClientApplication.ts:144

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[]>
- Defined in lib/structures/ClientApplication.ts:153

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>
- Defined in lib/structures/ClientApplication.ts:162

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[]>
- Defined in lib/structures/ClientApplication.ts:170

getRoleConnectionsMetadata

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

Returns Promise<RoleConnectionMetadata[]>
- Defined in lib/structures/ClientApplication.ts:177

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>
- Defined in lib/structures/ClientApplication.ts:184

toJSON

toJSON(): JSONClientApplication
Returns JSONClientApplication
Overrides Base.toJSON
- Defined in lib/structures/ClientApplication.ts:188

toString

toString(): string
Returns string
Inherited from Base.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[]>
- Defined in lib/structures/ClientApplication.ts:199

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>
- Defined in lib/structures/ClientApplication.ts:207

`Static` getCreatedAt

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

`Static` getDiscordEpoch

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

Class ClientApplication

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

data: RawClientApplication

client: Client<ClientEvents>

Returns ClientApplication

Properties

client

flags

id

Accessors

createdAt

Returns Date

updateRoleConnectionsMetata

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

Parameters

metadata: RoleConnectionMetadata[]

Returns Promise<RoleConnectionMetadata[]>

Methods

bulkEditGlobalCommands

Parameters

options: CreateApplicationCommandOptions[]

Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>

bulkEditGuildCommands

Parameters

guildID: string

options: CreateGuildApplicationCommandOptions[]

Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>

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>

editGlobalCommand

Type Parameters

T extends EditApplicationCommandOptions = EditApplicationCommandOptions

Parameters

commandID: string

options: T

Returns Promise<ApplicationCommandOptionConversion<T>>

editGuildCommand

Type Parameters

T extends EditGuildApplicationCommandOptions = EditGuildApplicationCommandOptions

Parameters

guildID: string

commandID: string

options: T

Returns Promise<ApplicationCommandOptionConversion<T>>

editGuildCommandPermissions

Parameters

guildID: string

commandID: string

options: EditApplicationCommandPermissionsOptions

Returns Promise<RESTGuildApplicationCommandPermissions>

getGlobalCommand

Type Parameters

`Optional` options: GetApplicationCommandOptions

`Optional` options: GetApplicationCommandOptions

`Optional` options: GetApplicationCommandOptions

`Optional` options: GetApplicationCommandOptions

`Static` getCreatedAt

`Static` getDiscordEpoch