Class Client

acceptInvite

• acceptInvite(inviteID: string): Promise<Invite<"withoutCount", InviteChannel>>

• Parameters

  • inviteID: string

  Returns Promise<Invite<"withoutCount", InviteChannel>>

addGroupRecipient

• addGroupRecipient(groupID: string, userID: string): Promise<void>

• Parameters

  • groupID: string

  • userID: string

  Returns Promise<void>

addGuildDiscoverySubcategory

• addGuildDiscoverySubcategory(guildID: string, categoryID: string, reason?: string): Promise<DiscoverySubcategoryResponse>

• Parameters

  • guildID: string

  • categoryID: string

  • Optional reason: string

  Returns Promise<DiscoverySubcategoryResponse>

addGuildMemberRole

• addGuildMemberRole(guildID: string, memberID: string, roleID: string, reason?: string): Promise<void>

• Parameters

  • guildID: string

  • memberID: string

  • roleID: string

  • Optional reason: string

  Returns Promise<void>

addMessageReaction

• addMessageReaction(channelID: string, messageID: string, reaction: string): Promise<void>
• addMessageReaction(channelID: string, messageID: string, reaction: string, userID: string): Promise<void>

• Parameters

  • channelID: string

  • messageID: string

  • reaction: string

  Returns Promise<void>

• deprecated

  Parameters

  • channelID: string

  • messageID: string

  • reaction: string

  • userID: string

  Returns Promise<void>

addRelationship

• addRelationship(userID: string, block?: boolean): Promise<void>

• Parameters

  • userID: string

  • Optional block: boolean

  Returns Promise<void>

addSelfPremiumSubscription

• addSelfPremiumSubscription(token: string, plan: string): Promise<void>

• Parameters

  • token: string

  • plan: string

  Returns Promise<void>

banGuildMember

• banGuildMember(guildID: string, userID: string, deleteMessageDays?: number, reason?: string): Promise<void>

• Parameters

  • guildID: string

  • userID: string

  • Optional deleteMessageDays: number

  • Optional reason: string

  Returns Promise<void>

closeVoiceConnection

• closeVoiceConnection(guildID: string): void

• Parameters

  • guildID: string

  Returns void

connect

• connect(): Promise<void>

• Returns Promise<void>

createChannel

• createChannel(guildID: string, name: string): Promise<TextChannel>
• createChannel(guildID: string, name: string, type: 0, options?: CreateChannelOptions): Promise<TextChannel>
• createChannel(guildID: string, name: string, type: 2, options?: CreateChannelOptions): Promise<VoiceChannel>
• createChannel(guildID: string, name: string, type: 4, options?: CreateChannelOptions): Promise<CategoryChannel>
• createChannel(guildID: string, name: string, type: 5, options?: CreateChannelOptions): Promise<NewsChannel>
• createChannel(guildID: string, name: string, type: 6, options?: CreateChannelOptions): Promise<StoreChannel>
• createChannel(guildID: string, name: string, type: 13, options?: CreateChannelOptions): Promise<StageChannel>
• createChannel(guildID: string, name: string, type?: number, options?: CreateChannelOptions): Promise<unknown>
• createChannel(guildID: string, name: string, type: 0, reason?: string, options?: string | CreateChannelOptions): Promise<TextChannel>
• createChannel(guildID: string, name: string, type: 2, reason?: string, options?: string | CreateChannelOptions): Promise<VoiceChannel>
• createChannel(guildID: string, name: string, type: 4, reason?: string, options?: string | CreateChannelOptions): Promise<CategoryChannel>
• createChannel(guildID: string, name: string, type: 5, reason?: string, options?: string | CreateChannelOptions): Promise<NewsChannel>
• createChannel(guildID: string, name: string, type: 6, reason?: string, options?: string | CreateChannelOptions): Promise<StoreChannel>
• createChannel(guildID: string, name: string, type: 13, reason?: string, options?: string | CreateChannelOptions): Promise<StageChannel>
• createChannel(guildID: string, name: string, type?: number, reason?: string, options?: string | CreateChannelOptions): Promise<unknown>

• Parameters

  • guildID: string

  • name: string

  Returns Promise<TextChannel>

• Parameters

  • guildID: string

  • name: string

  • type: 0

  • Optional options: CreateChannelOptions

  Returns Promise<TextChannel>

• Parameters

  • guildID: string

  • name: string

  • type: 2

  • Optional options: CreateChannelOptions

  Returns Promise<VoiceChannel>

• Parameters

  • guildID: string

  • name: string

  • type: 4

  • Optional options: CreateChannelOptions

  Returns Promise<CategoryChannel>

• Parameters

  • guildID: string

  • name: string

  • type: 5

  • Optional options: CreateChannelOptions

  Returns Promise<NewsChannel>

• Parameters

  • guildID: string

  • name: string

  • type: 6

  • Optional options: CreateChannelOptions

  Returns Promise<StoreChannel>

• Parameters

  • guildID: string

  • name: string

  • type: 13

  • Optional options: CreateChannelOptions

  Returns Promise<StageChannel>

• Parameters

  • guildID: string

  • name: string

  • Optional type: number

  • Optional options: CreateChannelOptions

  Returns Promise<unknown>

• deprecated

  Parameters

  • guildID: string

  • name: string

  • type: 0

  • Optional reason: string

  • Optional options: string | CreateChannelOptions

  Returns Promise<TextChannel>

• deprecated

  Parameters

  • guildID: string

  • name: string

  • type: 2

  • Optional reason: string

  • Optional options: string | CreateChannelOptions

  Returns Promise<VoiceChannel>

• deprecated

  Parameters

  • guildID: string

  • name: string

  • type: 4

  • Optional reason: string

  • Optional options: string | CreateChannelOptions

  Returns Promise<CategoryChannel>

• deprecated

  Parameters

  • guildID: string

  • name: string

  • type: 5

  • Optional reason: string

  • Optional options: string | CreateChannelOptions

  Returns Promise<NewsChannel>

• deprecated

  Parameters

  • guildID: string

  • name: string

  • type: 6

  • Optional reason: string

  • Optional options: string | CreateChannelOptions

  Returns Promise<StoreChannel>

• deprecated

  Parameters

  • guildID: string

  • name: string

  • type: 13

  • Optional reason: string

  • Optional options: string | CreateChannelOptions

  Returns Promise<StageChannel>

• deprecated

  Parameters

  • guildID: string

  • name: string

  • Optional type: number

  • Optional reason: string

  • Optional options: string | CreateChannelOptions

  Returns Promise<unknown>

createChannelInvite

• createChannelInvite(channelID: string, options?: CreateChannelInviteOptions, reason?: string): Promise<Invite<"withoutCount", InviteChannel>>

• Parameters

  • channelID: string

  • Optional options: CreateChannelInviteOptions

  • Optional reason: string

  Returns Promise<Invite<"withoutCount", InviteChannel>>

createChannelWebhook

• createChannelWebhook(channelID: string, options: { avatar?: null | string; name: string }, reason?: string): Promise<Webhook>

• Parameters

  • channelID: string

  • options: { avatar?: null | string; name: string }

    • Optional avatar?: null | string

    • name: string

  • Optional reason: string

  Returns Promise<Webhook>

createGroupChannel

• createGroupChannel(userIDs: string[]): Promise<GroupChannel>

• Parameters

  • userIDs: string[]

  Returns Promise<GroupChannel>

createGuild

• createGuild(name: string, options?: CreateGuildOptions): Promise<Guild>

• Parameters

  • name: string

  • Optional options: CreateGuildOptions

  Returns Promise<Guild>

createGuildEmoji

• createGuildEmoji(guildID: string, options: EmojiOptions, reason?: string): Promise<Emoji>

• Parameters

  • guildID: string

  • options: EmojiOptions

  • Optional reason: string

  Returns Promise<Emoji>

createGuildFromTemplate

• createGuildFromTemplate(code: string, name: string, icon?: string): Promise<Guild>

• Parameters

  • code: string

  • name: string

  • Optional icon: string

  Returns Promise<Guild>

createGuildTemplate

• createGuildTemplate(guildID: string, name: string, description?: null | string): Promise<GuildTemplate>

• Parameters

  • guildID: string

  • name: string

  • Optional description: null | string

  Returns Promise<GuildTemplate>

createMessage

• createMessage(channelID: string, content: MessageContent, file?: MessageFile | MessageFile[]): Promise<Message<TextableChannel>>

• Parameters

  • channelID: string

  • content: MessageContent

  • Optional file: MessageFile | MessageFile[]

  Returns Promise<Message<TextableChannel>>

createRole

• createRole(guildID: string, options?: Role | RoleOptions, reason?: string): Promise<Role>

• Parameters

  • guildID: string

  • Optional options: Role | RoleOptions

  • Optional reason: string

  Returns Promise<Role>

crosspostMessage

• crosspostMessage(channelID: string, messageID: string): Promise<Message<TextableChannel>>

• Parameters

  • channelID: string

  • messageID: string

  Returns Promise<Message<TextableChannel>>

deleteChannel

• deleteChannel(channelID: string, reason?: string): Promise<void>

• Parameters

  • channelID: string

  • Optional reason: string

  Returns Promise<void>

deleteChannelPermission

• deleteChannelPermission(channelID: string, overwriteID: string, reason?: string): Promise<void>

• Parameters

  • channelID: string

  • overwriteID: string

  • Optional reason: string

  Returns Promise<void>

deleteGuild

• deleteGuild(guildID: string): Promise<void>

• Parameters

  • guildID: string

  Returns Promise<void>

deleteGuildDiscoverySubcategory

• deleteGuildDiscoverySubcategory(guildID: string, categoryID: string, reason?: string): Promise<void>

• Parameters

  • guildID: string

  • categoryID: string

  • Optional reason: string

  Returns Promise<void>

deleteGuildEmoji

• deleteGuildEmoji(guildID: string, emojiID: string, reason?: string): Promise<void>

• Parameters

  • guildID: string

  • emojiID: string

  • Optional reason: string

  Returns Promise<void>

deleteGuildIntegration

• deleteGuildIntegration(guildID: string, integrationID: string): Promise<void>

• Parameters

  • guildID: string

  • integrationID: string

  Returns Promise<void>

deleteGuildTemplate

• deleteGuildTemplate(guildID: string, code: string): Promise<GuildTemplate>

• Parameters

  • guildID: string

  • code: string

  Returns Promise<GuildTemplate>

deleteInvite

• deleteInvite(inviteID: string, reason?: string): Promise<void>

• Parameters

  • inviteID: string

  • Optional reason: string

  Returns Promise<void>

deleteMessage

• deleteMessage(channelID: string, messageID: string, reason?: string): Promise<void>

• Parameters

  • channelID: string

  • messageID: string

  • Optional reason: string

  Returns Promise<void>

deleteMessages

• deleteMessages(channelID: string, messageIDs: string[], reason?: string): Promise<void>

• Parameters

  • channelID: string

  • messageIDs: string[]

  • Optional reason: string

  Returns Promise<void>

deleteRole

• deleteRole(guildID: string, roleID: string, reason?: string): Promise<void>

• Parameters

  • guildID: string

  • roleID: string

  • Optional reason: string

  Returns Promise<void>

deleteSelfConnection

• deleteSelfConnection(platform: string, id: string): Promise<void>

• Parameters

  • platform: string

  • id: string

  Returns Promise<void>

deleteSelfPremiumSubscription

• deleteSelfPremiumSubscription(): Promise<void>

• Returns Promise<void>

deleteUserNote

• deleteUserNote(userID: string): Promise<void>

• Parameters

  • userID: string

  Returns Promise<void>

deleteWebhook

• deleteWebhook(webhookID: string, token?: string, reason?: string): Promise<void>

• Parameters

  • webhookID: string

  • Optional token: string

  • Optional reason: string

  Returns Promise<void>

deleteWebhookMessage

• deleteWebhookMessage(webhookID: string, token: string, messageID: string): Promise<void>

• Parameters

  • webhookID: string

  • token: string

  • messageID: string

  Returns Promise<void>

disableSelfMFATOTP

• disableSelfMFATOTP(code: string): Promise<{ token: string }>

• Parameters

  • code: string

  Returns Promise<{ token: string }>

disconnect

• disconnect(options: { reconnect?: boolean | "auto" }): void

• Parameters

  • options: { reconnect?: boolean | "auto" }

    • Optional reconnect?: boolean | "auto"

  Returns void

editAFK

• editAFK(afk: boolean): void

• Parameters

  • afk: boolean

  Returns void

editChannel

• editChannel(channelID: string, options: EditChannelOptions, reason?: string): Promise<AnyGuildChannel | GroupChannel>

• Parameters

  • channelID: string

  • options: EditChannelOptions

  • Optional reason: string

  Returns Promise<AnyGuildChannel | GroupChannel>

editChannelPermission

• editChannelPermission(channelID: string, overwriteID: string, allow: number | bigint, deny: number | bigint, type: string, reason?: string): Promise<void>

• Parameters

  • channelID: string

  • overwriteID: string

  • allow: number | bigint

  • deny: number | bigint

  • type: string

  • Optional reason: string

  Returns Promise<void>

editChannelPosition

• editChannelPosition(channelID: string, position: number, options?: EditChannelPositionOptions): Promise<void>

• Parameters

  • channelID: string

  • position: number

  • Optional options: EditChannelPositionOptions

  Returns Promise<void>

editGuild

• editGuild(guildID: string, options: GuildOptions, reason?: string): Promise<Guild>

• Parameters

  • guildID: string

  • options: GuildOptions

  • Optional reason: string

  Returns Promise<Guild>

editGuildDiscovery

• editGuildDiscovery(guildID: string, options?: DiscoveryOptions): Promise<DiscoveryMetadata>

• Parameters

  • guildID: string

  • Optional options: DiscoveryOptions

  Returns Promise<DiscoveryMetadata>

editGuildEmoji

• editGuildEmoji(guildID: string, emojiID: string, options: { name?: string; roles?: string[] }, reason?: string): Promise<Emoji>

• Parameters

  • guildID: string

  • emojiID: string

  • options: { name?: string; roles?: string[] }

    • Optional name?: string

    • Optional roles?: string[]

  • Optional reason: string

  Returns Promise<Emoji>

editGuildIntegration

• editGuildIntegration(guildID: string, integrationID: string, options: IntegrationOptions): Promise<void>

• Parameters

  • guildID: string

  • integrationID: string

  • options: IntegrationOptions

  Returns Promise<void>

editGuildMember

• editGuildMember(guildID: string, memberID: string, options: MemberOptions, reason?: string): Promise<void>

• Parameters

  • guildID: string

  • memberID: string

  • options: MemberOptions

  • Optional reason: string

  Returns Promise<void>

editGuildTemplate

• editGuildTemplate(guildID: string, code: string, options: GuildTemplateOptions): Promise<GuildTemplate>

• Parameters

  • guildID: string

  • code: string

  • options: GuildTemplateOptions

  Returns Promise<GuildTemplate>

editGuildVanity

• editGuildVanity(guildID: string, code: null | string): Promise<GuildVanity>

• Parameters

  • guildID: string

  • code: null | string

  Returns Promise<GuildVanity>

editGuildVoiceState

• editGuildVoiceState(guildID: string, options: VoiceStateOptions, userID?: string): Promise<void>

• Parameters

  • guildID: string

  • options: VoiceStateOptions

  • Optional userID: string

  Returns Promise<void>

editGuildWelcomeScreen

• editGuildWelcomeScreen(guildID: string, options: WelcomeScreenOptions): Promise<WelcomeScreen>

• Parameters

  • guildID: string

  • options: WelcomeScreenOptions

  Returns Promise<WelcomeScreen>

editGuildWidget

• editGuildWidget(guildID: string, options: Widget): Promise<Widget>

• Parameters

  • guildID: string

  • options: Widget

  Returns Promise<Widget>

editMessage

• editMessage(channelID: string, messageID: string, content: MessageContent): Promise<Message<TextableChannel>>

• Parameters

  • channelID: string

  • messageID: string

  • content: MessageContent

  Returns Promise<Message<TextableChannel>>

editNickname

• editNickname(guildID: string, nick: string, reason?: string): Promise<void>

• Parameters

  • guildID: string

  • nick: string

  • Optional reason: string

  Returns Promise<void>

editRole

• editRole(guildID: string, roleID: string, options: RoleOptions, reason?: string): Promise<Role>

• Parameters

  • guildID: string

  • roleID: string

  • options: RoleOptions

  • Optional reason: string

  Returns Promise<Role>

editRolePosition

• editRolePosition(guildID: string, roleID: string, position: number): Promise<void>

• Parameters

  • guildID: string

  • roleID: string

  • position: number

  Returns Promise<void>

editSelf

• editSelf(options: { avatar?: string; username?: string }): Promise<ExtendedUser>

• Parameters

  • options: { avatar?: string; username?: string }

    • Optional avatar?: string

    • Optional username?: string

  Returns Promise<ExtendedUser>

editSelfConnection

• editSelfConnection(platform: string, id: string, data: { friendSync: boolean; visibility: number }): Promise<Connection>

• Parameters

  • platform: string

  • id: string

  • data: { friendSync: boolean; visibility: number }

    • friendSync: boolean

    • visibility: number

  Returns Promise<Connection>

editSelfSettings

• editSelfSettings(data: UserSettings): Promise<UserSettings>

• Parameters

  • data: UserSettings

  Returns Promise<UserSettings>

editStatus

• editStatus(status?: Status, game?: ActivityPartial<BotActivityType>): void

• Parameters

  • Optional status: Status

  • Optional game: ActivityPartial<BotActivityType>

  Returns void

editUserNote

• editUserNote(userID: string, note: string): Promise<void>

• Parameters

  • userID: string

  • note: string

  Returns Promise<void>

editWebhook

• editWebhook(webhookID: string, options: WebhookOptions, token?: string, reason?: string): Promise<Webhook>

• Parameters

  • webhookID: string

  • options: WebhookOptions

  • Optional token: string

  • Optional reason: string

  Returns Promise<Webhook>

editWebhookMessage

• editWebhookMessage(webhookID: string, token: string, messageID: string, options: MessageWebhookContent): Promise<Message<GuildTextableChannel>>

• Parameters

  • webhookID: string

  • token: string

  • messageID: string

  • options: MessageWebhookContent

  Returns Promise<Message<GuildTextableChannel>>

enableSelfMFATOTP

• enableSelfMFATOTP(secret: string, code: string): Promise<{ backup_codes: { code: string; consumed: boolean }[]; token: string }>

• Parameters

  • secret: string

  • code: string

  Returns Promise<{ backup_codes: { code: string; consumed: boolean }[]; token: string }>

executeSlackWebhook

• executeSlackWebhook(webhookID: string, token: string, options: Record<string, unknown> & { auth?: boolean }): Promise<void>
• executeSlackWebhook(webhookID: string, token: string, options: Record<string, unknown> & { auth?: boolean; wait: true }): Promise<Message<GuildTextableChannel>>

• Parameters

  • webhookID: string

  • token: string

  • options: Record<string, unknown> & { auth?: boolean }

  Returns Promise<void>

• Parameters

  • webhookID: string

  • token: string

  • options: Record<string, unknown> & { auth?: boolean; wait: true }

  Returns Promise<Message<GuildTextableChannel>>

executeWebhook

• executeWebhook(webhookID: string, token: string, options: WebhookPayload & { wait: true }): Promise<Message<GuildTextableChannel>>
• executeWebhook(webhookID: string, token: string, options: WebhookPayload): Promise<void>

• Parameters

  • webhookID: string

  • token: string

  • options: WebhookPayload & { wait: true }

  Returns Promise<Message<GuildTextableChannel>>

• Parameters

  • webhookID: string

  • token: string

  • options: WebhookPayload

  Returns Promise<void>

followChannel

• followChannel(channelID: string, webhookChannelID: string): Promise<ChannelFollow>

• Parameters

  • channelID: string

  • webhookChannelID: string

  Returns Promise<ChannelFollow>

getBotGateway

• getBotGateway(): Promise<{ session_start_limit: { max_concurrency: number; remaining: number; reset_after: number; total: number }; shards: number; url: string }>

• Returns Promise<{ session_start_limit: { max_concurrency: number; remaining: number; reset_after: number; total: number }; shards: number; url: string }>

getChannel

• getChannel(channelID: string): AnyChannel

• Parameters

  • channelID: string

  Returns AnyChannel

getChannelInvites

• getChannelInvites(channelID: string): Promise<Invite<"withMetadata", InviteChannel>[]>

• Parameters

  • channelID: string

  Returns Promise<Invite<"withMetadata", InviteChannel>[]>

getChannelWebhooks

• getChannelWebhooks(channelID: string): Promise<Webhook[]>

• Parameters

  • channelID: string

  Returns Promise<Webhook[]>

getDMChannel

• getDMChannel(userID: string): Promise<PrivateChannel>

• Parameters

  • userID: string

  Returns Promise<PrivateChannel>

getDiscoveryCategories

• getDiscoveryCategories(): Promise<DiscoveryCategory[]>

• Returns Promise<DiscoveryCategory[]>

getGateway

• getGateway(): Promise<{ url: string }>

• Returns Promise<{ url: string }>

getGuildAuditLog

• getGuildAuditLog(guildID: string, options?: GetGuildAuditLogOptions): Promise<GuildAuditLog>

• Parameters

  • guildID: string

  • Optional options: GetGuildAuditLogOptions

  Returns Promise<GuildAuditLog>

getGuildAuditLogs

• getGuildAuditLogs(guildID: string, limit?: number, before?: string, actionType?: number, userID?: string): Promise<GuildAuditLog>

• deprecated

  Parameters

  • guildID: string

  • Optional limit: number

  • Optional before: string

  • Optional actionType: number

  • Optional userID: string

  Returns Promise<GuildAuditLog>

getGuildBan

• getGuildBan(guildID: string, userID: string): Promise<{ reason?: string; user: User }>

• Parameters

  • guildID: string

  • userID: string

  Returns Promise<{ reason?: string; user: User }>

getGuildBans

• getGuildBans(guildID: string): Promise<{ reason?: string; user: User }[]>

• Parameters

  • guildID: string

  Returns Promise<{ reason?: string; user: User }[]>

getGuildDiscovery

• getGuildDiscovery(guildID: string): Promise<DiscoveryMetadata>

• Parameters

  • guildID: string

  Returns Promise<DiscoveryMetadata>

getGuildEmbed

• getGuildEmbed(guildID: string): Promise<Widget>

• deprecated

  Parameters

  • guildID: string

  Returns Promise<Widget>

getGuildIntegrations

• getGuildIntegrations(guildID: string, options?: GetGuildIntegrationsOptions): Promise<GuildIntegration[]>

• Parameters

  • guildID: string

  • Optional options: GetGuildIntegrationsOptions

  Returns Promise<GuildIntegration[]>

getGuildInvites

• getGuildInvites(guildID: string): Promise<Invite<"withMetadata", InviteChannel>[]>

• Parameters

  • guildID: string

  Returns Promise<Invite<"withMetadata", InviteChannel>[]>

getGuildPreview

• getGuildPreview(guildID: string): Promise<GuildPreview>

• Parameters

  • guildID: string

  Returns Promise<GuildPreview>

getGuildTemplate

• getGuildTemplate(code: string): Promise<GuildTemplate>

• Parameters

  • code: string

  Returns Promise<GuildTemplate>

getGuildTemplates

• getGuildTemplates(guildID: string): Promise<GuildTemplate[]>

• Parameters

  • guildID: string

  Returns Promise<GuildTemplate[]>

getGuildVanity

• getGuildVanity(guildID: string): Promise<GuildVanity>

• Parameters

  • guildID: string

  Returns Promise<GuildVanity>

getGuildWebhooks

• getGuildWebhooks(guildID: string): Promise<Webhook[]>

• Parameters

  • guildID: string

  Returns Promise<Webhook[]>

getGuildWelcomeScreen

• getGuildWelcomeScreen(guildID: string): Promise<WelcomeScreen>

• Parameters

  • guildID: string

  Returns Promise<WelcomeScreen>

getGuildWidget

• getGuildWidget(guildID: string): Promise<Widget>

• Parameters

  • guildID: string

  Returns Promise<Widget>

getInvite

• getInvite(inviteID: string, withCounts?: false): Promise<Invite<"withoutCount", InviteChannel>>
• getInvite(inviteID: string, withCounts: true): Promise<Invite<"withCount", InviteChannel>>

• Parameters

  • inviteID: string

  • Optional withCounts: false

  Returns Promise<Invite<"withoutCount", InviteChannel>>

• Parameters

  • inviteID: string

  • withCounts: true

  Returns Promise<Invite<"withCount", InviteChannel>>

getMessage

• getMessage(channelID: string, messageID: string): Promise<Message<TextableChannel>>

• Parameters

  • channelID: string

  • messageID: string

  Returns Promise<Message<TextableChannel>>

getMessageReaction

• getMessageReaction(channelID: string, messageID: string, reaction: string, options?: GetMessageReactionOptions): Promise<User[]>
• getMessageReaction(channelID: string, messageID: string, reaction: string, limit?: number, before?: string, after?: string): Promise<User[]>

• Parameters

  • channelID: string

  • messageID: string

  • reaction: string

  • Optional options: GetMessageReactionOptions

  Returns Promise<User[]>

• deprecated

  Parameters

  • channelID: string

  • messageID: string

  • reaction: string

  • Optional limit: number

  • Optional before: string

  • Optional after: string

  Returns Promise<User[]>

getMessages

• getMessages(channelID: string, options?: GetMessagesOptions): Promise<Message<TextableChannel>[]>
• getMessages(channelID: string, limit?: number, before?: string, after?: string, around?: string): Promise<Message<TextableChannel>[]>

• Parameters

  • channelID: string

  • Optional options: GetMessagesOptions

  Returns Promise<Message<TextableChannel>[]>

• deprecated

  Parameters

  • channelID: string

  • Optional limit: number

  • Optional before: string

  • Optional after: string

  • Optional around: string

  Returns Promise<Message<TextableChannel>[]>

getOAuthApplication

• getOAuthApplication(appID?: string): Promise<OAuthApplicationInfo>

• Parameters

  • Optional appID: string

  Returns Promise<OAuthApplicationInfo>

getPins

• getPins(channelID: string): Promise<Message<TextableChannel>[]>

• Parameters

  • channelID: string

  Returns Promise<Message<TextableChannel>[]>

getPruneCount

• getPruneCount(guildID: string, options?: GetPruneOptions): Promise<number>

• Parameters

  • guildID: string

  • Optional options: GetPruneOptions

  Returns Promise<number>

getRESTChannel

• getRESTChannel(channelID: string): Promise<AnyChannel>

• Parameters

  • channelID: string

  Returns Promise<AnyChannel>

getRESTGuild

• getRESTGuild(guildID: string, withCounts?: boolean): Promise<Guild>

• Parameters

  • guildID: string

  • Optional withCounts: boolean

  Returns Promise<Guild>

getRESTGuildChannels

• getRESTGuildChannels(guildID: string): Promise<AnyGuildChannel[]>

• Parameters

  • guildID: string

  Returns Promise<AnyGuildChannel[]>

getRESTGuildEmoji

• getRESTGuildEmoji(guildID: string, emojiID: string): Promise<Emoji>

• Parameters

  • guildID: string

  • emojiID: string

  Returns Promise<Emoji>

getRESTGuildEmojis

• getRESTGuildEmojis(guildID: string): Promise<Emoji[]>

• Parameters

  • guildID: string

  Returns Promise<Emoji[]>

getRESTGuildMember

• getRESTGuildMember(guildID: string, memberID: string): Promise<Member>

• Parameters

  • guildID: string

  • memberID: string

  Returns Promise<Member>

getRESTGuildMembers

• getRESTGuildMembers(guildID: string, options?: GetRESTGuildMembersOptions): Promise<Member[]>
• getRESTGuildMembers(guildID: string, limit?: number, after?: string): Promise<Member[]>

• Parameters

  • guildID: string

  • Optional options: GetRESTGuildMembersOptions

  Returns Promise<Member[]>

• deprecated

  Parameters

  • guildID: string

  • Optional limit: number

  • Optional after: string

  Returns Promise<Member[]>

getRESTGuildRoles

• getRESTGuildRoles(guildID: string): Promise<Role[]>

• Parameters

  • guildID: string

  Returns Promise<Role[]>

getRESTGuilds

• getRESTGuilds(options?: GetRESTGuildsOptions): Promise<Guild[]>
• getRESTGuilds(limit?: number, before?: string, after?: string): Promise<Guild[]>

• Parameters

  • Optional options: GetRESTGuildsOptions

  Returns Promise<Guild[]>

• deprecated

  Parameters

  • Optional limit: number

  • Optional before: string

  • Optional after: string

  Returns Promise<Guild[]>

getRESTUser

• getRESTUser(userID: string): Promise<User>

• Parameters

  • userID: string

  Returns Promise<User>

getSelf

• getSelf(): Promise<ExtendedUser>

• Returns Promise<ExtendedUser>

getSelfBilling

• getSelfBilling(): Promise<{ payment_gateway?: string; payment_source?: { brand: string; expires_month: number; expires_year: number; invalid: boolean; last_4: number; type: string }; premium_subscription?: { canceled_at?: string; created_at: string; current_period_end?: string; current_period_start?: string; ended_at?: string; plan: string; status: number } }>

• Returns Promise<{ payment_gateway?: string; payment_source?: { brand: string; expires_month: number; expires_year: number; invalid: boolean; last_4: number; type: string }; premium_subscription?: { canceled_at?: string; created_at: string; current_period_end?: string; current_period_start?: string; ended_at?: string; plan: string; status: number } }>

getSelfConnections

• getSelfConnections(): Promise<Connection[]>

• Returns Promise<Connection[]>

getSelfMFACodes

• getSelfMFACodes(password: string, regenerate?: boolean): Promise<{ backup_codes: { code: string; consumed: boolean }[] }>

• Parameters

  • password: string

  • Optional regenerate: boolean

  Returns Promise<{ backup_codes: { code: string; consumed: boolean }[] }>

getSelfPayments

• getSelfPayments(): Promise<{ amount: number; amount_refunded: number; created_at: string; currency: string; description: string; status: number }[]>

• Returns Promise<{ amount: number; amount_refunded: number; created_at: string; currency: string; description: string; status: number }[]>

getSelfSettings

• getSelfSettings(): Promise<UserSettings>

• Returns Promise<UserSettings>

getUserProfile

• getUserProfile(userID: string): Promise<UserProfile>

• Parameters

  • userID: string

  Returns Promise<UserProfile>

getVoiceRegions

• getVoiceRegions(guildID?: string): Promise<VoiceRegion[]>

• Parameters

  • Optional guildID: string

  Returns Promise<VoiceRegion[]>

getWebhook

• getWebhook(webhookID: string, token?: string): Promise<Webhook>

• Parameters

  • webhookID: string

  • Optional token: string

  Returns Promise<Webhook>

getWebhookMessage

• getWebhookMessage(webhookID: string, token: string, messageID: string): Promise<Message<GuildTextableChannel>>

• Parameters

  • webhookID: string

  • token: string

  • messageID: string

  Returns Promise<Message<GuildTextableChannel>>

joinVoiceChannel

• joinVoiceChannel(channelID: string, options?: { opusOnly?: boolean; shared?: boolean }): Promise<VoiceConnection>

• Parameters

  • channelID: string

  • Optional options: { opusOnly?: boolean; shared?: boolean }

    • Optional opusOnly?: boolean

    • Optional shared?: boolean

  Returns Promise<VoiceConnection>

kickGuildMember

• kickGuildMember(guildID: string, userID: string, reason?: string): Promise<void>

• Parameters

  • guildID: string

  • userID: string

  • Optional reason: string

  Returns Promise<void>

leaveGuild

• leaveGuild(guildID: string): Promise<void>

• Parameters

  • guildID: string

  Returns Promise<void>

leaveVoiceChannel

• leaveVoiceChannel(channelID: string): void

• Parameters

  • channelID: string

  Returns void

pinMessage

• pinMessage(channelID: string, messageID: string): Promise<void>

• Parameters

  • channelID: string

  • messageID: string

  Returns Promise<void>

pruneMembers

• pruneMembers(guildID: string, options?: PruneMemberOptions): Promise<number>

• Parameters

  • guildID: string

  • Optional options: PruneMemberOptions

  Returns Promise<number>

purgeChannel

• purgeChannel(channelID: string, options: PurgeChannelOptions): Promise<number>
• purgeChannel(channelID: string, limit?: number, filter?: (m: Message<GuildTextableChannel>) => boolean, before?: string, after?: string, reason?: string): Promise<number>

• Parameters

  • channelID: string

  • options: PurgeChannelOptions

  Returns Promise<number>

• deprecated

  Parameters

  • channelID: string

  • Optional limit: number

  • Optional filter: (m: Message<GuildTextableChannel>) => boolean

    • • (m: Message<GuildTextableChannel>): boolean

      • Parameters

        • m: Message<GuildTextableChannel>

        Returns boolean

  • Optional before: string

  • Optional after: string

  • Optional reason: string

  Returns Promise<number>

removeGroupRecipient

• removeGroupRecipient(groupID: string, userID: string): Promise<void>

• Parameters

  • groupID: string

  • userID: string

  Returns Promise<void>

removeGuildMemberRole

• removeGuildMemberRole(guildID: string, memberID: string, roleID: string, reason?: string): Promise<void>

• Parameters

  • guildID: string

  • memberID: string

  • roleID: string

  • Optional reason: string

  Returns Promise<void>

removeMessageReaction

• removeMessageReaction(channelID: string, messageID: string, reaction: string, userID?: string): Promise<void>

• Parameters

  • channelID: string

  • messageID: string

  • reaction: string

  • Optional userID: string

  Returns Promise<void>

removeMessageReactionEmoji

• removeMessageReactionEmoji(channelID: string, messageID: string, reaction: string): Promise<void>

• Parameters

  • channelID: string

  • messageID: string

  • reaction: string

  Returns Promise<void>

removeMessageReactions

• removeMessageReactions(channelID: string, messageID: string): Promise<void>

• Parameters

  • channelID: string

  • messageID: string

  Returns Promise<void>

removeRelationship

• removeRelationship(userID: string): Promise<void>

• Parameters

  • userID: string

  Returns Promise<void>

searchChannelMessages

• searchChannelMessages(channelID: string, query: SearchOptions): Promise<SearchResults>

• Parameters

  • channelID: string

  • query: SearchOptions

  Returns Promise<SearchResults>

searchGuildMembers

• searchGuildMembers(guildID: string, query: string, limit?: number): Promise<Member[]>

• Parameters

  • guildID: string

  • query: string

  • Optional limit: number

  Returns Promise<Member[]>

searchGuildMessages

• searchGuildMessages(guildID: string, query: SearchOptions): Promise<SearchResults>

• Parameters

  • guildID: string

  • query: SearchOptions

  Returns Promise<SearchResults>

sendChannelTyping

• sendChannelTyping(channelID: string): Promise<void>