Class Client

Hierarchy

  • Client

Constructors

Properties

Accessors

Methods

addGuildMember addGuildMemberRole addThreadMember beginGuildPrune bulkOverwriteGlobalApplicationCommands bulkOverwriteGuildApplicationCommands createAutoModerationRule createChannelInvite createFollowupMessage createGlobalApplicationCommand createGuild createGuildApplicationCommand createGuildBan createGuildChannel createGuildEmoji createGuildRole createInteractionResponse createMessage createReaction crosspostMessage deleteAllReactions deleteAllReactionsForEmoji deleteAutoModerationRule deleteBulkMessages deleteChannel deleteChannelPermission deleteFollowupMessage deleteGlobalApplicationCommand deleteGuild deleteGuildApplicationCommand deleteGuildEmoji deleteGuildIntegration deleteGuildRole deleteMessage deleteOriginalInteractionResponse deleteOwnReaction deleteReaction editChannelPermissions editFollowupMessage editGlobalApplicationCommand editGuildApplicationCommand editMessage editOriginalInteractionResponse emit followAnnouncementChannel getApplicationCommandPermissions getApplicationRoleConnectionMetadataRecords getAutoModerationRule getChannel getChannelInvites getChannelMessage getChannelMessages getFollowupMessage getGlobalApplicationCommand getGlobalApplicationCommands getGuild getGuildApplicationCommand getGuildApplicationCommandPermissions getGuildApplicationCommands getGuildAuditLogs getGuildBan getGuildBans getGuildChannels getGuildEmoji getGuildIntegrations getGuildInvites getGuildMember getGuildOnBoarding getGuildPreview getGuildPruneCount getGuildRoles getGuildVanityUrl getGuildVoiceRegions getGuildWelcomeScreen getGuildWidget getGuildWidgetImage getGuildWidgetSettings getOriginalInteractionResponse getPinnedMessages getReactions getThreadMember getUrlFromHash getUser groupDMAddRecipient groupDMRemoveRecipient joinThread leaveThread listActiveGuildThreads listAutoModerationRules listGuildEmojis listGuildMembers listJoinedPrivateArchivedThreads listPrivateArchivedThreads listPublicArchivedThreads listThreadMembers modifyCurrentUserNick modifyCurrentUserVoiceState modifyGuild modifyGuildChannelPositions modifyGuildEmoji modifyGuildMFALevel modifyGuildMember modifyGuildRole modifyGuildRolePositions modifyGuildWelcomeScreen modifyGuildWidget modifyUserVoiceState on pinMessage removeGuildBan removeGuildMember removeGuildMemberRole removeThreadMember searchGuildMembers startThreadFromMessage startThreadInForum startThreadWithoutMessage triggerTypingIndicator unpinMessage updateApplicationRoleConnectionMetadataRecords updateAutoModerationRule updateChannel

Constructors

Properties

#on: Partial<Record<GatewayEventNames, Function[]>> = {}
#options: ClientOptions
api: (() => ApiroxyData) = Api

Type declaration

readyData: {
    application: Camelize<RawApplicationData>;
    guilds: {
        id: string;
        unavailable?: boolean;
    }[];
    resumeGatewayUrl: string;
    sessionId: string;
    shard: undefined | [number, number];
    user: User;
}

Type declaration

  • application: Camelize<RawApplicationData>
  • guilds: {
        id: string;
        unavailable?: boolean;
    }[]
  • resumeGatewayUrl: string
  • sessionId: string
  • shard: undefined | [number, number]
  • user: User

Accessors

  • get token(): `${string}.${string}.${string}`
  • Returns `${string}.${string}.${string}`

Methods

  • Parameters

    • guildId: bigint
    • userId: bigint
    • roleId: bigint
    • Optional reason: string

    Returns Promise<null | Member>

  • Parameters

    • channelId: bigint
    • userId: bigint

    Returns Promise<any>

  • Parameters

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

    Returns Promise<any>

  • Parameters

    • channelId: bigint
    • messageId: bigint
    • Optional reason: string

    Returns Promise<Message>

  • Parameters

    • channelId: bigint
    • messageId: bigint

    Returns Promise<any>

  • Parameters

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

    Returns Promise<any>

  • Parameters

    • guildId: bigint
    • ruleId: bigint
    • Optional reason: string

    Returns Promise<any>

  • Parameters

    • channelId: bigint
    • messageIds: bigint[]
    • Optional reason: string

    Returns Promise<any>

  • Parameters

    • channelId: bigint
    • Optional reason: string

    Returns Promise<any>

  • Parameters

    • channelId: bigint
    • overwriteId: bigint
    • Optional reason: string

    Returns Promise<any>

  • Parameters

    • token: string
    • messageId: bigint

    Returns Promise<void>

  • Parameters

    • commandId: bigint

    Returns Promise<void>

  • Parameters

    • guildId: bigint

    Returns Promise<boolean>

  • Parameters

    • guildId: bigint
    • commandId: bigint

    Returns Promise<void>

  • Parameters

    • guildId: bigint
    • emojiId: bigint

    Returns Promise<boolean>

  • Parameters

    • guildId: bigint
    • integrationId: bigint
    • Optional reason: string

    Returns Promise<boolean>

  • Parameters

    • guildId: bigint
    • roleId: bigint
    • Optional reason: string

    Returns Promise<boolean>

  • Parameters

    • channelId: bigint
    • messageId: bigint
    • Optional reason: string

    Returns Promise<any>

  • Parameters

    • token: string

    Returns Promise<void>

  • Parameters

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

    Returns Promise<any>

  • Parameters

    • channelId: bigint
    • messageId: bigint
    • userId: bigint
    • emoji: string

    Returns Promise<any>

  • Parameters

    • channelId: bigint
    • webhookChannelId: bigint

    Returns Promise<any>

  • ApplicationRoleConnectionMetadata

    Parameters

    • Optional appId: bigint

    Returns Promise<any>

  • Parameters

    • guildId: bigint
    • ruleId: bigint

    Returns Promise<any>

  • Parameters

    • channelId: bigint

    Returns Promise<any>

  • Parameters

    • token: string
    • messageId: bigint

    Returns Promise<any>

  • AuditLogs

    Parameters

    • guildId: bigint

    Returns Promise<any>

  • Parameters

    • guildId: bigint
    • userId: bigint

    Returns Promise<null | {
        reason: any;
        user: User;
    }>

  • Parameters

    • guildId: bigint

    Returns Promise<any>

  • Parameters

    • guildId: bigint

    Returns Promise<any>

  • Parameters

    • guildId: bigint

    Returns Promise<any>

  • Parameters

    • guildId: bigint

    Returns Promise<any>

  • Parameters

    • guildId: bigint

    Returns Promise<any>

  • Parameters

    • guildId: bigint

    Returns Promise<any>

  • Parameters

    • guildId: bigint

    Returns Promise<any>

  • Parameters

    • guildId: bigint

    Returns Promise<any>

  • Parameters

    • guildId: bigint

    Returns Promise<any>

  • Parameters

    • guildId: bigint

    Returns Promise<any>

  • Parameters

    • guildId: bigint

    Returns Promise<any>

  • Parameters

    • guildId: bigint

    Returns Promise<any>

  • Parameters

    • channelId: bigint

    Returns Promise<any>

  • Parameters

    • channelId: bigint
    • messageId: bigint
    • emoji: string
    • Optional options: {
          after?: bigint;
          limit?: number;
      }
      • Optional after?: bigint
      • Optional limit?: number

    Returns Promise<User[]>

  • Parameters

    • channelId: bigint
    • userId: bigint
    • withMember: boolean = true

    Returns Promise<{
        flags: any;
        id: bigint;
        joinTimestamp: Date;
        member: null | Member;
        userId: bigint;
    }>

  • Parameters

    • hash: string
    • type: "icon" | "avatar" | "banner" | "splash"
    • size: ImageSize = 1024
    • format: ImageFormat = "webp"
    • dynamic: boolean = true

    Returns string

  • Parameters

    • channelId: bigint
    • userId: bigint

    Returns Promise<any>

  • Parameters

    • channelId: bigint

    Returns Promise<any>

  • Parameters

    • channelId: bigint

    Returns Promise<any>

  • Parameters

    • guildId: bigint

    Returns Promise<any>

  • AutoModeration

    Parameters

    • guildId: bigint

    Returns Promise<any>

  • Emoji

    Parameters

    • guildId: bigint

    Returns Promise<any>

  • Parameters

    Returns Promise<{
        hasMore: any;
        members: any;
        threads: any;
    }>

  • Parameters

    Returns Promise<{
        hasMore: any;
        members: any;
        threads: any;
    }>

  • Parameters

    Returns Promise<{
        hasMore: any;
        members: any;
        threads: any;
    }>

  • Parameters

    • channelId: bigint
    • Optional includeGuildMember: boolean

    Returns Promise<any>

  • Parameters

    • guildId: bigint
    • Optional nick: string
    • Optional reason: string

    Returns Promise<null | Member>

  • Parameters

    • guildId: bigint
    • roleId: bigint
    • position: number
    • Optional reason: string

    Returns Promise<Role>

  • Parameters

    • channelId: bigint
    • messageId: bigint
    • Optional reason: string

    Returns Promise<any>

  • Parameters

    • guildId: bigint
    • userId: bigint
    • Optional reason: string

    Returns Promise<boolean>

  • Parameters

    • guildId: bigint
    • userId: bigint
    • Optional reason: string

    Returns Promise<boolean>

  • Parameters

    • guildId: bigint
    • userId: bigint
    • roleId: bigint
    • Optional reason: string

    Returns Promise<null | Member>

  • Parameters

    • channelId: bigint
    • userId: bigint

    Returns Promise<any>

  • Parameters

    • channelId: bigint

    Returns Promise<any>

  • Parameters

    • channelId: bigint
    • messageId: bigint
    • Optional reason: string

    Returns Promise<any>

  • Parameters

    Returns Promise<any>

Generated using TypeDoc