Class GuildTemplateManager

Hierarchy

GuildTemplateManager

Index

Constructors

constructor

Methods

Properties

Constructors

constructor

new GuildTemplateManager(token: string, tokenType: string, version: APIVersions): GuildTemplateManager

- Defined in client/managers/GuildTemplateManager.ts:35
Parameters
- token: string
  
  Bot's token
- tokenType: string
- version: APIVersions
  
  API Version
Returns GuildTemplateManager

Methods

createGuildFromGuildTemplate

createGuildFromGuildTemplate(templateCode: string, options: CreateGuildFromTemplateOptions): Promise<Guild>

- Defined in client/managers/GuildTemplateManager.ts:68
Create a new guild from a guild template.

Parameters
- templateCode: string
  
  The template code of the guild template you want to create a guild from.
- options: CreateGuildFromTemplateOptions
  
  {
Returns Promise<Guild>
A Guild object.

createGuildTemplate

createGuildTemplate(guildId: string, options: GuildTemplateOptions): Promise<GuildTemplate>

- Defined in client/managers/GuildTemplateManager.ts:113
Creates a guild template

Parameters
- guildId: string
  
  The ID of the guild you want to create a template for.
- options: GuildTemplateOptions
  
  GuildTemplateOptions
Returns Promise<GuildTemplate>
A GuildTemplate object.

deleteGuildTemplate

deleteGuildTemplate(guildId: string, templateCode: string): Promise<void>

- Defined in client/managers/GuildTemplateManager.ts:189
Deletes a guild template

Parameters
- guildId: string
  
  The ID of the guild you want to delete the template from.
- templateCode: string
  
  The template code of the template you want to delete.
Returns Promise<void>

getGuildTemplate

getGuildTemplate(templateCode: string): Promise<GuildTemplate>

- Defined in client/managers/GuildTemplateManager.ts:46
Get the guild template.

Parameters
- templateCode: string
  
  The template code of the guild template you want to get.
Returns Promise<GuildTemplate>
A GuildTemplate object.

getGuildTemplates

getGuildTemplates(guildId: string): Promise<GuildTemplate[]>

- Defined in client/managers/GuildTemplateManager.ts:92
Get the templates for a guild

Parameters
- guildId: string
  
  The ID of the guild you want to get the templates of.
Returns Promise<GuildTemplate[]>
An array of GuildTemplate objects.

modifyGuildTemplate

modifyGuildTemplate(guildId: string, templateCode: string, options: GuildTemplateOptions): Promise<GuildTemplate>

- Defined in client/managers/GuildTemplateManager.ts:164
Modify a guild template

Parameters
- guildId: string
  
  The ID of the guild you want to modify the template for.
- templateCode: string
  
  The template code of the template you want to modify.
- options: GuildTemplateOptions
  
  GuildTemplateOptions
Returns Promise<GuildTemplate>
A GuildTemplate object.

syncGuildTemplate

syncGuildTemplate(guildId: string, templateCode: string): Promise<GuildTemplate>

- Defined in client/managers/GuildTemplateManager.ts:138
Syncs a guild template

Parameters
- guildId: string
  
  The ID of the guild you want to sync the template to.
- templateCode: string
  
  The template code to sync to the guild.
Returns Promise<GuildTemplate>
A GuildTemplate object.

Properties

Readonly version

version: APIVersions

API Version

Private Readonly #token

#token: string

Bot's token

Private Readonly #tokenType

#tokenType: string

Token type

Generated using TypeDoc