Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CommandClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

activeMessages

activeMessages: {}

Type declaration

Optional application

application: { flags: number; id: string }

Type declaration

  • flags: number
  • id: string

bot

bot: boolean

channelGuildMap

channelGuildMap: {}

Type declaration

  • [s: string]: string

commandAliases

commandAliases: {}

Type declaration

  • [s: string]: string

commandOptions

commandOptions: CommandClientOptions

commands

commands: {}

Type declaration

Optional gatewayURL

gatewayURL: string

groupChannels

groupChannels: Collection<GroupChannel>

guildPrefixes

guildPrefixes: {}

Type declaration

  • [s: string]: string | string[]

guildShardMap

guildShardMap: {}

Type declaration

  • [s: string]: number

guilds

guilds: Collection<Guild>

lastConnect

lastConnect: number

lastReconnectDelay

lastReconnectDelay: number

notes

notes: {}

Type declaration

  • [s: string]: string

options

options: ClientOptions

Optional preReady

preReady: true

presence

presence: ClientPresence

privateChannelMap

privateChannelMap: {}

Type declaration

  • [s: string]: string

privateChannels

privateChannels: Collection<PrivateChannel>

ready

ready: boolean

reconnectAttempts

reconnectAttempts: number

relationships

relationships: Collection<Relationship>

requestHandler

requestHandler: RequestHandler

shards

shards: ShardManager

startTime

startTime: number

threadGuildMap

threadGuildMap: {}

Type declaration

  • [s: string]: string

unavailableGuilds

unavailableGuilds: Collection<UnavailableGuild>

uptime

uptime: number

user

user: ExtendedUser

userGuildSettings

userGuildSettings: {}

Type declaration

userSettings

userSettings: UserSettings

users

users: Collection<User>

voiceConnections

voiceConnections: VoiceConnectionManager<VoiceConnection>

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

acceptInvite

addGroupRecipient

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

  • Parameters

    • groupID: string
    • userID: string

    Returns Promise<void>

addGuildDiscoverySubcategory

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>

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): CommandClient

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns CommandClient

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>

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>

bulkEditCommandPermissions

bulkEditCommands

bulkEditGuildCommands

checkPrefix

closeVoiceConnection

  • closeVoiceConnection(guildID: string): void

connect

  • connect(): Promise<void>

  • Returns Promise<void>

createChannel

createChannelInvite

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>

createCommand

createGroupChannel

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

createGuild

createGuildCommand

createGuildEmoji

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

createGuildFromTemplate

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

  • Parameters

    • code: string
    • name: string
    • Optional icon: string

    Returns Promise<Guild>

createGuildSticker

createGuildTemplate

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

  • Parameters

    • guildID: string
    • name: string
    • Optional description: null | string

    Returns Promise<GuildTemplate>

createInteractionResponse

createMessage

createRole

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

  • Parameters

    • guildID: string
    • Optional options: RoleOptions
    • Optional reason: string

    Returns Promise<Role>

  • Parameters

    • guildID: string
    • Optional options: Role
    • Optional reason: string

    Returns Promise<Role>

createStageInstance

createThreadWithMessage

createThreadWithoutMessage

crosspostMessage

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>

deleteCommand

  • deleteCommand(commandID: string): Promise<void>

  • Parameters

    • commandID: string

    Returns Promise<void>

deleteGuild

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

  • Parameters

    • guildID: string

    Returns Promise<void>

deleteGuildCommand

  • deleteGuildCommand(guildID: string, commandID: string): Promise<void>

  • Parameters

    • guildID: string
    • commandID: 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>

deleteGuildSticker

  • deleteGuildSticker(guildID: string, stickerID: string, reason?: string): Promise<void>

  • Parameters

    • guildID: string
    • stickerID: string
    • Optional reason: string

    Returns Promise<void>

deleteGuildTemplate

  • deleteGuildTemplate(guildID: string, code: string): 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>

deleteStageInstance

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

  • Parameters

    • channelID: string

    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

editChannelPermission

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

  • Parameters

    • channelID: string
    • overwriteID: string
    • allow: number | bigint
    • deny: number | bigint
    • type: PermissionType
    • Optional reason: string

    Returns Promise<void>

editChannelPosition

editChannelPositions

  • editChannelPositions(guildID: string, channelPositions: ChannelPosition[]): Promise<void>

editCommand

editCommandPermissions

editGuild

  • Parameters

    • guildID: string
    • options: GuildOptions
    • Optional reason: string

    Returns Promise<Guild>

editGuildCommand

editGuildDiscovery

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>

editGuildMember

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

editGuildSticker

editGuildTemplate

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>

editGuildWelcomeScreen

editGuildWidget

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

editMessage

editNickname

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

    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

editStageInstance

editStatus

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

emit

  • emit<K>(event: K, ...args: ClientEvents[K]): boolean
  • emit(event: string, ...args: any[]): boolean

  • Type parameters

    Parameters

    Returns boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

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 }>

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

executeSlackWebhook

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

  • Parameters

    • webhookID: string
    • token: string
    • options: Record<string, unknown> & { auth?: boolean; threadID?: string }

    Returns Promise<void>

  • Parameters

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

    Returns Promise<Message<GuildTextableChannel>>

executeWebhook

followChannel

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

  • Parameters

    • channelID: string
    • webhookChannelID: string

    Returns Promise<ChannelFollow>

getActiveGuildThreads

getActiveThreads

getArchivedThreads

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

getChannelInvites

getChannelWebhooks

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

getCommand

getCommandPermissions

getCommands

getDMChannel

getDiscoveryCategories

getEmojiGuild

  • getEmojiGuild(emojiID: string): Promise<Guild>

  • Parameters

    • emojiID: string

    Returns Promise<Guild>

getGateway

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

  • Returns Promise<{ url: string }>

getGuildAuditLog

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<GuildBan>

  • Parameters

    • guildID: string
    • userID: string

    Returns Promise<GuildBan>

getGuildBans

getGuildCommand

getGuildCommandPermissions

getGuildCommands

getGuildDiscovery

getGuildEmbed

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

    Parameters

    • guildID: string

    Returns Promise<Widget>

getGuildIntegrations

getGuildInvites

getGuildPreview

getGuildTemplate

getGuildTemplates

getGuildVanity

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

getGuildWebhooks

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

getGuildWelcomeScreen

getGuildWidget

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

getGuildWidgetSettings

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

getInvite

  • Parameters

    • inviteID: string
    • Optional withCounts: false

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

  • Parameters

    • inviteID: string
    • withCounts: true

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

getJoinedPrivateArchivedThreads

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getMessage

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

    Returns Promise<User[]>

  • deprecated

    Parameters

    • channelID: string
    • messageID: string
    • reaction: string
    • Optional limit: number
    • Optional before: string
    • Optional after: string

    Returns Promise<User[]>

getMessages

getNitroStickerPacks

  • getNitroStickerPacks(): Promise<{ sticker_packs: StickerPack[] }>

getOAuthApplication

getPins

getPruneCount

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

getRESTChannel

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

getRESTGuild

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

  • Parameters

    • guildID: string
    • Optional withCounts: boolean

    Returns Promise<Guild>

getRESTGuildChannels

getRESTGuildEmoji

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

  • Parameters

    • guildID: string
    • emojiID: string

    Returns Promise<Emoji>

getRESTGuildEmojis

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

getRESTGuildMember

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

  • Parameters

    • guildID: string
    • memberID: string

    Returns Promise<Member>

getRESTGuildMembers

getRESTGuildRoles

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

  • Parameters

    • guildID: string

    Returns Promise<Role[]>

getRESTGuildSticker

  • getRESTGuildSticker(guildID: string, stickerID: string): Promise<Sticker>

getRESTGuildStickers

  • getRESTGuildStickers(guildID: string): Promise<Sticker[]>

getRESTGuilds

  • Parameters

    Returns Promise<Guild[]>

  • deprecated

    Parameters

    • Optional limit: number
    • Optional before: string
    • Optional after: string

    Returns Promise<Guild[]>

getRESTSticker

  • getRESTSticker(stickerID: string): Promise<Sticker>

  • Parameters

    • stickerID: string

    Returns Promise<Sticker>

getRESTUser

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

  • Parameters

    • userID: string

    Returns Promise<User>

getSelf

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

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

getStageInstance

getThreadMembers

  • getThreadMembers(channelID: string): Promise<ThreadMember[]>

getUserProfile

getVoiceRegions

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

getWebhook

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

  • Parameters

    • webhookID: string
    • Optional token: string

    Returns Promise<Webhook>

getWebhookMessage

joinThread

  • joinThread(channelID: string, userID?: string): Promise<void>

  • Parameters

    • channelID: string
    • Optional userID: string

    Returns Promise<void>

joinVoiceChannel

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>

leaveThread

  • leaveThread(channelID: string, userID?: string): Promise<void>

  • Parameters

    • channelID: string
    • Optional userID: string

    Returns Promise<void>

leaveVoiceChannel

  • leaveVoiceChannel(channelID: string): void

  • Parameters

    • channelID: string

    Returns void

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • Type parameters

    Parameters

    Returns CommandClient

  • Parameters

    • event: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns CommandClient

on

  • Type parameters

    Parameters

    Returns CommandClient

  • Parameters

    • event: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns CommandClient

onMessageCreate

onMessageReactionEvent

once

  • Type parameters

    Parameters

    Returns CommandClient

  • Parameters

    • event: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns CommandClient

pinMessage

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

  • Parameters

    • channelID: string
    • messageID: string

    Returns Promise<void>

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): CommandClient

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns CommandClient

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): CommandClient

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns CommandClient

pruneMembers

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>

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

registerCommand

registerCommandAlias

  • registerCommandAlias(alias: string, label: string): void

  • Parameters

    • alias: string
    • label: string

    Returns void

registerGuildPrefix

  • registerGuildPrefix(guildID: string, prefix: string | string[]): void

  • Parameters

    • guildID: string
    • prefix: string | string[]

    Returns void

removeAllListeners

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>

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): CommandClient

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns CommandClient

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>

resolveCommand

  • resolveCommand(label: string): Command

  • Parameters

    • label: string

    Returns Command

searchChannelMessages

searchGuildMembers

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

  • Parameters

    • guildID: string
    • query: string
    • Optional limit: number

    Returns Promise<Member[]>

searchGuildMessages

sendChannelTyping

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

  • Parameters

    • channelID: string

    Returns Promise<void>

setMaxListeners

syncGuildIntegration

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

  • Parameters

    • guildID: string
    • integrationID: string

    Returns Promise<void>

syncGuildTemplate

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

toString

  • toString(): string

  • Returns string

unbanGuildMember

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

  • Parameters

    • guildID: string
    • userID: string
    • Optional reason: string

    Returns Promise<void>

unpinMessage

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

  • Parameters

    • channelID: string
    • messageID: string

    Returns Promise<void>

unregisterCommand

  • unregisterCommand(label: string): void

  • Parameters

    • label: string

    Returns void

unwatchMessage

  • unwatchMessage(id: string, channelID: string): void

  • Parameters

    • id: string
    • channelID: string

    Returns void

validateDiscoverySearchTerm

  • validateDiscoverySearchTerm(term: string): Promise<{ valid: boolean }>

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Generated using TypeDoc