Skip to content

GuildHandle

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

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

new GuildHandle(bot, id): GuildHandle

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

Client

string

GuildHandle

readonly id: string

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

get channels(): Collection<string, Channel>

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

The cached channels of this guild, as a snapshot taken when you read it.

Collection<string, Channel>


get members(): Collection<string, GuildMember>

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

The cached members, live: it changes as the Gateway updates them.

Collection<string, GuildMember>


get roles(): Collection<string, Role>

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

The cached roles, live.

Collection<string, Role>

ban(userId, options?): Promise<void>

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

Bans a user, whether or not they are a member.

string

BanOptions

Promise<void>


channel(channelId): ChannelHandle

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

string

ChannelHandle


createChannel<O>(options): Promise<ChannelOfKind<O["kind"]>>

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

Creates a channel. kind decides which other options apply, and the result is typed to match: a "voice" option gives a VoiceChannel.

O extends CreateChannelOptions

O

Promise<ChannelOfKind<O["kind"]>>

await bot.guild(id).createChannel({ kind: "text", name: "general", parent: categoryId });

edit(options): Promise<Guild>

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

Changes the guild’s settings; reason is the audit-log reason.

GuildEditOptions

Promise<Guild>


fetch(): Promise<Guild>

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

Promise<Guild>

Handle.fetch


get(): Promise<Guild>

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

Promise<Guild>

Handle.get


leave(): Promise<void>

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

Makes the bot leave the guild.

Promise<void>


member(userId): MemberHandle

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

string

MemberHandle


peek(): Guild | undefined

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

Guild | undefined

Handle.peek


role(roleId): RoleHandle

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

string

RoleHandle


unban(userId, reason?): Promise<void>

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

Lifts a ban.

string

string

Promise<void>