Class Guilds

Hierarchy

Guilds

Constructors

constructor

new Guilds(manager: RESTManager): Guilds
Parameters
- manager: RESTManager
Returns Guilds
- Defined in lib/routes/Guilds.ts:36

Methods

awardMember

awardMember(guildID: string, memberID: string, amount: number): Promise<number>
Award a member using the built-in EXP system.
Parameters
- guildID: string
  
  ID of a guild.
- memberID: string
  
  ID of a member.
- amount: number
  
  Amount of experience.
Returns Promise<number>
- Defined in lib/routes/Guilds.ts:270

awardRole

awardRole(guildID: string, roleID: number, amount: number): Promise<void>
Award every members of a guild having a role using the built-in EXP system.
Parameters
- guildID: string
  
  ID of a guild.
- roleID: number
  
  ID of a role.
- amount: number
  
  Amount of experience.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:298

createBan

createBan(guildID: string, memberID: string, reason?: string): Promise<BannedMember>
Ban a guild member.
Parameters
- guildID: string
  
  ID of the guild the member is in.
- memberID: string
  
  ID of the member to ban.
- Optional reason: string
  
  The reason of the ban.
Returns Promise<BannedMember>
- Defined in lib/routes/Guilds.ts:205

createChannel

createChannel<T>(guildID: string, name: string, type: APIChannelCategories, options?: CreateChannelOptions): Promise<T>
Create a channel in a specified guild.
Type Parameters
- T extends AnyChannel = AnyChannel
Parameters
- guildID: string
  
  ID of a guild.
- name: string
  
  Name of the new channel.
- type: APIChannelCategories
  
  Type of the new channel. (e.g: chat)
- Optional options: CreateChannelOptions
  
  New channel's additional options.
Returns Promise<T>
- Defined in lib/routes/Guilds.ts:313

createWebhook

createWebhook(guildID: string, channelID: string, name: string): Promise<Webhook>
Create a webhook
Parameters
- guildID: string
  
  ID of a guild.
- channelID: string
  
  ID of a channel.
- name: string
  
  Name of the new webhook.
Returns Promise<Webhook>
- Defined in lib/routes/Guilds.ts:229

deleteChannel

deleteChannel(channelID: string): Promise<void>
Delete a channel.
Parameters
- channelID: string
  
  ID of the channel to delete.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:353

deleteWebhook

deleteWebhook(guildID: string, webhookID: string): Promise<void>
Delete a webhook
Parameters
- guildID: string
  
  ID of a guild.
- webhookID: string
  
  ID of an existent webhook.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:258

editChannel

editChannel<T>(channelID: string, options: EditChannelOptions): Promise<T>
Edit a channel.
Type Parameters
- T extends AnyChannel = AnyChannel
Parameters
- channelID: string
  
  ID of the channel to edit.
- options: EditChannelOptions
  
  Channel edit options.
Returns Promise<T>
- Defined in lib/routes/Guilds.ts:337

editMember

editMember(guildID: string, memberID: string, options: EditMemberOptions): Promise<void>
Edit a member.
Parameters
- guildID: string
  
  ID of the guild the member is in.
- memberID: string
  
  ID of the the member to edit.
- options: EditMemberOptions
  
  Edit options.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:172

editWebhook

editWebhook(guildID: string, webhookID: string, options: EditWebhookOptions): Promise<Webhook>
Update a webhook
Parameters
- guildID: string
  
  ID of a guild.
- webhookID: string
  
  ID of an existent webhook.
- options: EditWebhookOptions
  
  Edit options.
Returns Promise<Webhook>
- Defined in lib/routes/Guilds.ts:245

getBan

getBan(guildID: string, memberID: string): Promise<BannedMember>
Get a ban.
Parameters
- guildID: string
  
  ID of the guild.
- memberID: string
  
  ID of the banned member.
Returns Promise<BannedMember>
- Defined in lib/routes/Guilds.ts:104

getBans

getBans(guildID: string): Promise<BannedMember[]>
This method is used to get a list of guild ban.
Parameters
- guildID: string
  
  ID of the guild.
Returns Promise<BannedMember[]>
- Defined in lib/routes/Guilds.ts:114

getGuild

getGuild(guildID: string): Promise<Guild>
This method is used to get a specific Guild.

Note: Guild = Server
Parameters
- guildID: string
  
  The ID of the guild you'd like to get.
Returns Promise<Guild>
- Defined in lib/routes/Guilds.ts:45

getMember

getMember(guildID: string, memberID: string): Promise<Member>
This method is used to get a specific guild member.
Parameters
- guildID: string
  
  The ID of the Guild.
- memberID: string
  
  The ID of the Guild Member to get.
Returns Promise<Member>
- Defined in lib/routes/Guilds.ts:83

getMembers

getMembers(guildID: string): Promise<Member[]>
This method is used to get a list of guild member.
Parameters
- guildID: string
  
  ID of the guild to get members.
Returns Promise<Member[]>
- Defined in lib/routes/Guilds.ts:93

getWebhook

getWebhook(guildID: string, webhookID: string): Promise<Webhook>
This method is used to get a specific webhook.
Parameters
- guildID: string
  
  ID of a guild.
- webhookID: string
  
  ID of a webhook.
Returns Promise<Webhook>
- Defined in lib/routes/Guilds.ts:56

getWebhooks

getWebhooks(guildID: string, channelID: string): Promise<Webhook[]>
This method is used to get a list of Webhook.
Parameters
- guildID: string
  
  ID of a guild.
- channelID: string
  
  ID of a channel.
Returns Promise<Webhook[]>
- Defined in lib/routes/Guilds.ts:67

memberAddGroup

memberAddGroup(groupID: string, memberID: string): Promise<void>
Add a member to a group
Parameters
- groupID: string
  
  ID of a guild group.
- memberID: string
  
  ID of a member.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:125

memberAddRole

memberAddRole(guildID: string, memberID: string, roleID: number): Promise<void>
Add a role to a member
Parameters
- guildID: string
  
  ID of a guild.
- memberID: string
  
  ID of a member.
- roleID: number
  
  ID of a role.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:148

memberRemoveGroup

memberRemoveGroup(groupID: string, memberID: string): Promise<void>
Remove a member from a group
Parameters
- groupID: string
  
  ID of a guild group.
- memberID: string
  
  ID of a member.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:136

memberRemoveRole

memberRemoveRole(guildID: string, memberID: string, roleID: number): Promise<void>
Remove a role from a member
Parameters
- guildID: string
  
  ID of a guild.
- memberID: string
  
  ID of a member.
- roleID: number
  
  ID of a role.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:160

removeBan

removeBan(guildID: string, memberID: string): Promise<void>
Unban a guild member.
Parameters
- guildID: string
  
  ID of the guild the member was in.
- memberID: string
  
  ID of the member to unban.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:217

removeMember

removeMember(guildID: string, memberID: string): Promise<void>
Remove a member from a guild.
Parameters
- guildID: string
  
  The ID of the guild the member is in.
- memberID: string
  
  The ID of the member to kick.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:193

setMemberXP

setMemberXP(guildID: string, memberID: string, amount: number): Promise<number>
Set a member's xp using the built-in EXP system.
Parameters
- guildID: string
  
  ID of a guild.
- memberID: string
  
  ID of a member.
- amount: number
  
  Total amount of experience.
Returns Promise<number>
- Defined in lib/routes/Guilds.ts:284

Class Guilds

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

manager: RESTManager

Returns Guilds

Methods

awardMember

Parameters

guildID: string

memberID: string

amount: number

Returns Promise<number>

awardRole

Parameters

guildID: string

roleID: number

amount: number

Returns Promise<void>

createBan

Parameters

guildID: string

memberID: string

Optional reason: string

Returns Promise<BannedMember>

createChannel

Type Parameters

T extends AnyChannel = AnyChannel

Parameters

guildID: string

name: string

type: APIChannelCategories

Optional options: CreateChannelOptions

Returns Promise<T>

createWebhook

Parameters

guildID: string

channelID: string

name: string

Returns Promise<Webhook>

deleteChannel

Parameters

channelID: string

Returns Promise<void>

deleteWebhook

Parameters

guildID: string

webhookID: string

Returns Promise<void>

editChannel

Type Parameters

T extends AnyChannel = AnyChannel

Parameters

channelID: string

options: EditChannelOptions

Returns Promise<T>

editMember

Parameters

guildID: string

memberID: string

options: EditMemberOptions

Returns Promise<void>

editWebhook

Parameters

guildID: string

webhookID: string

options: EditWebhookOptions

Returns Promise<Webhook>

getBan

Parameters

guildID: string

memberID: string

Returns Promise<BannedMember>

getBans

Parameters

guildID: string

`Optional` reason: string

`Optional` options: CreateChannelOptions