- Preparing search index...
- The search index is not available
HomeIntroGuide
Properties
readyData
readyData: { application: Camelize<RawApplicationData>; guilds: { id: string; unavailable?: boolean; }[]; resumeGatewayUrl: string; sessionId: string; shard: undefined | [number, number]; user: User; }
Type declaration
-
-
guilds: {
id: string;
unavailable?: boolean;
}[]
-
resumeGatewayUrl: string
-
sessionId: string
-
shard: undefined | [number, number]
-
Accessors
intents
- get intents(): number
-
Returns number
token
- get token(): `${string}.${string}.${string}`
-
Returns `${string}.${string}.${string}`
Methods
addGuildMember
- addGuildMember(guildId, userId, data): Promise<null | Member>
-
Parameters
-
guildId: bigint
-
userId: bigint
-
Returns Promise<null | Member>
addGuildMemberRole
- addGuildMemberRole(guildId, userId, roleId, reason?): Promise<null | Member>
-
Parameters
-
guildId: bigint
-
userId: bigint
-
roleId: bigint
-
Optional
reason: string
Returns Promise<null | Member>
addThreadMember
- addThreadMember(channelId, userId): Promise<any>
-
Parameters
-
channelId: bigint
-
userId: bigint
Returns Promise<any>
beginGuildPrune
- beginGuildPrune(guildId, data?, reason?): Promise<any>
-
Parameters
-
guildId: bigint
-
-
Optional
reason: string
Returns Promise<any>
bulkOverwriteGlobalApplicationCommands
bulkOverwriteGuildApplicationCommands
createAutoModerationRule
- createAutoModerationRule(guildId, data, reason?): Promise<any>
-
Parameters
-
guildId: bigint
-
-
Optional
reason: string
Returns Promise<any>
createChannelInvite
- createChannelInvite(channelId, data, reason?): Promise<Invite>
-
Parameters
-
channelId: bigint
-
-
Optional
reason: string
Returns Promise<Invite>
createFollowupMessage
- createFollowupMessage(token, data): Promise<any>
-
Returns Promise<any>
createGlobalApplicationCommand
createGuild
- createGuild(data): Promise<Guild>
-
Returns Promise<Guild>
createGuildApplicationCommand
createGuildBan
- createGuildBan(guildId, userId, data, reason?): Promise<boolean>
-
Parameters
-
guildId: bigint
-
userId: bigint
-
-
Optional
reason: string
Returns Promise<boolean>
createGuildChannel
- createGuildChannel(guildId, data): Promise<Channel>
-
Returns Promise<Channel>
createGuildEmoji
- createGuildEmoji(guildId, data): Promise<Emoji>
-
Returns Promise<Emoji>
createGuildRole
- createGuildRole(guildId, data): Promise<Role>
-
Returns Promise<Role>
createInteractionResponse
- createInteractionResponse(id, token, type, data?): Promise<void>
-
Returns Promise<void>
createMessage
- createMessage(channelId, data, reason?): Promise<Message>
-
Parameters
-
channelId: bigint
-
-
Optional
reason: string
Returns Promise<Message>
createReaction
- createReaction(channelId, messageId, emoji): Promise<any>
-
Parameters
-
channelId: bigint
-
messageId: bigint
-
emoji: string
Returns Promise<any>
crosspostMessage
- crosspostMessage(channelId, messageId, reason?): Promise<Message>
-
Parameters
-
channelId: bigint
-
messageId: bigint
-
Optional
reason: string
Returns Promise<Message>
deleteAllReactions
- deleteAllReactions(channelId, messageId): Promise<any>
-
Parameters
-
channelId: bigint
-
messageId: bigint
Returns Promise<any>
deleteAllReactionsForEmoji
- deleteAllReactionsForEmoji(channelId, messageId, emoji): Promise<any>
-
Parameters
-
channelId: bigint
-
messageId: bigint
-
emoji: string
Returns Promise<any>
deleteAutoModerationRule
- deleteAutoModerationRule(guildId, ruleId, reason?): Promise<any>
-
Parameters
-
guildId: bigint
-
ruleId: bigint
-
Optional
reason: string
Returns Promise<any>
deleteBulkMessages
- deleteBulkMessages(channelId, messageIds, reason?): Promise<any>
-
Parameters
-
channelId: bigint
-
messageIds: bigint[]
-
Optional
reason: string
Returns Promise<any>
deleteChannel
- deleteChannel(channelId, reason?): Promise<any>
-
Parameters
-
channelId: bigint
-
Optional
reason: string
Returns Promise<any>
deleteChannelPermission
- deleteChannelPermission(channelId, overwriteId, reason?): Promise<any>
-
Parameters
-
channelId: bigint
-
overwriteId: bigint
-
Optional
reason: string
Returns Promise<any>
deleteFollowupMessage
- deleteFollowupMessage(token, messageId): Promise<void>
-
Parameters
-
token: string
-
messageId: bigint
Returns Promise<void>
deleteGlobalApplicationCommand
- deleteGlobalApplicationCommand(commandId): Promise<void>
-
Returns Promise<void>
deleteGuild
- deleteGuild(guildId): Promise<boolean>
-
Returns Promise<boolean>
deleteGuildApplicationCommand
- deleteGuildApplicationCommand(guildId, commandId): Promise<void>
-
Parameters
-
guildId: bigint
-
commandId: bigint
Returns Promise<void>
deleteGuildEmoji
- deleteGuildEmoji(guildId, emojiId): Promise<boolean>
-
Parameters
-
guildId: bigint
-
emojiId: bigint
Returns Promise<boolean>
deleteGuildIntegration
- deleteGuildIntegration(guildId, integrationId, reason?): Promise<boolean>
-
Parameters
-
guildId: bigint
-
integrationId: bigint
-
Optional
reason: string
Returns Promise<boolean>
deleteGuildRole
- deleteGuildRole(guildId, roleId, reason?): Promise<boolean>
-
Parameters
-
guildId: bigint
-
roleId: bigint
-
Optional
reason: string
Returns Promise<boolean>
deleteMessage
- deleteMessage(channelId, messageId, reason?): Promise<any>
-
Parameters
-
channelId: bigint
-
messageId: bigint
-
Optional
reason: string
Returns Promise<any>
deleteOriginalInteractionResponse
- deleteOriginalInteractionResponse(token): Promise<void>
-
Returns Promise<void>
deleteOwnReaction
- deleteOwnReaction(channelId, messageId, emoji): Promise<any>
-
Parameters
-
channelId: bigint
-
messageId: bigint
-
emoji: string
Returns Promise<any>
deleteReaction
- deleteReaction(channelId, messageId, userId, emoji): Promise<any>
-
Parameters
-
channelId: bigint
-
messageId: bigint
-
userId: bigint
-
emoji: string
Returns Promise<any>
editChannelPermissions
- editChannelPermissions(channelId, overwriteId, data, reason?): Promise<any>
-
Parameters
-
channelId: bigint
-
overwriteId: bigint
-
-
Optional
reason: string
Returns Promise<any>
editFollowupMessage
- editFollowupMessage(token, messageId, data): Promise<any>
-
Parameters
-
token: string
-
messageId: bigint
-
Returns Promise<any>
editGlobalApplicationCommand
editGuildApplicationCommand
- editGuildApplicationCommand(guildId, commandId, data): Promise<undefined | Camelize<RawApplicationData>>
-
Parameters
-
guildId: bigint
-
commandId: bigint
-
editMessage
- editMessage(channelId, messageId, data): Promise<Message>
-
Parameters
-
channelId: bigint
-
messageId: bigint
-
Returns Promise<Message>
editOriginalInteractionResponse
- editOriginalInteractionResponse(token, data): Promise<Message>
-
Returns Promise<Message>
emit
- emit(event, ...args): void
-
Returns void
followAnnouncementChannel
- followAnnouncementChannel(channelId, webhookChannelId): Promise<any>
-
Parameters
-
channelId: bigint
-
webhookChannelId: bigint
Returns Promise<any>
getApplicationCommandPermissions
getApplicationRoleConnectionMetadataRecords
- getApplicationRoleConnectionMetadataRecords(appId?): Promise<any>
-
Returns Promise<any>
getAutoModerationRule
- getAutoModerationRule(guildId, ruleId): Promise<any>
-
Parameters
-
guildId: bigint
-
ruleId: bigint
Returns Promise<any>
getChannelInvites
- getChannelInvites(channelId): Promise<any>
-
Returns Promise<any>
getChannelMessage
- getChannelMessage(channelId, messageId): Promise<Message>
-
Parameters
-
channelId: bigint
-
messageId: bigint
Returns Promise<Message>
getChannelMessages
- getChannelMessages(channelId, options?): Promise<Message[]>
-
Returns Promise<Message[]>
getFollowupMessage
- getFollowupMessage(token, messageId): Promise<any>
-
Parameters
-
token: string
-
messageId: bigint
Returns Promise<any>
getGlobalApplicationCommand
getGlobalApplicationCommands
- getGlobalApplicationCommands(withLocalization?): Promise<Camelize<RawApplicationData>[]>
-
Parameters
-
Optional
withLocalization: boolean
getGuild
- getGuild(guildId): Promise<Guild>
-
Returns Promise<Guild>
getGuildApplicationCommand
- getGuildApplicationCommand(guildId, commandId): Promise<undefined | Camelize<RawApplicationData>>
-
Parameters
-
guildId: bigint
-
commandId: bigint
getGuildApplicationCommandPermissions
getGuildApplicationCommands
- getGuildApplicationCommands(guildId, withLocalization?): Promise<Camelize<RawApplicationData>[]>
-
Parameters
-
guildId: bigint
-
Optional
withLocalization: boolean
getGuildAuditLogs
- getGuildAuditLogs(guildId): Promise<any>
-
Returns Promise<any>
getGuildBan
- getGuildBan(guildId, userId): Promise<null | {
reason: any;
user: User;
}>
-
Parameters
-
guildId: bigint
-
userId: bigint
Returns Promise<null | {
reason: any;
user: User;
}>
getGuildBans
- getGuildBans(guildId): Promise<any>
-
Returns Promise<any>
getGuildChannels
- getGuildChannels(guildId): Promise<any>
-
Returns Promise<any>
getGuildEmoji
- getGuildEmoji(guildId, emojiId): Promise<Emoji>
-
Parameters
-
guildId: bigint
-
emojiId: bigint
Returns Promise<Emoji>
getGuildIntegrations
- getGuildIntegrations(guildId): Promise<any>
-
Returns Promise<any>
getGuildInvites
- getGuildInvites(guildId): Promise<any>
-
Returns Promise<any>
getGuildMember
- getGuildMember(guildId, userId): Promise<Member>
-
Parameters
-
guildId: bigint
-
userId: bigint
Returns Promise<Member>
getGuildOnBoarding
- getGuildOnBoarding(guildId): Promise<any>
-
Returns Promise<any>
getGuildPreview
- getGuildPreview(guildId): Promise<any>
-
Returns Promise<any>
getGuildPruneCount
- getGuildPruneCount(guildId, data?): Promise<any>
-
Returns Promise<any>
getGuildRoles
- getGuildRoles(guildId): Promise<any>
-
Returns Promise<any>
getGuildVanityUrl
- getGuildVanityUrl(guildId): Promise<any>
-
Returns Promise<any>
getGuildVoiceRegions
- getGuildVoiceRegions(guildId): Promise<any>
-
Returns Promise<any>
getGuildWelcomeScreen
- getGuildWelcomeScreen(guildId): Promise<any>
-
Returns Promise<any>
getGuildWidget
- getGuildWidget(guildId): Promise<any>
-
Returns Promise<any>
getGuildWidgetImage
- getGuildWidgetImage(guildId, style?): Promise<any>
-
Returns Promise<any>
getGuildWidgetSettings
- getGuildWidgetSettings(guildId): Promise<any>
-
Returns Promise<any>
getOriginalInteractionResponse
- getOriginalInteractionResponse(token): Promise<Message>
-
Returns Promise<Message>
getPinnedMessages
- getPinnedMessages(channelId): Promise<any>
-
Returns Promise<any>
getReactions
- getReactions(channelId, messageId, emoji, options?): Promise<User[]>
-
Parameters
-
channelId: bigint
-
messageId: bigint
-
emoji: string
-
Optional
options: {
after?: bigint;
limit?: number;
}
-
Optional
after?: bigint
-
Optional
limit?: number
Returns Promise<User[]>
getThreadMember
- getThreadMember(channelId, userId, withMember?): Promise<{
flags: any;
id: bigint;
joinTimestamp: Date;
member: null | Member;
userId: bigint;
}>
-
Parameters
-
channelId: bigint
-
userId: bigint
-
withMember: boolean = true
Returns Promise<{
flags: any;
id: bigint;
joinTimestamp: Date;
member: null | Member;
userId: bigint;
}>
getUrlFromHash
- getUrlFromHash(hash, type, size?, format?, dynamic?): string
-
Parameters
-
hash: string
-
type: "icon" | "avatar" | "banner" | "splash"
-
-
-
dynamic: boolean = true
Returns string
getUser
- getUser(userId): Promise<User>
-
Returns Promise<User>
groupDMAddRecipient
- groupDMAddRecipient(channelId, userId, data): Promise<any>
-
Parameters
-
channelId: bigint
-
userId: bigint
-
Returns Promise<any>
groupDMRemoveRecipient
- groupDMRemoveRecipient(channelId, userId): Promise<any>
-
Parameters
-
channelId: bigint
-
userId: bigint
Returns Promise<any>
joinThread
- joinThread(channelId): Promise<any>
-
Returns Promise<any>
leaveThread
- leaveThread(channelId): Promise<any>
-
Returns Promise<any>
listActiveGuildThreads
- listActiveGuildThreads(guildId): Promise<any>
-
Returns Promise<any>
listAutoModerationRules
- listAutoModerationRules(guildId): Promise<any>
-
Returns Promise<any>
listGuildEmojis
- listGuildEmojis(guildId): Promise<any>
-
Returns Promise<any>
listGuildMembers
- listGuildMembers(guildId, data?): Promise<any>
-
Returns Promise<any>
listJoinedPrivateArchivedThreads
- listJoinedPrivateArchivedThreads(channelId, data?): Promise<{
hasMore: any;
members: any;
threads: any;
}>
-
Returns Promise<{
hasMore: any;
members: any;
threads: any;
}>
listPrivateArchivedThreads
- listPrivateArchivedThreads(channelId, data?): Promise<{
hasMore: any;
members: any;
threads: any;
}>
-
Returns Promise<{
hasMore: any;
members: any;
threads: any;
}>
listPublicArchivedThreads
- listPublicArchivedThreads(channelId, data?): Promise<{
hasMore: any;
members: any;
threads: any;
}>
-
Returns Promise<{
hasMore: any;
members: any;
threads: any;
}>
listThreadMembers
- listThreadMembers(channelId, includeGuildMember?): Promise<any>
-
Parameters
-
channelId: bigint
-
Optional
includeGuildMember: boolean
Returns Promise<any>
modifyCurrentUserNick
- modifyCurrentUserNick(guildId, nick?, reason?): Promise<null | Member>
-
Parameters
-
guildId: bigint
-
Optional
nick: string
-
Optional
reason: string
Returns Promise<null | Member>
modifyCurrentUserVoiceState
- modifyCurrentUserVoiceState(guildId, data): Promise<any>
-
Returns Promise<any>
modifyGuild
- modifyGuild(guildId, data, reason?): Promise<Guild>
-
Parameters
-
guildId: bigint
-
-
Optional
reason: string
Returns Promise<Guild>
modifyGuildChannelPositions
- modifyGuildChannelPositions(guildId, data): Promise<void>
-
Returns Promise<void>
modifyGuildEmoji
- modifyGuildEmoji(guildId, emojiId, data): Promise<Emoji>
-
Parameters
-
guildId: bigint
-
emojiId: bigint
-
Returns Promise<Emoji>
modifyGuildMFALevel
- modifyGuildMFALevel(guildId, level, reason?): Promise<Guild>
-
Parameters
-
guildId: bigint
-
-
Optional
reason: string
Returns Promise<Guild>
modifyGuildMember
- modifyGuildMember(guildId, userId, data): Promise<null | Member>
-
Parameters
-
guildId: bigint
-
userId: bigint
-
Returns Promise<null | Member>
modifyGuildRole
- modifyGuildRole(guildId, roleId, data, reason?): Promise<Role>
-
Parameters
-
guildId: bigint
-
roleId: bigint
-
-
Optional
reason: string
Returns Promise<Role>
modifyGuildRolePositions
- modifyGuildRolePositions(guildId, roleId, position, reason?): Promise<Role>
-
Parameters
-
guildId: bigint
-
roleId: bigint
-
position: number
-
Optional
reason: string
Returns Promise<Role>
modifyGuildWelcomeScreen
- modifyGuildWelcomeScreen(guildId, data, reason?): Promise<any>
-
Parameters
-
guildId: bigint
-
-
Optional
reason: string
Returns Promise<any>
modifyGuildWidget
- modifyGuildWidget(guildId, data, reason?): Promise<any>
-
Parameters
-
guildId: bigint
-
-
Optional
reason: string
Returns Promise<any>
modifyUserVoiceState
- modifyUserVoiceState(guildId, userId, data): Promise<any>
-
Parameters
-
guildId: bigint
-
userId: bigint
-
Returns Promise<any>
on
- on<T>(event, callback): void
-
Returns void
pinMessage
- pinMessage(channelId, messageId, reason?): Promise<any>
-
Parameters
-
channelId: bigint
-
messageId: bigint
-
Optional
reason: string
Returns Promise<any>
removeGuildBan
- removeGuildBan(guildId, userId, reason?): Promise<boolean>
-
Parameters
-
guildId: bigint
-
userId: bigint
-
Optional
reason: string
Returns Promise<boolean>
removeGuildMember
- removeGuildMember(guildId, userId, reason?): Promise<boolean>
-
Parameters
-
guildId: bigint
-
userId: bigint
-
Optional
reason: string
Returns Promise<boolean>
removeGuildMemberRole
- removeGuildMemberRole(guildId, userId, roleId, reason?): Promise<null | Member>
-
Parameters
-
guildId: bigint
-
userId: bigint
-
roleId: bigint
-
Optional
reason: string
Returns Promise<null | Member>
removeThreadMember
- removeThreadMember(channelId, userId): Promise<any>
-
Parameters
-
channelId: bigint
-
userId: bigint
Returns Promise<any>
searchGuildMembers
- searchGuildMembers(guildId, data): Promise<any>
-
Returns Promise<any>
startThreadFromMessage
- startThreadFromMessage(channelId, messageId, data, reason?): Promise<Channel>
-
Parameters
-
channelId: bigint
-
messageId: bigint
-
-
Optional
reason: string
Returns Promise<Channel>
startThreadInForum
- startThreadInForum(channelId, data, reason?): Promise<Channel>
-
Parameters
-
channelId: bigint
-
-
Optional
reason: string
Returns Promise<Channel>
startThreadWithoutMessage
- startThreadWithoutMessage(channelId, data, reason?): Promise<Channel>
-
Parameters
-
channelId: bigint
-
-
Optional
reason: string
Returns Promise<Channel>
triggerTypingIndicator
- triggerTypingIndicator(channelId): Promise<any>
-
Returns Promise<any>
unpinMessage
- unpinMessage(channelId, messageId, reason?): Promise<any>
-
Parameters
-
channelId: bigint
-
messageId: bigint
-
Optional
reason: string
Returns Promise<any>
updateApplicationRoleConnectionMetadataRecords
- updateApplicationRoleConnectionMetadataRecords(data, appId?): Promise<any>
-
Returns Promise<any>
updateAutoModerationRule
- updateAutoModerationRule(guildId, ruleId, data, reason?): Promise<any>
-
Parameters
-
guildId: bigint
-
ruleId: bigint
-
-
Optional
reason: string
Returns Promise<any>
updateChannel
- updateChannel(channelId, data, reason?): Promise<any>
-
Parameters
-
channelId: bigint
-
-
Optional
reason: string
Returns Promise<any>
Guild