Class Guilds

Hierarchy

Guilds

Index

Constructors

Methods

awardMember awardRole createChannel createWebhook deleteChannel deleteWebhook editChannel editWebhook getGuild getMember getWebhook getWebhooks memberAddGroup memberAddRole memberRemoveGroup memberRemoveRole setMemberXP

Constructors

constructor

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

Methods

awardMember

awardMember(guildID: string, memberID: string, amount: number): Promise<number>
Parameters
- guildID: string
- memberID: string
- amount: number
Returns Promise<number>
- Defined in lib/routes/Guilds.ts:121

awardRole

awardRole(guildID: string, roleID: number, amount: number): Promise<void>
Parameters
- guildID: string
- roleID: number
- amount: number
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:139

createChannel

createChannel(guildID: string, name: string, type: APIChannelCategories, options?: CreateChannelOptions): Promise<Channel>
Parameters
- guildID: string
- name: string
- type: APIChannelCategories
- Optional options: CreateChannelOptions
Returns Promise<Channel>
- Defined in lib/routes/Guilds.ts:148

createWebhook

createWebhook(guildID: string, channelID: string, name: string): Promise<Webhook>
Parameters
- guildID: string
- channelID: string
- name: string
Returns Promise<Webhook>
- Defined in lib/routes/Guilds.ts:94

deleteChannel

deleteChannel(channelID: string): Promise<void>
Parameters
- channelID: string
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:177

deleteWebhook

deleteWebhook(guildID: string, webhookID: string): Promise<void>
Parameters
- guildID: string
- webhookID: string
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:114

editChannel

editChannel(channelID: string, options: EditChannelOptions): Promise<Channel>
Parameters
- channelID: string
- options: EditChannelOptions
Returns Promise<Channel>
- Defined in lib/routes/Guilds.ts:168

editWebhook

editWebhook(guildID: string, webhookID: string, options: EditWebhookOptions): Promise<Webhook>
Parameters
- guildID: string
- webhookID: string
- options: EditWebhookOptions
Returns Promise<Webhook>
- Defined in lib/routes/Guilds.ts:105

getGuild

getGuild(guildID: string): Promise<Guild>
Parameters
- guildID: string
Returns Promise<Guild>
- Defined in lib/routes/Guilds.ts:33

getMember

getMember(guildID: string, memberID: string): Promise<Member>
Parameters
- guildID: string
- memberID: string
Returns Promise<Member>
- Defined in lib/routes/Guilds.ts:59

getWebhook

getWebhook(guildID: string, webhookID: string): Promise<Webhook>
Parameters
- guildID: string
- webhookID: string
Returns Promise<Webhook>
- Defined in lib/routes/Guilds.ts:40

getWebhooks

getWebhooks(guildID: string, channelID: string): Promise<Webhook[]>
Parameters
- guildID: string
- channelID: string
Returns Promise<Webhook[]>
- Defined in lib/routes/Guilds.ts:47

memberAddGroup

memberAddGroup(groupID: string, memberID: string): Promise<void>
Parameters
- groupID: string
- memberID: string
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:66

memberAddRole

memberAddRole(guildID: string, memberID: string, roleID: number): Promise<void>
Parameters
- guildID: string
- memberID: string
- roleID: number
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:80

memberRemoveGroup

memberRemoveGroup(groupID: string, memberID: string): Promise<void>
Parameters
- groupID: string
- memberID: string
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:73

memberRemoveRole

memberRemoveRole(guildID: string, memberID: string, roleID: number): Promise<void>
Parameters
- guildID: string
- memberID: string
- roleID: number
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:87

setMemberXP

setMemberXP(guildID: string, memberID: string, amount: number): Promise<number>
Parameters
- guildID: string
- memberID: string
- amount: number
Returns Promise<number>
- Defined in lib/routes/Guilds.ts:130