Class GuildTemplate

Represents a guild template.

Index

Constructors

constructor

new GuildTemplate(data, client): GuildTemplate
Parameters
- data: RawGuildTemplate
- client: Client<ClientEvents>
Returns GuildTemplate
- Defined in lib/structures/GuildTemplate.ts:34

Properties

client

client: Client<ClientEvents>

code

code: string

The code of the template.

createdAt

createdAt: Date

When this template was created.

creator

creator: User

The creator of this template.

description

description: null | string

The description of this template.

isDirty

isDirty: null | boolean

If this template has unsynced changes.

name

name: string

The name of this template.

serializedSourceGuild

serializedSourceGuild: Partial<RawGuild>

A snapshot of the guild.

sourceGuildID

sourceGuildID: string

The ID of the source guild of this template.

updatedAt

updatedAt: Date

When this template was last updated.

usageCount

usageCount: number

The amount of times this template has been used.

Accessors

sourceGuild

get sourceGuild(): Guild
The source guild of this template. This will throw an error if the guild is not cached.

Returns Guild
- Defined in lib/structures/GuildTemplate.ts:79

Methods

delete

delete(): Promise<void>
Delete this template.

Returns Promise<void>
- Defined in lib/structures/GuildTemplate.ts:99

editTemplate

editTemplate(options): Promise<GuildTemplate>
Edit this template.
Parameters
- options: EditGuildTemplateOptions
  The options for editing the template.
Returns Promise<GuildTemplate>
- Defined in lib/structures/GuildTemplate.ts:107

syncTemplate

syncTemplate(): Promise<GuildTemplate>
Sync this template.

Returns Promise<GuildTemplate>
- Defined in lib/structures/GuildTemplate.ts:114

toJSON

toJSON(): JSONGuildTemplate
Returns JSONGuildTemplate
- Defined in lib/structures/GuildTemplate.ts:118

Class GuildTemplate

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GuildTemplate

Properties

client

code

createdAt

creator

description

isDirty

name

serializedSourceGuild

sourceGuildID

updatedAt

usageCount

Accessors

sourceGuild

Returns Guild

Methods

delete

Returns Promise<void>

editTemplate

Parameters

Returns Promise<GuildTemplate>

syncTemplate

Returns Promise<GuildTemplate>

toJSON

Returns JSONGuildTemplate

Settings

Member Visibility

Theme

On This Page