Class ThreadChannel

Hierarchy

GuildChannel
- ThreadChannel

Implements

ThreadTextable

Index

Constructors

constructor

Properties

Constructors

constructor

new ThreadChannel(data: BaseData, client: Client, messageLimit?: number): ThreadChannel

Overrides GuildChannel.constructor
- Defined in node_modules/eris/index.d.ts:3534
Parameters
- data: BaseData
- client: Client
- Optional messageLimit: number
Returns ThreadChannel

Properties

client

client: Client

createdAt

createdAt: number

guild

guild: Guild

id

id: string

lastMessageID

lastMessageID: string

Optional lastPinTimestamp

lastPinTimestamp: number

Optional member

member: ThreadMember

memberCount

memberCount: number

members

members: Collection<ThreadMember>

mention

mention: string

messageCount

messageCount: number

messages

messages: Collection<Message<ThreadChannel>>

name

name: string

nsfw

nsfw: boolean

ownerID

ownerID: string

parentID

parentID: null | string

permissionOverwrites

permissionOverwrites: Collection<PermissionOverwrite>

position

position: number

rateLimitPerUser

rateLimitPerUser: number

threadMetadata

threadMetadata: ThreadMetadata

type

type: GuildThreadChannelTypes

Methods

addMessageReaction

addMessageReaction(messageID: string, reaction: string): Promise<void>

Implementation of ThreadTextable.addMessageReaction
- Defined in node_modules/eris/index.d.ts:3535
Parameters
- messageID: string
- reaction: string
Returns Promise<void>

createMessage

createMessage(content: MessageContent, file?: FileContent | FileContent[]): Promise<Message<ThreadChannel>>

Implementation of ThreadTextable.createMessage
- Defined in node_modules/eris/index.d.ts:3536
Parameters
- content: MessageContent
- Optional file: FileContent | FileContent[]
Returns Promise<Message<ThreadChannel>>

delete

delete(reason?: string): Promise<void>

Inherited from GuildChannel.delete
- Defined in node_modules/eris/index.d.ts:2837
Parameters
- Optional reason: string
Returns Promise<void>

deleteMessage

deleteMessage(messageID: string, reason?: string): Promise<void>

Implementation of ThreadTextable.deleteMessage
- Defined in node_modules/eris/index.d.ts:3537
Parameters
- messageID: string
- Optional reason: string
Returns Promise<void>

deleteMessages

deleteMessages(messageIDs: string[], reason?: string): Promise<void>

Implementation of ThreadTextable.deleteMessages
- Defined in node_modules/eris/index.d.ts:3538
Parameters
- messageIDs: string[]
- Optional reason: string
Returns Promise<void>

deletePermission

deletePermission(overwriteID: string, reason?: string): Promise<void>

Inherited from GuildChannel.deletePermission
- Defined in node_modules/eris/index.d.ts:2838
Parameters
- overwriteID: string
- Optional reason: string
Returns Promise<void>

edit

edit(options: Pick<EditChannelOptions, "name" | "rateLimitPerUser" | "archived" | "autoArchiveDuration" | "invitable" | "locked">, reason?: string): Promise<ThreadChannel>

Overrides GuildChannel.edit
- Defined in node_modules/eris/index.d.ts:3539
Parameters
- options: Pick<EditChannelOptions, "name" | "rateLimitPerUser" | "archived" | "autoArchiveDuration" | "invitable" | "locked">
- Optional reason: string
Returns Promise<ThreadChannel>

editMessage

editMessage(messageID: string, content: MessageContentEdit): Promise<Message<ThreadChannel>>

Implementation of ThreadTextable.editMessage
- Defined in node_modules/eris/index.d.ts:3540
Parameters
- messageID: string
- content: MessageContentEdit
Returns Promise<Message<ThreadChannel>>

editPermission

editPermission(overwriteID: string, allow: number | bigint, deny: number | bigint, type: PermissionType, reason?: string): Promise<PermissionOverwrite>

Inherited from GuildChannel.editPermission
- Defined in node_modules/eris/index.d.ts:2840
Parameters
- overwriteID: string
- allow: number | bigint
- deny: number | bigint
- type: PermissionType
- Optional reason: string
Returns Promise<PermissionOverwrite>

editPosition

editPosition(position: number, options?: EditChannelPositionOptions): Promise<void>

Inherited from GuildChannel.editPosition
- Defined in node_modules/eris/index.d.ts:2847
Parameters
- position: number
- Optional options: EditChannelPositionOptions
Returns Promise<void>

getInvites

getInvites(): Promise<Invite<"withMetadata", InviteChannel>[]>

Inherited from GuildChannel.getInvites
- Defined in node_modules/eris/index.d.ts:2848
Returns Promise<Invite<"withMetadata", InviteChannel>[]>

getMembers

getMembers(): Promise<ThreadMember[]>

Implementation of ThreadTextable.getMembers
- Defined in node_modules/eris/index.d.ts:3541
Returns Promise<ThreadMember[]>

getMessage

getMessage(messageID: string): Promise<Message<ThreadChannel>>

Implementation of ThreadTextable.getMessage
- Defined in node_modules/eris/index.d.ts:3542
Parameters
- messageID: string
Returns Promise<Message<ThreadChannel>>

getMessageReaction

getMessageReaction(messageID: string, reaction: string, options?: GetMessageReactionOptions): Promise<User[]>
getMessageReaction(messageID: string, reaction: string, limit?: number, before?: string, after?: string): Promise<User[]>

Implementation of ThreadTextable.getMessageReaction
- Defined in node_modules/eris/index.d.ts:3543
Parameters
- messageID: string
- reaction: string
- Optional options: GetMessageReactionOptions
Returns Promise<User[]>
Implementation of ThreadTextable.getMessageReaction
- Defined in node_modules/eris/index.d.ts:3545
deprecated

Parameters
- messageID: string
- reaction: string
- Optional limit: number
- Optional before: string
- Optional after: string
Returns Promise<User[]>

getMessages

getMessages(options?: GetMessagesOptions): Promise<Message<ThreadChannel>[]>
getMessages(limit?: number, before?: string, after?: string, around?: string): Promise<Message<ThreadChannel>[]>

Implementation of ThreadTextable.getMessages
- Defined in node_modules/eris/index.d.ts:3546
Parameters
- Optional options: GetMessagesOptions
Returns Promise<Message<ThreadChannel>[]>
Implementation of ThreadTextable.getMessages
- Defined in node_modules/eris/index.d.ts:3548
deprecated

Parameters
- Optional limit: number
- Optional before: string
- Optional after: string
- Optional around: string
Returns Promise<Message<ThreadChannel>[]>

getPins

getPins(): Promise<Message<ThreadChannel>[]>

Implementation of ThreadTextable.getPins
- Defined in node_modules/eris/index.d.ts:3549
Returns Promise<Message<ThreadChannel>[]>

inspect

inspect(): ThreadChannel

Inherited from GuildChannel.inspect
- Defined in node_modules/eris/index.d.ts:2038
Returns ThreadChannel

join

join(userID?: string): Promise<void>

Implementation of ThreadTextable.join
- Defined in node_modules/eris/index.d.ts:3550
Parameters
- Optional userID: string
Returns Promise<void>

leave

leave(userID?: string): Promise<void>

Implementation of ThreadTextable.leave
- Defined in node_modules/eris/index.d.ts:3551
Parameters
- Optional userID: string
Returns Promise<void>

permissionsOf

permissionsOf(memberID: string | Member | MemberRoles): Permission

Inherited from GuildChannel.permissionsOf
- Defined in node_modules/eris/index.d.ts:2849
Parameters
- memberID: string | Member | MemberRoles
Returns Permission

pinMessage

pinMessage(messageID: string): Promise<void>

Implementation of ThreadTextable.pinMessage
- Defined in node_modules/eris/index.d.ts:3552
Parameters
- messageID: string
Returns Promise<void>

purge

purge(options: PurgeChannelOptions): Promise<number>

Implementation of ThreadTextable.purge
- Defined in node_modules/eris/index.d.ts:3553
Parameters
- options: PurgeChannelOptions
Returns Promise<number>

removeMessageReaction

removeMessageReaction(messageID: string, reaction: string, userID?: string): Promise<void>

Implementation of ThreadTextable.removeMessageReaction
- Defined in node_modules/eris/index.d.ts:3554
Parameters
- messageID: string
- reaction: string
- Optional userID: string
Returns Promise<void>

removeMessageReactionEmoji

removeMessageReactionEmoji(messageID: string, reaction: string): Promise<void>

Implementation of ThreadTextable.removeMessageReactionEmoji
- Defined in node_modules/eris/index.d.ts:3555
Parameters
- messageID: string
- reaction: string
Returns Promise<void>

removeMessageReactions

removeMessageReactions(messageID: string): Promise<void>

Implementation of ThreadTextable.removeMessageReactions
- Defined in node_modules/eris/index.d.ts:3556
Parameters
- messageID: string
Returns Promise<void>

sendTyping

sendTyping(): Promise<void>

Implementation of ThreadTextable.sendTyping
- Defined in node_modules/eris/index.d.ts:3557
Returns Promise<void>

toJSON

toJSON(props?: string[]): JSONCache

Inherited from GuildChannel.toJSON
- Defined in node_modules/eris/index.d.ts:2040
Parameters
- Optional props: string[]
Returns JSONCache

toString

toString(): string

Inherited from GuildChannel.toString
- Defined in node_modules/eris/index.d.ts:2039
Returns string

unpinMessage

unpinMessage(messageID: string): Promise<void>

Implementation of ThreadTextable.unpinMessage
- Defined in node_modules/eris/index.d.ts:3558
Parameters
- messageID: string
Returns Promise<void>

unsendMessage

unsendMessage(messageID: string): Promise<void>

Implementation of ThreadTextable.unsendMessage
- Defined in node_modules/eris/index.d.ts:3559
Parameters
- messageID: string
Returns Promise<void>

Static from

from(data: BaseData, client: Client): AnyChannel

Inherited from GuildChannel.from
- Defined in node_modules/eris/index.d.ts:2101
Parameters
- data: BaseData
- client: Client
Returns AnyChannel

Static getCreatedAt

getCreatedAt(id: string): number

Inherited from GuildChannel.getCreatedAt
- Defined in node_modules/eris/index.d.ts:2036
Parameters
- id: string
Returns number

Static getDiscordEpoch

getDiscordEpoch(id: string): number

Inherited from GuildChannel.getDiscordEpoch
- Defined in node_modules/eris/index.d.ts:2037
Parameters
- id: string
Returns number

Generated using TypeDoc