Skip to content

ChannelHandle

Defined in: packages/core/src/handles.ts:286

A channel, by id. Made by bot.channel(id).

new ChannelHandle(bot, id): ChannelHandle

Defined in: packages/core/src/handles.ts:287

Client

string

ChannelHandle

readonly id: string

Defined in: packages/core/src/handles.ts:289

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.

K extends "text" | "dm" | "voice" | "group-dm" | "category" | "announcement" | "thread" | "stage" | "directory" | "forum" | "media" | "unknown"

…K[]

Promise<ChannelOfKind<K>>

If it is a different kind.


bulkDelete(messageIds, reason?): Promise<void>

Defined in: packages/core/src/handles.ts:332

Deletes up to 100 messages younger than 14 days.

Iterable<string>

string

Promise<void>


delete(reason?): Promise<void>

Defined in: packages/core/src/handles.ts:328

string

Promise<void>


edit(options): Promise<Channel>

Defined in: packages/core/src/handles.ts:325

ChannelEditOptions

Promise<Channel>


fetch(): Promise<Channel>

Defined in: packages/core/src/handles.ts:298

Promise<Channel>

Handle.fetch


get(): Promise<Channel>

Defined in: packages/core/src/handles.ts:295

Promise<Channel>

Handle.get


message(messageId): MessageHandle

Defined in: packages/core/src/handles.ts:302

string

MessageHandle


messages(query?): Promise<Message[]>

Defined in: packages/core/src/handles.ts:322

Reads messages: the latest, or around / before / after one.

MessageQueryOptions = {}

Promise<Message[]>


peek(): Channel | undefined

Defined in: packages/core/src/handles.ts:292

Channel | undefined

Handle.peek


send(message): Promise<Message>

Defined in: packages/core/src/handles.ts:318

Sends a message: text, or a full payload (embeds, components, files, …).

MessageInput

Promise<Message>