Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • EventSpewer
    • Client

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

authType

authType: AuthTypes = ...

Readonly buckets

clientsideChecks

clientsideChecks: boolean = true

errorOnRatelimit

errorOnRatelimit: boolean = false

Optional fingerprint

fingerprint: string

globalBucket

globalBucket: Bucket

restClient

restClient: Client

Readonly routes

routes: BaseCollection<string, string>

Optional token

token: string

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.

Accessors

authTypeText

  • get authTypeText(): string

isBearer

  • get isBearer(): boolean

isBot

  • get isBot(): boolean

isUser

  • get isUser(): boolean

tokenFormatted

  • get tokenFormatted(): string

Methods

acceptAgreements

  • acceptAgreements(privacy?: boolean, terms?: boolean): Promise<any>
  • Parameters

    • privacy: boolean = true
    • terms: boolean = true

    Returns Promise<any>

acceptInvite

  • acceptInvite(code: string): Promise<any>

acceptTeamInvite

  • acceptTeamInvite(token: string): Promise<any>

acceptTemplate

  • acceptTemplate(templateId: string, options: AcceptTemplate): Promise<any>

ackChannelMessage

  • ackChannelMessage(channelId: string, messageId: string, token: string): Promise<any>
  • Parameters

    • channelId: string
    • messageId: string
    • token: string

    Returns Promise<any>

ackChannelPins

  • ackChannelPins(channelId: string): Promise<any>

ackGuild

  • ackGuild(guildId: string): Promise<any>

activateOauth2ApplicationLicense

addConnection

  • addConnection(platform: string, accountId: string, options: AddConnection): Promise<any>

addGuildMember

  • addGuildMember(guildId: string, userId: string, options: AddGuildMember): Promise<any>

addGuildMemberRole

  • addGuildMemberRole(guildId: string, userId: string, roleId: string, options?: AddGuildMemberRole): Promise<any>

addListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns Client

addOauth2ApplicationWhitelistUser

addPinnedMessage

  • addPinnedMessage(channelId: string, messageId: string): Promise<any>
  • Parameters

    • channelId: string
    • messageId: string

    Returns Promise<any>

addRecipient

  • addRecipient(channelId: string, userId: string): Promise<any>
  • Parameters

    • channelId: string
    • userId: string

    Returns Promise<any>

addTeamMember

  • addTeamMember(teamId: string, options: AddTeamMember): Promise<any>

addThreadMember

  • addThreadMember(channelId: string, userId: string): Promise<any>
  • Parameters

    • channelId: string
    • userId: string

    Returns Promise<any>

authorizeIpAddress

beginGuildPrune

  • beginGuildPrune(guildId: string, options?: BeginGuildPrune): Promise<any>

bulkDeleteMessages

  • bulkDeleteMessages(channelId: string, messageIds: string[]): Promise<any>
  • Parameters

    • channelId: string
    • messageIds: string[]

    Returns Promise<any>

bulkOverwriteApplicationCommands

bulkOverwriteApplicationGuildCommands

bulkOverwriteApplicationGuildCommandsPermissions

connectionCallback

createApplicationCommand

createApplicationGuildCommand

  • createApplicationGuildCommand(applicationId: string, guildId: string, options: CreateApplicationCommand): Promise<any>

createApplicationNews

createChannelInvite

createChannelMessageThread

createChannelStoreListingGrantEntitlement

  • createChannelStoreListingGrantEntitlement(channelId: string): Promise<any>

createChannelThread

createDm

  • createDm(options?: CreateDm): Promise<any>

createGuild

createGuildBan

  • createGuildBan(guildId: string, userId: string, options?: CreateGuildBan): Promise<any>

createGuildChannel

createGuildEmoji

createGuildIntegration

createGuildRole

  • createGuildRole(guildId: string, options?: CreateGuildRole): Promise<any>

createGuildTemplate

createInteractionResponse

createLobby

  • createLobby(applicationId: string, options?: CreateLobby): Promise<any>

createMeBillingPaymentSource

createMeBillingSubscription

createMessage

  • createMessage(channelId: string, options?: string | CreateMessage): Promise<any>

createOauth2Application

createOauth2ApplicationAsset

createOauth2ApplicationBot

  • createOauth2ApplicationBot(applicationId: string): Promise<any>

createReaction

  • createReaction(channelId: string, messageId: string, emoji: string): Promise<any>
  • Parameters

    • channelId: string
    • messageId: string
    • emoji: string

    Returns Promise<any>

createStageInstance

createStoreApplicationAsset

createTeam

createWebhook

  • createWebhook(channelId: string, options: CreateWebhook): Promise<any>

crosspostMessage

  • crosspostMessage(channelId: string, messageId: string): Promise<any>
  • Parameters

    • channelId: string
    • messageId: string

    Returns Promise<any>

delete

  • delete(info: string | URL | Options, init?: Options): Promise<Response>

deleteAccount

deleteApplicationCommand

  • deleteApplicationCommand(applicationId: string, commandId: string): Promise<any>
  • Parameters

    • applicationId: string
    • commandId: string

    Returns Promise<any>

deleteApplicationGuildCommand

  • deleteApplicationGuildCommand(applicationId: string, guildId: string, commandId: string): Promise<any>
  • Parameters

    • applicationId: string
    • guildId: string
    • commandId: string

    Returns Promise<any>

deleteChannel

  • deleteChannel(channelId: string, options?: DeleteChannel): Promise<any>

deleteChannelOverwrite

  • deleteChannelOverwrite(channelId: string, overwriteId: string, options?: DeleteChannelOverwrite): Promise<any>

deleteConnection

  • deleteConnection(platform: string, accountId: string): Promise<any>
  • Parameters

    • platform: string
    • accountId: string

    Returns Promise<any>

deleteGuild

  • deleteGuild(guildId: string, options?: DeleteGuild): Promise<any>

deleteGuildEmoji

  • deleteGuildEmoji(guildId: string, emojiId: string, options?: DeleteGuildEmoji): Promise<any>

deleteGuildIntegration

  • deleteGuildIntegration(guildId: string, integrationId: string, options?: DeleteGuildIntegration): Promise<any>

deleteGuildPremiumSubscription

  • deleteGuildPremiumSubscription(guildId: string, subscriptionId: string): Promise<any>
  • Parameters

    • guildId: string
    • subscriptionId: string

    Returns Promise<any>

deleteGuildRole

  • deleteGuildRole(guildId: string, roleId: string, options?: DeleteGuildRole): Promise<any>

deleteGuildTemplate

  • deleteGuildTemplate(guildId: string, templateId: string): Promise<any>
  • Parameters

    • guildId: string
    • templateId: string

    Returns Promise<any>

deleteInvite

  • deleteInvite(code: string, options?: DeleteInvite): Promise<any>

deleteLobby

  • deleteLobby(lobbyId: string): Promise<any>

deleteMeBillingPaymentSource

  • deleteMeBillingPaymentSource(paymentSourceId: string): Promise<any>

deleteMeBillingSubscription

  • deleteMeBillingSubscription(subscriptionId: string): Promise<any>

deleteMessage

  • deleteMessage(channelId: string, messageId: string, options?: DeleteMessage): Promise<any>

deleteOauth2Application

deleteOauth2ApplicationAsset

  • deleteOauth2ApplicationAsset(applicationId: string, assetId: string): Promise<any>
  • Parameters

    • applicationId: string
    • assetId: string

    Returns Promise<any>

deletePinnedMessage

  • deletePinnedMessage(channelId: string, messageId: string): Promise<any>
  • Parameters

    • channelId: string
    • messageId: string

    Returns Promise<any>

deleteReaction

  • deleteReaction(channelId: string, messageId: string, emoji: string, userId?: string): Promise<any>
  • Parameters

    • channelId: string
    • messageId: string
    • emoji: string
    • userId: string = '@me'

    Returns Promise<any>

deleteReactions

  • deleteReactions(channelId: string, messageId: string): Promise<any>
  • Parameters

    • channelId: string
    • messageId: string

    Returns Promise<any>

deleteReactionsEmoji

  • deleteReactionsEmoji(channelId: string, messageId: string, emoji: string): Promise<any>
  • Parameters

    • channelId: string
    • messageId: string
    • emoji: string

    Returns Promise<any>

deleteRelationship

  • deleteRelationship(userId: string): Promise<any>

deleteStageInstance

  • deleteStageInstance(channelId: string): Promise<any>

deleteStoreApplicationAsset

  • deleteStoreApplicationAsset(applicationId: string, assetId: string): Promise<any>
  • Parameters

    • applicationId: string
    • assetId: string

    Returns Promise<any>

deleteTeam

  • deleteTeam(teamId: string, options?: DeleteTeam): Promise<any>

deleteWebhook

  • deleteWebhook(webhookId: string, options?: DeleteWebhook): Promise<any>

deleteWebhookToken

  • deleteWebhookToken(webhookId: string, webhookToken: string, options?: DeleteWebhook): Promise<any>

deleteWebhookTokenMessage

  • deleteWebhookTokenMessage(webhookId: string, webhookToken: string, messageId: string): Promise<any>
  • Parameters

    • webhookId: string
    • webhookToken: string
    • messageId: string

    Returns Promise<any>

disableAccount

editApplicationCommand

  • editApplicationCommand(applicationId: string, commandId: string, options?: EditApplicationCommand): Promise<any>

editApplicationGuildCommand

  • editApplicationGuildCommand(applicationId: string, guildId: string, commandId: string, options?: EditApplicationGuildCommand): Promise<any>

editApplicationGuildCommandPermissions

editApplicationNews

editChannel

  • editChannel(channelId: string, options?: EditChannel): Promise<any>

editChannelOverwrite

  • editChannelOverwrite(channelId: string, overwriteId: string, options?: EditChannelOverwrite): Promise<any>

editConnection

  • editConnection(platform: string, accountId: string, options?: EditConnection): Promise<any>

editGuild

  • editGuild(guildId: string, options?: EditGuild): Promise<any>

editGuildChannels

editGuildEmbed

  • editGuildEmbed(guildId: string, options: EditGuildEmbed): Promise<any>

editGuildEmoji

  • editGuildEmoji(guildId: string, emojiId: string, options?: EditGuildEmoji): Promise<any>

editGuildIntegration

  • editGuildIntegration(guildId: string, integrationId: string, options?: EditGuildIntegration): Promise<any>

editGuildMember

  • editGuildMember(guildId: string, userId: string, options?: EditGuildMember): Promise<any>

editGuildMemberVerification

editGuildMfaLevel

editGuildNick

  • editGuildNick(guildId: string, nick: string, options?: EditGuildNick): Promise<any>

editGuildRole

  • editGuildRole(guildId: string, roleId: string, options?: EditGuildRole): Promise<any>

editGuildRolePositions

editGuildVanity

  • editGuildVanity(guildId: string, code: string, options?: EditGuildVanity): Promise<any>

editGuildVoiceState

  • editGuildVoiceState(guildId: string, userId?: string, options: EditGuildVoiceState): Promise<any>

editLobby

  • editLobby(lobbyId: string, options?: EditLobby): Promise<any>

editLobbyMember

  • editLobbyMember(lobbyId: string, userId: string, options?: EditLobbyMember): Promise<any>

editMe

  • editMe(options?: EditMe): Promise<any>

editMeBillingPaymentSource

editMeBillingSubscription

editMessage

  • editMessage(channelId: string, messageId: string, options?: string | EditMessage): Promise<any>

editNote

  • editNote(userId: string, note: string): Promise<any>
  • Parameters

    • userId: string
    • note: string

    Returns Promise<any>

editOauth2Application

editRelationship

  • editRelationship(userId: string, type: number): Promise<any>
  • Parameters

    • userId: string
    • type: number

    Returns Promise<any>

editSettings

editStageInstance

editTeam

  • editTeam(teamId: string, options?: EditTeam): Promise<any>

editUser

  • editUser(options?: EditMe): Promise<any>

editWebhook

  • editWebhook(webhookId: string, options?: EditWebhook): Promise<any>

editWebhookToken

  • editWebhookToken(webhookId: string, webhookToken: string, options?: EditWebhook): Promise<any>

editWebhookTokenMessage

  • editWebhookTokenMessage(webhookId: string, webhookToken: string, messageId: string, options?: string | EditWebhookTokenMessage): Promise<any>

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

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

    Returns boolean

enableOauth2ApplicationAssets

  • enableOauth2ApplicationAssets(applicationId: string): Promise<any>

enableOauth2ApplicationRpc

  • enableOauth2ApplicationRpc(applicationId: string): Promise<any>

eventNames

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

executeWebhook

  • executeWebhook(webhookId: string, webhookToken: string, options?: string | ExecuteWebhook, compatibleType?: string): Promise<any>
  • Parameters

    • webhookId: string
    • webhookToken: string
    • options: string | ExecuteWebhook = {}
    • Optional compatibleType: string

    Returns Promise<any>

fetchActivities

  • fetchActivities(): Promise<any>

fetchApplication

  • fetchApplication(applicationId: string): Promise<any>

fetchApplicationCommand

  • fetchApplicationCommand(applicationId: string, commandId: string): Promise<any>
  • Parameters

    • applicationId: string
    • commandId: string

    Returns Promise<any>

fetchApplicationCommands

  • fetchApplicationCommands(applicationId: string): Promise<any>

fetchApplicationGuildCommand

  • fetchApplicationGuildCommand(applicationId: string, guildId: string, commandId: string): Promise<any>
  • Parameters

    • applicationId: string
    • guildId: string
    • commandId: string

    Returns Promise<any>

fetchApplicationGuildCommandPermissions

  • fetchApplicationGuildCommandPermissions(applicationId: string, guildId: string, commandId: string): Promise<any>
  • Parameters

    • applicationId: string
    • guildId: string
    • commandId: string

    Returns Promise<any>

fetchApplicationGuildCommands

  • fetchApplicationGuildCommands(applicationId: string, guildId: string): Promise<any>
  • Parameters

    • applicationId: string
    • guildId: string

    Returns Promise<any>

fetchApplicationGuildCommandsPermissions

  • fetchApplicationGuildCommandsPermissions(applicationId: string, guildId: string): Promise<any>
  • Parameters

    • applicationId: string
    • guildId: string

    Returns Promise<any>

fetchApplicationNews

  • fetchApplicationNews(applicationIds?: string | string[]): Promise<any>
  • Parameters

    • Optional applicationIds: string | string[]

    Returns Promise<any>

fetchApplicationNewsId

  • fetchApplicationNewsId(newsId: string): Promise<any>

fetchApplications

  • fetchApplications(): Promise<any>

fetchApplicationsDetectable

  • fetchApplicationsDetectable(): Promise<any>

fetchApplicationsPublic

  • fetchApplicationsPublic(applicationIds: string | string[]): Promise<any>
  • Parameters

    • applicationIds: string | string[]

    Returns Promise<any>

fetchApplicationsTrendingGlobal

  • fetchApplicationsTrendingGlobal(): Promise<any>

fetchAuthConsentRequired

  • fetchAuthConsentRequired(): Promise<any>

fetchChannel

  • fetchChannel(channelId: string): Promise<any>

fetchChannelCall

  • fetchChannelCall(channelId: string): Promise<any>

fetchChannelInvites

  • fetchChannelInvites(channelId: string): Promise<any>

fetchChannelStoreListing

  • fetchChannelStoreListing(channelId: string): Promise<any>

fetchChannelThreadsActive

  • fetchChannelThreadsActive(channelId: string): Promise<any>

fetchChannelThreadsArchivedPrivate

fetchChannelThreadsArchivedPrivateJoined

fetchChannelThreadsArchivedPublic

fetchChannelWebhooks

  • fetchChannelWebhooks(channelId: string): Promise<any>

fetchConnectionAuthorizeUrl

  • fetchConnectionAuthorizeUrl(platform: string): Promise<any>

fetchConsentRequired

  • fetchConsentRequired(): Promise<any>

fetchDiscoverableGuilds

  • fetchDiscoverableGuilds(): Promise<any>

fetchDms

  • fetchDms(userId?: string): Promise<any>

fetchEmojiGuild

  • fetchEmojiGuild(emojiId: string): Promise<any>

fetchExperiments

  • fetchExperiments(fingerprint?: string): Promise<any>
  • Parameters

    • Optional fingerprint: string

    Returns Promise<any>

fetchGateway

  • fetchGateway(): Promise<any>

fetchGatewayBot

  • fetchGatewayBot(): Promise<any>

fetchGiftCode

  • fetchGiftCode(code: string, options?: FetchGiftCode): Promise<any>

fetchGuild

  • fetchGuild(guildId: string, options?: FetchGuild): Promise<any>

fetchGuildApplications

  • fetchGuildApplications(guildId: string, channelId?: string): Promise<any>
  • Parameters

    • guildId: string
    • Optional channelId: string

    Returns Promise<any>

fetchGuildAuditLogs

fetchGuildBans

  • fetchGuildBans(guildId: string): Promise<any>

fetchGuildChannels

  • fetchGuildChannels(guildId: string): Promise<any>

fetchGuildEmbed

  • fetchGuildEmbed(guildId: string): Promise<any>

fetchGuildEmoji

  • fetchGuildEmoji(guildId: string, emojiId: string): Promise<any>
  • Parameters

    • guildId: string
    • emojiId: string

    Returns Promise<any>

fetchGuildEmojis

  • fetchGuildEmojis(guildId: string): Promise<any>

fetchGuildIntegrations

  • fetchGuildIntegrations(guildId: string): Promise<any>

fetchGuildInvites

  • fetchGuildInvites(guildId: string): Promise<any>

fetchGuildMember

  • fetchGuildMember(guildId: string, userId: string): Promise<any>
  • Parameters

    • guildId: string
    • userId: string

    Returns Promise<any>

fetchGuildMemberVerification

  • fetchGuildMemberVerification(guildId: string): Promise<any>

fetchGuildMembers

fetchGuildMembersSearch

fetchGuildPremiumSubscriptions

  • fetchGuildPremiumSubscriptions(guildId: string): Promise<any>

fetchGuildPreview

  • fetchGuildPreview(guildId: string): Promise<any>

fetchGuildPruneCount

fetchGuildRoles

  • fetchGuildRoles(guildId: string): Promise<any>

fetchGuildTemplates

  • fetchGuildTemplates(guildId: string): Promise<any>

fetchGuildVanityUrl

  • fetchGuildVanityUrl(guildId: string): Promise<any>

fetchGuildWebhooks

  • fetchGuildWebhooks(guildId: string): Promise<any>

fetchGuildWidget

  • fetchGuildWidget(guildId: string): Promise<any>

fetchGuildWidgetJson

  • fetchGuildWidgetJson(guildId: string): Promise<any>

fetchGuildWidgetPng

fetchInvite

  • fetchInvite(code: string, options?: FetchInvite): Promise<any>

fetchMe

  • fetchMe(options?: FetchMe): Promise<any>

fetchMeBillingPaymentSources

  • fetchMeBillingPaymentSources(): Promise<any>

fetchMeBillingPayments

fetchMeBillingSubscriptions

  • fetchMeBillingSubscriptions(): Promise<any>

fetchMeChannels

  • fetchMeChannels(): Promise<any>

fetchMeConnectionAccessToken

  • fetchMeConnectionAccessToken(platform: string, accountId: string): Promise<any>
  • Parameters

    • platform: string
    • accountId: string

    Returns Promise<any>

fetchMeConnectionSubreddits

  • fetchMeConnectionSubreddits(accountId: string): Promise<any>

fetchMeConnections

  • fetchMeConnections(): Promise<any>

fetchMeFeedSettings

fetchMeGuilds

fetchMeStickerPacks

  • fetchMeStickerPacks(countryCode?: string): Promise<any>
  • Parameters

    • Optional countryCode: string

    Returns Promise<any>

fetchMentions

fetchMessage

  • fetchMessage(channelId: string, messageId: string): Promise<any>
  • Parameters

    • channelId: string
    • messageId: string

    Returns Promise<any>

fetchMessages

  • fetchMessages(channelId: string, options?: FetchMessages): Promise<any>

fetchOauth2Application

  • fetchOauth2Application(applicationId?: string): Promise<any>
  • Parameters

    • applicationId: string = '@me'

    Returns Promise<any>

fetchOauth2ApplicationAssets

  • fetchOauth2ApplicationAssets(applicationId: string): Promise<any>

fetchOauth2ApplicationWhitelist

  • fetchOauth2ApplicationWhitelist(applicationId: string): Promise<any>

fetchOauth2Applications

fetchOauth2Authorize

fetchOauth2AuthorizeWebhookChannels

  • fetchOauth2AuthorizeWebhookChannels(guildId: string): Promise<any>

fetchOauth2Token

  • fetchOauth2Token(tokenId: string): Promise<any>

fetchOauth2Tokens

  • fetchOauth2Tokens(): Promise<any>

fetchPinnedMessages

  • fetchPinnedMessages(channelId: string): Promise<any>

fetchReactions

  • fetchReactions(channelId: string, messageId: string, emoji: string, options?: FetchReactions): Promise<any>

fetchStageInstance

  • fetchStageInstance(channelId: string): Promise<any>

fetchStoreApplicationAssets

  • fetchStoreApplicationAssets(applicationId: string): Promise<any>

fetchStorePublishedListingsSku

  • fetchStorePublishedListingsSku(skuId: string): Promise<any>

fetchStorePublishedListingsSkuSubscriptionPlans

  • fetchStorePublishedListingsSkuSubscriptionPlans(skuId: string): Promise<any>

fetchStorePublishedListingsSkus

  • fetchStorePublishedListingsSkus(applicationId: string): Promise<any>

fetchStreamPreview

  • fetchStreamPreview(streamKey: string): Promise<any>

fetchTeam

  • fetchTeam(teamId: string): Promise<any>

fetchTeamApplications

  • fetchTeamApplications(teamId: string): Promise<any>

fetchTeamMember

  • fetchTeamMember(teamId: string, userId: string): Promise<any>
  • Parameters

    • teamId: string
    • userId: string

    Returns Promise<any>

fetchTeamMembers

  • fetchTeamMembers(teamId: string): Promise<any>

fetchTeamPayouts

fetchTeams

  • fetchTeams(): Promise<any>

fetchTemplate

  • fetchTemplate(templateId: string): Promise<any>

fetchThreadMembers

  • fetchThreadMembers(channelId: string): Promise<any>

fetchUser

  • fetchUser(userId: string): Promise<any>

fetchUserActivityMetadata

  • fetchUserActivityMetadata(userId: string, sessionId: string, activityId: string): Promise<any>
  • Parameters

    • userId: string
    • sessionId: string
    • activityId: string

    Returns Promise<any>

fetchUserChannels

  • fetchUserChannels(userId: string): Promise<any>

fetchUserProfile

  • fetchUserProfile(userId: string): Promise<any>

fetchVoiceIce

  • fetchVoiceIce(): Promise<any>

fetchVoiceRegions

  • fetchVoiceRegions(guildId?: string): Promise<any>

fetchWebhook

  • fetchWebhook(webhookId: string): Promise<any>

fetchWebhookToken

  • fetchWebhookToken(webhookId: string, webhookToken: string): Promise<any>
  • Parameters

    • webhookId: string
    • webhookToken: string

    Returns Promise<any>

fetchWebhookTokenMessage

  • fetchWebhookTokenMessage(webhookId: string, webhookToken: string, messageId: string): Promise<any>
  • Parameters

    • webhookId: string
    • webhookToken: string
    • messageId: string

    Returns Promise<any>

followChannel

  • followChannel(channelId: string, options: FollowChannel): Promise<any>

forgotPassword

get

  • get(info: string | URL | Options, init?: Options): Promise<Response>

getMaxListeners

  • getMaxListeners(): number
  • Returns number

hasEventListener

  • hasEventListener(name: string | symbol): boolean
  • Parameters

    • name: string | symbol

    Returns boolean

head

  • head(info: string | URL | Options, init?: Options): Promise<Response>

integrationJoin

  • integrationJoin(integrationId: string): Promise<any>

joinGuild

  • joinGuild(guildId: string, options?: JoinGuild): Promise<any>

joinThread

  • joinThread(channelId: string): Promise<any>

leaveGuild

  • leaveGuild(guildId: string): Promise<any>

leaveThread

  • leaveThread(channelId: string): Promise<any>

listenerCount

  • listenerCount(event: string | symbol): number
  • Parameters

    • event: string | symbol

    Returns number

listeners

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

    • event: string | symbol

    Returns Function[]

login

  • login(options: Login): Promise<any>

loginMfaSms

loginMfaSmsSend

loginMfaTotp

logout

  • logout(options?: Logout): Promise<any>

oauth2Authorize

off

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

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

          • Rest ...args: any[]

          Returns void

    Returns Client

on

once

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

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

          • Rest ...args: any[]

          Returns void

    Returns Client

options

  • options(info: string | URL | Options, init?: Options): Promise<Response>

patch

  • patch(info: string | URL | Options, init?: Options): Promise<Response>

post

  • post(info: string | URL | Options, init?: Options): Promise<Response>

prependListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns Client

prependOnceListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns Client

put

  • put(info: string | URL | Options, init?: Options): Promise<Response>

rawListeners

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

    • event: string | symbol

    Returns Function[]

redeemGiftCode

  • redeemGiftCode(code: string, options?: RedeemGiftCode): Promise<any>

register

  • register(options: Register): Promise<any>

removeAllListeners

  • removeAllListeners(name?: string | symbol): Client
  • Parameters

    • Optional name: string | symbol

    Returns Client

removeAllSubscriptions

  • removeAllSubscriptions(): Client
  • Returns Client

removeGuildBan

  • removeGuildBan(guildId: string, userId: string, options?: RemoveGuildBan): Promise<any>

removeGuildMember

  • removeGuildMember(guildId: string, userId: string, options?: RemoveGuildMember): Promise<any>

removeGuildMemberRole

  • removeGuildMemberRole(guildId: string, userId: string, roleId: string, options?: RemoveGuildMemberRole): Promise<any>

removeListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns Client

removeMention

  • removeMention(messageId: string): Promise<any>

removeOauth2ApplicationWhitelistUser

  • removeOauth2ApplicationWhitelistUser(applicationId: string, userId: string): Promise<any>
  • Parameters

    • applicationId: string
    • userId: string

    Returns Promise<any>

removeRecipient

  • removeRecipient(channelId: string, userId: string): Promise<any>
  • Parameters

    • channelId: string
    • userId: string

    Returns Promise<any>

removeSubscription

  • removeSubscription(subscription: EventSubscription): void
  • Parameters

    • subscription: EventSubscription

    Returns void

removeTeamMember

  • removeTeamMember(teamId: string, userId: string): Promise<any>
  • Parameters

    • teamId: string
    • userId: string

    Returns Promise<any>

removeThreadMember

  • removeThreadMember(channelId: string, userId: string): Promise<any>
  • Parameters

    • channelId: string
    • userId: string

    Returns Promise<any>

request

resetOauth2Application

  • resetOauth2Application(applicationId: string): Promise<any>

resetOauth2ApplicationBot

  • resetOauth2ApplicationBot(applicationId: string): Promise<any>

resetPassword

resetPasswordMfa

search

  • search(searchType: "channel" | "guild", searchId: string, options?: SearchOptions, retry?: boolean, retryNumber?: number): Promise<any>
  • Parameters

    • searchType: "channel" | "guild"
    • searchId: string
    • options: SearchOptions = {}
    • retry: boolean = true
    • retryNumber: number = 0

    Returns Promise<any>

searchChannel

  • searchChannel(channelId: string, options?: SearchOptions, retry?: boolean, retryNumber?: number): Promise<any>
  • Parameters

    • channelId: string
    • options: SearchOptions = {}
    • retry: boolean = true
    • retryNumber: number = 0

    Returns Promise<any>

searchGuild

  • searchGuild(guildId: string, options?: SearchOptions, retry?: boolean, retryNumber?: number): Promise<any>

searchLobbies

  • searchLobbies(applicationId: string, options?: SearchLobbies): Promise<any>

sendDownloadText

  • sendDownloadText(number: string): Promise<any>

sendFriendRequest

sendLobbyData

  • sendLobbyData(lobbyId: string, data: string): Promise<any>
  • Parameters

    • lobbyId: string
    • data: string

    Returns Promise<any>

setAuthType

  • setAuthType(type: string): void

setMaxListeners

  • setMaxListeners(n: number): Client
  • Parameters

    • n: number

    Returns Client

startChannelCallRinging

stopChannelCallRinging

submitConnectionPinCode

  • submitConnectionPinCode(platform: string, pin: string): Promise<any>
  • Parameters

    • platform: string
    • pin: string

    Returns Promise<any>

submitOauth2ApplicationApproval

  • submitOauth2ApplicationApproval(applicationId: string): Promise<any>

subscribe

  • subscribe(name: string | symbol, listener: (...args: any[]) => void): EventSubscription
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventSubscription

syncGuildIntegration

  • syncGuildIntegration(guildId: string, integrationId: string): Promise<any>
  • Parameters

    • guildId: string
    • integrationId: string

    Returns Promise<any>

transferOauth2Application

triggerTyping

  • triggerTyping(channelId: string): Promise<any>

unAckChannel

  • unAckChannel(channelId: string): Promise<any>

verify

  • verify(options: Verify): Promise<any>

verifyCaptcha

verifyResend

  • verifyResend(): Promise<any>

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