Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Guild

Hierarchy

  • Guild

Implements

  • Component

Index

Properties

Methods

Properties

api

api: ComponentAPI

name

name: string = "RestGuild"

parent

parent: PluginReference = Rest

Private rest

rest: Rest

Methods

addMemberRole

  • addMemberRole(guildID: string, memberID: string, roleID: string, reason: string): Promise<never>

ban

  • ban(guildID: string, memberID: string, data: RESTPutAPIGuildBanJSONBody): Promise<never>

createChannel

  • createChannel(guildID: string, data: RESTPostAPIGuildChannelJSONBody): Promise<APIChannel>

createEmoji

  • createEmoji(guildId: string, data: RESTPostAPIGuildEmojiJSONBody): Promise<APIEmoji>

createRole

  • createRole(guildID: string, data: RESTPostAPIGuildRoleJSONBody): Promise<APIRole>

deleteEmoji

  • deleteEmoji(guildId: string, emojiID: string): Promise<never>

deleteRole

  • deleteRole(guildID: string, roleID: string): Promise<never>

get

  • get(guildID: string): Promise<APIGuild>

getBan

  • getBan(guildID: string, memberID: string): Promise<APIBan>

getBans

  • getBans(guildID: string): Promise<RESTGetAPIGuildBansResult>

getChannels

  • getChannels(guildID: string): Promise<RESTGetAPIGuildChannelsResult>

getEmoji

  • getEmoji(guildId: string, emojiID: string): Promise<APIEmoji>

getEmojis

  • getEmojis(guildId: string): Promise<RESTGetAPIGuildEmojisResult>

getInvites

  • getInvites(guildID: string): Promise<RESTGetAPIGuildInvitesResult>

getRoles

  • getRoles(guildID: string): Promise<RESTGetAPIGuildRolesResult>

getWidget

  • getWidget(guildID: string): Promise<APIGuildWidget>

getWidgetImage

  • getWidgetImage(guildID: string): Promise<ArrayBuffer>

kickMember

  • kickMember(guildId: string, memberID: string, reason?: undefined | string): Promise<never>

leave

  • leave(guildID: string): Promise<never>

moveChannels

  • moveChannels(guildID: string, data: RESTPatchAPIGuildChannelPositionsJSONBody): Promise<never>

moveRole

  • moveRole(guildID: string, data: RESTPatchAPIGuildRolePositionsJSONBody): Promise<RESTPatchAPIGuildRolePositionsResult>

removeMemberRole

  • removeMemberRole(guildID: string, memberID: string, roleID: string, reason: string): Promise<never>

unban

  • unban(guildID: string, memberID: string): Promise<never>

update

  • update(guildID: string, update: RESTPatchAPIGuildJSONBody): Promise<APIGuild>

updateEmoji

  • updateEmoji(guildId: string, emojiID: string, data: RESTPatchAPIGuildEmojiJSONBody): Promise<APIEmoji>

updateMember

  • updateMember(guildID: string, memberID: string, data: RESTPatchAPIGuildMemberJSONBody): Promise<RESTPatchAPIGuildMemberJSONBody>

updateRole

  • updateRole(guildID: string, roleID: string, data: RESTPatchAPIGuildRoleJSONBody): Promise<APIRole>

updateWidget

  • updateWidget(guildID: string, data: RESTPatchAPIGuildWidgetSettingsJSONBody): Promise<APIGuildWidgetSettings>

vanity

  • vanity(guildID: string): Promise<RESTGetAPIGuildVanityUrlResult>

voiceRegion

  • voiceRegion(guildID: string): Promise<RESTGetAPIGuildVoiceRegionsResult>

voiceRegions

  • voiceRegions(): Promise<RESTGetAPIGuildVoiceRegionsResult>

Generated using TypeDoc