Class Channel

constructor

• new Channel(data, client, guildId?): Channel

• Parameters

  • data: RawChannelData

  • client: Client

  • Optional guildId: string | bigint

  Returns Channel

__priority

applicationId

appliedTags

availableTags

bitrate

defaultAutoArchiveDuration

defaultForumLayout

defaultReactionEmoji

defaultSortOrder

defaultThreadRateLimitPerUser

flags

guildId

Optional icon

id

lastMessageId

lastPinTimestamp

member

memberCount

messageCount

name

nsfw

ownerId

parentId

permissionOverwrites

permissions

position

rateLimitPerUser

recipients

rtcRegion

threadMetadata

topic

totalMessageSent

type

userLimit

videoQualityMode

[toStringTag]

• get [toStringTag](): bigint

• Returns bigint

parsedSnowflake

• get parsedSnowflake(): {
      binary: string;
      date: Date;
      increment: bigint;
      processId: bigint;
      timestamp: number;
      workerId: bigint;
  }

• Returns {
      binary: string;
      date: Date;
      increment: bigint;
      processId: bigint;
      timestamp: number;
      workerId: bigint;
  }

  • binary: string

  • date: Date

  • increment: bigint

  • processId: bigint

  • timestamp: number

  • workerId: bigint

  Example

  <Channel>.parsedSnowflake()
  Copy

addThreadMember

• addThreadMember(userId): Promise<any>

• Parameters

  • userId: bigint

  Returns Promise<any>

createInvite

• createInvite(data, reason?): Promise<Invite>

• Parameters

  • data: CreateChannelInvitePayload

  • Optional reason: string

  Returns Promise<Invite>

createMessage

• createMessage(message): Promise<Message>

• Parameters

  • message: MessagePayload

  Returns Promise<Message>

createReaction

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

• Parameters

  • messageId: bigint

  • emoji: string

  Returns Promise<any>

crosspostMessage

• crosspostMessage(messageId, reason?): Promise<Message>

• Parameters

  • messageId: bigint

  • Optional reason: string

  Returns Promise<Message>

delete

• delete(reason?): Promise<any>

• Parameters

  • Optional reason: string

  Returns Promise<any>

deleteAllReactions

• deleteAllReactions(messageId): Promise<any>

• Parameters

  • messageId: bigint

  Returns Promise<any>

deleteAllReactionsForEmoji

• deleteAllReactionsForEmoji(messageId, emoji): Promise<any>

• Parameters

  • messageId: bigint

  • emoji: string

  Returns Promise<any>

deleteBulkMessages

• deleteBulkMessages(messageIds, reason?): Promise<any>

• Parameters

  • messageIds: bigint[]

  • Optional reason: string

  Returns Promise<any>

deleteMessage

• deleteMessage(messageId, reason?): Promise<any>

• Parameters

  • messageId: bigint

  • Optional reason: string

  Returns Promise<any>

deleteOwnReaction

• deleteOwnReaction(messageId, emoji): Promise<any>

• Parameters

  • messageId: bigint

  • emoji: string

  Returns Promise<any>

deletePermission

• deletePermission(overwriteId, reason?): Promise<any>

• Parameters

  • overwriteId: bigint

  • Optional reason: string

  Returns Promise<any>

deleteReaction

• deleteReaction(messageId, userId, emoji): Promise<any>

• Parameters

  • messageId: bigint

  • userId: bigint

  • emoji: string

  Returns Promise<any>

editMessage

• editMessage(messageId, data): Promise<Message>

• Parameters

  • messageId: bigint

  • data: MessagePayload

  Returns Promise<Message>

editPermissions

• editPermissions(overwriteId, data, reason?): Promise<any>

• Parameters

  • overwriteId: bigint

  • data: RawOverwriteData

  • Optional reason: string

  Returns Promise<any>

follow

• follow(webhookChannelId): Promise<any>

• Parameters

  • webhookChannelId: bigint

  Returns Promise<any>

get

• get(): Promise<Channel>

• Returns Promise<Channel>

getInvites

• getInvites(): Promise<any>

• Returns Promise<any>

getMessage

• getMessage(messageId): Promise<Message>

• Parameters

  • messageId: bigint

  Returns Promise<Message>

getMessages

• getMessages(options): Promise<Message[]>

• Parameters

  • options: RawChannelMessageOptions

  Returns Promise<Message[]>

getPinnedMessages

• getPinnedMessages(): Promise<any>

• Returns Promise<any>

getReactions

• getReactions(messageId, emoji, options): Promise<User[]>

• Parameters

  • messageId: bigint

  • emoji: string

  • options: {
        after?: bigint;
        limit?: number;
    }

    • Optional after?: bigint

    • Optional limit?: number

  Returns Promise<User[]>

getThreadMember

• getThreadMember(userId): Promise<{
      flags: any;
      id: bigint;
      joinTimestamp: Date;
      member: null | Member;
      userId: bigint;
  }>

• Parameters

  • userId: bigint

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

groupAddRecipient

• groupAddRecipient(userId, data): Promise<any>

• Parameters

  • userId: bigint

  • data: GroupDMAddRecipientPayload

  Returns Promise<any>

groupRemoveRecipient

• groupRemoveRecipient(userId): Promise<any>

• Parameters

  • userId: bigint

  Returns Promise<any>

iconUrl

• iconUrl(options?): null | string

• Parameters

  • options: {
        dynamic: boolean;
        format: string;
        size: number;
    } = ...

    • dynamic: boolean

    • format: string

    • size: number

  Returns null | string

joinThread

• joinThread(): Promise<any>

• Returns Promise<any>

leaveThread

• leaveThread(): Promise<any>

• Returns Promise<any>

listJoinedPrivateArchives

• listJoinedPrivateArchives(data): Promise<{
      hasMore: any;
      members: any;
      threads: any;
  }>

• Parameters

  • data: ListArchivedThreadsPayload

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

listPrivateArchives

• listPrivateArchives(data): Promise<{
      hasMore: any;
      members: any;
      threads: any;
  }>

• Parameters

  • data: ListArchivedThreadsPayload

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

listPublicArchives

• listPublicArchives(data): Promise<{
      hasMore: any;
      members: any;
      threads: any;
  }>

• Parameters

  • data: ListArchivedThreadsPayload

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

listThreadMembers

• listThreadMembers(): Promise<any>

• Returns Promise<any>

pinMessage

• pinMessage(messageId): Promise<any>

• Parameters

  • messageId: bigint

  Returns Promise<any>

removeThreadMember

• removeThreadMember(userId): Promise<any>

• Parameters

  • userId: bigint

  Returns Promise<any>

startThreadFromMessage

• startThreadFromMessage(messageId, data, reason?): Promise<Channel>

• Parameters

  • messageId: bigint

  • data: StartThreadPayload

  • Optional reason: string

  Returns Promise<Channel>

startThreadInForum

• startThreadInForum(data, reason?): Promise<Channel>

• Parameters

  • data: StartThreadInForumPayload

  • Optional reason: string

  Returns Promise<Channel>

triggerTypingIndicator

• triggerTypingIndicator(): Promise<any>

• Returns Promise<any>

unpinMessage

• unpinMessage(messageId): Promise<any>

• Parameters

  • messageId: bigint

  Returns Promise<any>

update

• update(data, reason?): Promise<any>

• Parameters

  • data: Camelize<RawChannelData>

  • Optional reason: string

  Returns Promise<any>

updateThis

• updateThis(data): void

• Parameters

  • data: RawChannelData

  Returns void