Class Guilds

Hierarchy

Guilds

Constructors

constructor

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

Methods

awardMember

awardMember(guildID, memberID, amount): 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:289

awardRole

awardRole(guildID, roleID, amount): 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:317

createBan

createBan(guildID, memberID, reason?): 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:224

createChannel

createChannel<T>(guildID, name, type, options?): 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:332

createGroup

createGroup(guildID, options): Promise<GuildGroup>
Create a guild group.
Parameters
- guildID: string
  
  The ID of the guild to create a group in.
- options: POSTGuildGroupBody
  
  Create options
Returns Promise<GuildGroup>
- Defined in lib/routes/Guilds.ts:470

createRole

createRole(guildID, options): Promise<GuildRole>
Create a guild role.
Parameters
- guildID: string
  
  ID of the server you want to create the role in.
- options: POSTGuildRoleBody
  
  Create options
Returns Promise<GuildRole>
- Defined in lib/routes/Guilds.ts:408

createWebhook

createWebhook(guildID, channelID, name): 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:248

deleteChannel

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

deleteGroup

deleteGroup(guildID, groupID): Promise<void>
Delete a guild group
Parameters
- guildID: string
  
  ID of the guild where the group is in.
- groupID: string
  
  ID of the group to delete.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:497

deleteRole

deleteRole(guildID, roleID): Promise<void>
Delete a guild role.
Parameters
- guildID: string
  
  ID of the guild where the role to delete is in
- roleID: number
  
  ID of the role to delete
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:435

deleteWebhook

deleteWebhook(guildID, webhookID): 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:277

editChannel

editChannel<T>(channelID, options): 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:356

editGroup

editGroup(guildID, groupID, options): Promise<GuildGroup>
Edit a guild group.
Parameters
- guildID: string
  
  The ID of the guild where the group to edit is in
- groupID: string
  
  The ID of the group to edit.
- options: PATCHGuildGroupBody
  
  Edit options
Returns Promise<GuildGroup>
- Defined in lib/routes/Guilds.ts:484

editMember

editMember(guildID, memberID, options): 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:191

editRole

editRole(guildID, roleID, options): Promise<GuildRole>
Edit a guild role.
Parameters
- guildID: string
  
  ID of the server
- roleID: number
  
  ID of the role to edit
- options: PATCHGuildRoleBody
  
  Edit options
Returns Promise<GuildRole>
- Defined in lib/routes/Guilds.ts:422

editWebhook

editWebhook(guildID, webhookID, options): 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:264

getBan

getBan(guildID, memberID): 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:123

getBans

getBans(guildID): 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:133

getGroup

getGroup(guildID, groupID): Promise<GuildGroup>
Get a guild group.
Parameters
- guildID: string
  
  ID of the guild.
- groupID: string
  
  ID of the group to get.
Returns Promise<GuildGroup>
- Defined in lib/routes/Guilds.ts:458

getGroups

getGroups(guildID): Promise<GuildGroup[]>
Get guild groups.
Parameters
- guildID: string
  
  ID of the guild.
Returns Promise<GuildGroup[]>
- Defined in lib/routes/Guilds.ts:446

getGuild

getGuild(guildID): 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:64

getMember

getMember(guildID, memberID): 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:102

getMemberPermission

getMemberPermission(guildID, memberID): Promise<Permissions[]>
Get guild member permissions.
Parameters
- guildID: string
  
  ID of the guild.
- memberID: string
  
  ID of the member.
Returns Promise<Permissions[]>
- Defined in lib/routes/Guilds.ts:533

getMembers

getMembers(guildID): 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:112

getRole

getRole(guildID, roleID): Promise<GuildRole>
Get a guild role.
Parameters
- guildID: string
  
  ID of the guild where the role is.
- roleID: number
  
  ID of the role to get.
Returns Promise<GuildRole>
- Defined in lib/routes/Guilds.ts:396

getRoles

getRoles(guildID): Promise<GuildRole[]>
Get every guild roles from a guild.
Parameters
- guildID: string
  
  ID of the guild where roles are.
Returns Promise<GuildRole[]>
- Defined in lib/routes/Guilds.ts:384

getSubscription

getSubscription(guildID, subscriptionID): Promise<GuildSubscription>
Get guild subscriptions.
Parameters
- guildID: string
  
  ID of the guild.
- subscriptionID: string
  
  ID of the subscription to get.
Returns Promise<GuildSubscription>
- Defined in lib/routes/Guilds.ts:521

getSubscriptions

getSubscriptions(guildID): Promise<GuildSubscription[]>
Get guild subscriptions.
Parameters
- guildID: string
  
  ID of the guild.
Returns Promise<GuildSubscription[]>
- Defined in lib/routes/Guilds.ts:509

getWebhook

getWebhook(guildID, webhookID): 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:75

getWebhooks

getWebhooks(guildID, channelID): 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:86

memberAddGroup

memberAddGroup(groupID, memberID): 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:144

memberAddRole

memberAddRole(guildID, memberID, roleID): 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:167

memberRemoveGroup

memberRemoveGroup(groupID, memberID): 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:155

memberRemoveRole

memberRemoveRole(guildID, memberID, roleID): 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:179

removeBan

removeBan(guildID, memberID): 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:236

removeMember

removeMember(guildID, memberID): 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:212

setMemberXP

setMemberXP(guildID, memberID, amount): 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:303

updateRolePermission

updateRolePermission(guildID, roleID, options): Promise<GuildRole>
Edit Role Permission.
Parameters
- guildID: string
  
  ID of the guild.
- roleID: number
  
  ID of the role.
- options: PATCHGuildRoleBody
  
  Permissions to edit.
Returns Promise<GuildRole>
- Defined in lib/routes/Guilds.ts:546

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>

createGroup

Parameters

guildID: string

options: POSTGuildGroupBody

Returns Promise<GuildGroup>

createRole

Parameters

guildID: string

options: POSTGuildRoleBody

Returns Promise<GuildRole>

createWebhook

Parameters

guildID: string

channelID: string

name: string

Returns Promise<Webhook>

deleteChannel

Parameters

channelID: string

Returns Promise<void>

deleteGroup

Parameters

guildID: string

groupID: string

Returns Promise<void>

deleteRole

Parameters

guildID: string

roleID: number

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>

`Optional` reason: string

`Optional` options: CreateChannelOptions