Class Guild

constructor

• new Guild(data, client): Guild

• Parameters

  • data: APIGuild

    raw data.

  • client: Client

    client.

  Returns Guild

Optional bannerURL

channels

createdAt

Optional defaultChannelID

Optional description

groups

Optional iconURL

members

name

ownerID

roles

Optional timezone

Optional type

Optional url

verified

owner

• get owner(): Member | Promise<Member> | User

• Retrieve cached or rest guild's owner.

  Returns Member | Promise<Member> | User

bulkAwardXPMembers

• bulkAwardXPMembers(options): Promise<POSTBulkAwardXPResponse>

• Bulk Award XP Members

  Parameters

  • options: POSTBulkAwardXPBody

    Members to award XP and amount of XP to award.

  Returns Promise<POSTBulkAwardXPResponse>

bulkSetXPMembers

• bulkSetXPMembers(options): Promise<POSTBulkAwardXPResponse>

• Bulk set XP Members

  Parameters

  • options: POSTBulkAwardXPBody

    Members to set XP and amount of XP to set.

  Returns Promise<POSTBulkAwardXPResponse>

createBan

• createBan(memberID, reason?): Promise<BannedMember>

• Ban a member.

  Parameters

  • memberID: string

    ID of the member to ban.

  • Optional reason: string

    The reason of the ban.

  Returns Promise<BannedMember>

createCategory

• createCategory(options): Promise<GuildCategory>

• Create a category

  Parameters

  • options: POSTCreateCategoryBody

    Create options.

  Returns Promise<GuildCategory>

deleteCategory

• deleteCategory(categoryID): Promise<GuildCategory>

• Delete a category.

  Parameters

  • categoryID: number

    ID of the category you want to read.

  Returns Promise<GuildCategory>

editCategory

• editCategory(categoryID, options): Promise<GuildCategory>

• Edit a category.

  Parameters

  • categoryID: number

    ID of the category you want to read.

  • options: PATCHUpdateCategoryBody

    Options to update a category.

  Returns Promise<GuildCategory>

getCategory

• getCategory(categoryID): Promise<GuildCategory>

• Read a guild category.

  Parameters

  • categoryID: number

    ID of the category you want to read.

  Returns Promise<GuildCategory>

getChannel

• getChannel(channelID): undefined | Channel

• Get a channel from this guild, if cached.

  Parameters

  • channelID: string

    The ID of the channel to get from cache.

  Returns undefined | Channel

getMember

• getMember(memberID): undefined | Member

• Get a member from this guild, if cached.

  Parameters

  • memberID: string

    The ID of the member to get.

  Returns undefined | Member

getSubscription

• getSubscription(subscriptionID): Promise<GuildSubscription>

• Get Subscription

  Parameters

  • subscriptionID: string

    ID of the subscription to get.

  Returns Promise<GuildSubscription>

getSubscriptions

• getSubscriptions(): Promise<GuildSubscription[]>

• Get Subscriptions

  Returns Promise<GuildSubscription[]>

removeBan

• removeBan(memberID): Promise<void>

• Unban a member.

  Parameters

  • memberID: string

    ID of the member to unban.

  Returns Promise<void>

toJSON

• toJSON(): JSONGuild

• Returns JSONGuild