ChannelHandle
Defined in: packages/core/src/handles.ts:286
A channel, by id. Made by bot.channel(id).
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ChannelHandle(
bot,id):ChannelHandle
Defined in: packages/core/src/handles.ts:287
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”ChannelHandle
Properties
Section titled “Properties”
readonlyid:string
Defined in: packages/core/src/handles.ts:289
Methods
Section titled “Methods”as<
K>(…kinds):Promise<ChannelOfKind<K>>
Defined in: packages/core/src/handles.ts:311
Gets the channel (cache, else Discord) and returns it typed as one of
kinds.
Type Parameters
Section titled “Type Parameters”K extends "text" | "dm" | "voice" | "group-dm" | "category" | "announcement" | "thread" | "stage" | "directory" | "forum" | "media" | "unknown"
Parameters
Section titled “Parameters”…K[]
Returns
Section titled “Returns”Promise<ChannelOfKind<K>>
Throws
Section titled “Throws”If it is a different kind.
bulkDelete()
Section titled “bulkDelete()”bulkDelete(
messageIds,reason?):Promise<void>
Defined in: packages/core/src/handles.ts:332
Deletes up to 100 messages younger than 14 days.
Parameters
Section titled “Parameters”messageIds
Section titled “messageIds”Iterable<string>
reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<void>
delete()
Section titled “delete()”delete(
reason?):Promise<void>
Defined in: packages/core/src/handles.ts:328
Parameters
Section titled “Parameters”reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<void>
edit()
Section titled “edit()”edit(
options):Promise<Channel>
Defined in: packages/core/src/handles.ts:325
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<Channel>
fetch()
Section titled “fetch()”fetch():
Promise<Channel>
Defined in: packages/core/src/handles.ts:298
Returns
Section titled “Returns”Promise<Channel>
Implementation of
Section titled “Implementation of”get():
Promise<Channel>
Defined in: packages/core/src/handles.ts:295
Returns
Section titled “Returns”Promise<Channel>
Implementation of
Section titled “Implementation of”message()
Section titled “message()”message(
messageId):MessageHandle
Defined in: packages/core/src/handles.ts:302
Parameters
Section titled “Parameters”messageId
Section titled “messageId”string
Returns
Section titled “Returns”messages()
Section titled “messages()”messages(
query?):Promise<Message[]>
Defined in: packages/core/src/handles.ts:322
Reads messages: the latest, or around / before / after one.
Parameters
Section titled “Parameters”query?
Section titled “query?”MessageQueryOptions = {}
Returns
Section titled “Returns”Promise<Message[]>
peek()
Section titled “peek()”peek():
Channel|undefined
Defined in: packages/core/src/handles.ts:292
Returns
Section titled “Returns”Channel | undefined
Implementation of
Section titled “Implementation of”send()
Section titled “send()”send(
message):Promise<Message>
Defined in: packages/core/src/handles.ts:318
Sends a message: text, or a full payload (embeds, components, files, …).
Parameters
Section titled “Parameters”message
Section titled “message”Returns
Section titled “Returns”Promise<Message>