GuildTemplateMethods

Methods for interacting with Guild Templates

Hierarchy

GuildTemplateMethods

Index

Constructors

constructor

Properties

requestHandler

Methods

Constructors

constructor

new GuildTemplateMethods(requestHandler: <internal>.RequestHandler): <internal>.GuildTemplateMethods

- Defined in node_modules/snowtransfer/dist/methods/GuildTemplate.d.ts:14
Create a new Guild Template Method Handler

Usually SnowTransfer creates a method handler for you, this is here for completion

You can access the methods listed via client.guildTemplate.method, where client is an initialized SnowTransfer instance

Parameters
- requestHandler: <internal>.RequestHandler
  
  request handler that calls the rest api
Returns <internal>.GuildTemplateMethods

Properties

requestHandler

requestHandler: <internal>.RequestHandler

Methods

createGuildFromGuildTemplate

createGuildFromGuildTemplate(code: string, options: { icon?: null | string; name: string }): Promise<<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/Guild".Guild>

- Defined in node_modules/snowtransfer/dist/methods/GuildTemplate.d.ts:27
Creates a guild from a template. If using a bot account, the bot can only be in < 10 guilds (guild create limitation)

Parameters
- code: string
  
  The code of the template
- options: { icon?: null | string; name: string }
  
  Specific options for the new guild
  - Optional icon?: null | string
  - name: string
Returns Promise<<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/Guild".Guild>
A guild

createGuildTemplate

createGuildTemplate(guildId: string, data: { description?: null | string; name: string }): Promise<<internal>.GuildTemplate>

- Defined in node_modules/snowtransfer/dist/methods/GuildTemplate.d.ts:51
Creates a template from the current state of the guild

Parameters
- guildId: string
  
  The Id of the guild
- data: { description?: null | string; name: string }
  
  Metadata for the template
  - Optional description?: null | string
  - name: string
Returns Promise<<internal>.GuildTemplate>
A guild tempalte

Permissions needed Condition

MANAGE_GUILD always

Permissions needed	Condition
MANAGE_GUILD	always

deleteGuildTemplate

deleteGuildTemplate(guildId: string, code: string): Promise<<internal>.GuildTemplate>

- Defined in node_modules/snowtransfer/dist/methods/GuildTemplate.d.ts:91
Deletes a template from a guild

Parameters
- guildId: string
  
  The Id of the guild
- code: string
  
  The code of the template
Returns Promise<<internal>.GuildTemplate>
A guild template

Permissions needed Condition

MANAGE_GUILD always

Permissions needed	Condition
MANAGE_GUILD	always

getGuildTemplate

getGuildTemplate(code: string): Promise<<internal>.GuildTemplate>

- Defined in node_modules/snowtransfer/dist/methods/GuildTemplate.d.ts:20
Get a guild template by code

Parameters
- code: string
  
  The code for the template
Returns Promise<<internal>.GuildTemplate>
A guild template

getGuildTemplates

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

- Defined in node_modules/snowtransfer/dist/methods/GuildTemplate.d.ts:40
Gets all templates from a guild

Parameters
- guildId: string
  
  The Id of the guild
Returns Promise<<internal>.GuildTemplate[]>
An array of guild templates

Permissions needed Condition

MANAGE_GUILD always

Permissions needed	Condition
MANAGE_GUILD	always

modifyGuildTemplate

modifyGuildTemplate(guildId: string, code: string, data: { description?: null | string; name?: string }): Promise<<internal>.GuildTemplate>

- Defined in node_modules/snowtransfer/dist/methods/GuildTemplate.d.ts:77
Updates a guild template's metadata

Parameters
- guildId: string
  
  The Id of the guild
- code: string
  
  The code of the template
- data: { description?: null | string; name?: string }
  
  Metadata for the template
  - Optional description?: null | string
  - Optional name?: string
Returns Promise<<internal>.GuildTemplate>
A guild template

Permissions needed Condition

MANAGE_GUILD always

Permissions needed	Condition
MANAGE_GUILD	always

syncGuildTemplate

syncGuildTemplate(guildId: string, code: string): Promise<<internal>.GuildTemplate>

- Defined in node_modules/snowtransfer/dist/methods/GuildTemplate.d.ts:65
Updates a guild template to match the current state of the guild

Parameters
- guildId: string
  
  The Id of the guild
- code: string
  
  The code of the template
Returns Promise<<internal>.GuildTemplate>
A guild template

Permissions needed Condition

MANAGE_GUILD always

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

requestHandler: <internal>.RequestHandler

Returns <internal>.GuildTemplateMethods

Properties

requestHandler

Methods

createGuildFromGuildTemplate

Parameters

code: string

options: { icon?: null | string; name: string }

Optional icon?: null | string

name: string

Returns Promise<<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/Guild".Guild>

createGuildTemplate

Parameters

guildId: string

data: { description?: null | string; name: string }

Optional description?: null | string

name: string

Returns Promise<<internal>.GuildTemplate>

deleteGuildTemplate

Parameters

guildId: string

code: string

Returns Promise<<internal>.GuildTemplate>

getGuildTemplate

Parameters

code: string

Returns Promise<<internal>.GuildTemplate>

getGuildTemplates

Parameters

guildId: string

Returns Promise<<internal>.GuildTemplate[]>

modifyGuildTemplate

Parameters

guildId: string

code: string

data: { description?: null | string; name?: string }

Optional description?: null | string

Optional name?: string

Returns Promise<<internal>.GuildTemplate>

syncGuildTemplate

Parameters

guildId: string

code: string

Returns Promise<<internal>.GuildTemplate>