Class Guild

Represents a Guild, also called server.

Hierarchy (view full)

Base<string>
- Guild

Constructors

constructor

new Guild(data, client): Guild
Parameters
- data: {
      about?: string;
      avatar?: string;
      banner?: string;
      createdAt: string;
      defaultChannelId?: string;
      id: string;
      isVerified?: boolean;
      name: string;
      ownerId: string;
      timezone?: string;
      type?: ServerType;
      url?: string;
  }
  raw data.
  - Optionalabout?: string
    Description
    
    Description
    The description associated with the server
  - Optionalavatar?: string
    Avatar Format: media-uri
    
    Description
    The avatar image associated with the server
  - Optionalbanner?: string
    Banner Format: media-uri
    
    Description
    The banner image associated with the server
  - createdAt: string
    Created at Format: date-time
    
    Description
    The ISO 8601 timestamp that the server was created at
  - OptionaldefaultChannelId?: string
    Channel ID Format: uuid
    
    Description
    The channel ID of the default channel of the server. This channel is defined as the first chat or voice channel in the left sidebar of a server in our UI. This channel is useful for sending welcome messages, though note that a bot may not have permissions to interact with this channel depending on how the server is configured.
  - id: string
    Server ID
    
    Description
    The ID of the server
  - OptionalisVerified?: boolean
    Is verified
    
    Description
    The verified status of the server
  - name: string
    Server name
    
    Description
    The name given to the server
  - ownerId: string
    Created by
    
    Description
    The ID of the user who created this server
  - Optionaltimezone?: string
    Timezone
    
    Description
    The timezone associated with the server
  - Optionaltype?: ServerType
    Server type
    
    Description
    The type of server designated from the server's settings page
  - Optionalurl?: string
    Server URL
    
    Description
    The URL that the server can be accessible from. For example, a value of "Guilded-Official" means the server can be accessible from https://www.guilded.gg/Guilded-Official
- client: Client
  client.
Returns Guild
Overrides Base.constructor
- Defined in lib/structures/Guild.ts:69

Properties

`Optional`bannerURL

bannerURL?: null | string

Guild banner URL.

Cached guild channels.

Type declaration

OptionalarchivedAt?: string
Archived at Format: date-time

Description
The ISO 8601 timestamp that the channel was archived at, if relevant
OptionalarchivedBy?: string
Archived by

Description
The ID of the user who archived this channel
OptionalcategoryId?: number
Description
The category that the channel exists in. Only relevant for server channels
createdAt: string
Created at Format: date-time

Description
The ISO 8601 timestamp that the channel was created at
createdBy: string
Created by

Description
The ID of the user who created this channel
groupId: string
Group ID

Description
The ID of the group
id: string
Channel ID Format: uuid

Description
The ID of the channel
OptionalmessageId?: string
Message ID Format: uuid

Description
The ID of the message that this channel was created off of. Only applicable to "chat", "voice", and "stream" channels and indicates that this channel is a thread, if present
name: string
Description
The name of the channel
OptionalparentId?: string
Channel ID Format: uuid

Description
ID of the immediate parent channel or thread in the channel hierarchy. Only applicable to "chat", "voice", and "stream" channels and indicates that this channel is a thread, if present
Optionalpriority?: number
Priority

Description
The priority of the channel will determine its position relative to other categories in the group. The higher the value, the higher up it will be displayed in the UI. Returned values can be null, in which case sorting will be done by createdAt in ascending order. Due to legacy issues, sending a null value is not possible
OptionalrootId?: string
Channel ID Format: uuid

Description
ID of the root channel or thread in the channel hierarchy. Only applicable to "chat", "voice", and "stream" channels and indicates that this channel is a thread, if present
serverId: string
Server ID

Description
The ID of the server
Optionaltopic?: string
Description
The topic of the channel. Not applicable to threads
type: ServerChannelType
Description
The type of channel. This will determine what routes to use for creating content in a channel. For example, if this "chat", then one must use the routes for creating channel messages
OptionalupdatedAt?: string
Updated at Format: date-time

Description
The ISO 8601 timestamp that the channel was updated at, if relevant
Optionalvisibility?: null | "private" | "public"
Description
What users can access the channel. Only applicable to server channels. If not present, this channel will respect normal permissions. public is accessible to everyone, even those who aren't of the server. private is only accessible to explicitly mentioned users. Currently, threads cannot be public and other channels cannot be private. Additionally, private threads can only exist with an associated messageId that is for a private message

client

client: Client

App's client.

createdAt

createdAt: Date

When this guild was created.

`Optional`defaultChannelID

defaultChannelID?: string

Default channel of the guild.

`Optional`description

description?: string

Guild description.

groups

groups: TypedCollection<string, {
    archivedAt?: string;
    archivedBy?: string;
    avatar?: string;
    createdAt: string;
    createdBy: string;
    description?: string;
    emoteId?: number;
    id: string;
    isHome?: boolean;
    isPublic: boolean;
    name: string;
    serverId: string;
    updatedAt?: string;
    updatedBy?: string;
}, Group, []>

Cached guild groups

Type declaration

OptionalarchivedAt?: string
Archived at Format: date-time

Description
The ISO 8601 timestamp that the group was archived at, if relevant
OptionalarchivedBy?: string
Archived by

Description
The ID of the user who archived this group
Optionalavatar?: string
Avatar Format: media-uri

Description
The avatar image associated with the group
createdAt: string
Created at Format: date-time

Description
The ISO 8601 timestamp that the group was created at
createdBy: string
Created by

Description
The ID of the user who created this group
Optionaldescription?: string
Description

Description
The description associated with the group
OptionalemoteId?: number
Description
The emote to associate with the group
id: string
Group ID

Description
The ID of the group
OptionalisHome?: boolean
Is home

Description
If true, this is the server's home group
isPublic: boolean
Is public
Description
Is this group open for anyone to join?

Default
```
false
```
name: string
Description
The name of the group
serverId: string
Server ID

Description
The ID of the server
OptionalupdatedAt?: string
Updated at Format: date-time

Description
The ISO 8601 timestamp that the group was updated at, if relevant
OptionalupdatedBy?: string
Updated by

Description
The ID of the user who updated this group

`Optional`iconURL

iconURL?: null | string

Guild icon URL.

id

id: string

Item ID

members

members: TypedCollection<string, {
    isOwner: boolean;
    joinedAt: string;
    nickname?: string;
    roleIds: number[];
    user: {
        avatar?: string;
        banner?: string;
        createdAt: string;
        id: string;
        name: string;
        status?: {
            content?: string;
            emoteId: number;
        };
        type?: UserType;
    };
}, Member, [guildID: string]>

Cached guild members.

Type declaration

isOwner: boolean
Is owner
Default
```
false
```
joinedAt: string
Created at Format: date-time

Description
The ISO 8601 timestamp that the member was created at
Optionalnickname?: string
Nickname
roleIds: number[]
Role IDs
user: {
    avatar?: string;
    banner?: string;
    createdAt: string;
    id: string;
    name: string;
    status?: {
        content?: string;
        emoteId: number;
    };
    type?: UserType;
}
- Optionalavatar?: string
  Avatar Format: media-uri
  
  Description
  The avatar image associated with the user
- Optionalbanner?: string
  Banner Format: media-uri
  
  Description
  The banner image associated with the user
- createdAt: string
  Created at Format: date-time
  
  Description
  The ISO 8601 timestamp that the user was created at
- id: string
  User ID Format: user-id
  
  Description
  The ID of the user
- name: string
  User name
  
  Description
  The user's name
- Optionalstatus?: {
  content?: string;
  emoteId: number;
  }
  - Optionalcontent?: string
    Content Format: status markdown
    
    Description
    The content of the user status. The supported markdown for this content only includes reactions and plaintext for now
  - emoteId: number
    Description
    Emote ID
- Optionaltype?: UserType
  User type
  
  Description
  The type of user. If this property is absent, it can assumed to be of type user

name

name: string

The name of the guild.

ownerID

ownerID: string

ID of the guild owner.

roles

roles: TypedCollection<number, {
    botUserId?: string;
    colors?: number[];
    createdAt: string;
    icon?: string;
    id: number;
    isBase: boolean;
    isDisplayedSeparately: boolean;
    isMentionable: boolean;
    isSelfAssignable: boolean;
    name: string;
    permissions: string[];
    priority?: number;
    serverId: string;
    updatedAt?: string;
}, Role, []>

Cached guild roles.

Type declaration

OptionalbotUserId?: string
Bot user ID Format: user-id

Description
The bot user ID this role has been defined for. Roles with this populated can only be deleted by kicking the bot
Optionalcolors?: number[]
Description
An array of integer values corresponding to the decimal RGB representation for a color. The first color is solid, and a second color indicates a gradient
createdAt: string
Created at Format: date-time

Description
The ISO 8601 timestamp that the role was created at
Optionalicon?: string
Role icon URL Format: media-uri

Description
The URL of the role icon
id: number
Role ID

Description
The ID of the role
isBase: boolean
Is Base
Description
The default role users are given when joining the server. Base roles are tied directly to the server and cannot be created or deleted

Default
```
false
```
isDisplayedSeparately: boolean
Display Separately
Description
If set, the role will be displayed separately in the channel member list

Default
```
false
```
isMentionable: boolean
Mentionable
Description
If set, this role can be mentioned

Default
```
false
```
isSelfAssignable: boolean
Self Assignable
Description
If set, this roll will be self assigned

Default
```
false
```
name: string
Role name

Description
The role's name
permissions: string[]
Description
Permissions must be a collection of valid permissions as defined in the Enums/Permissions section
Optionalpriority?: number
Priority

Description
The priority the role will be in relation to other roles in the server. The higher the value, the more precedence the role has over lower priority roles, and the higher up it will be displayed in the UI. Values can be zero or negative!
serverId: string
Server ID

Description
The ID of the server
OptionalupdatedAt?: string
Updated at Format: date-time

Description
The ISO 8601 timestamp that the role was updated at, if relevant

`Optional`timezone

timezone?: string

Guild's timezone.

`Optional`type

type?: string

Guild type.

`Optional`url

url?: string

The URL of the guild.

verified

verified: boolean

If true, the guild is verified.

Accessors

owner

get owner(): User | Member | Promise<Member>
Retrieve cached or rest guild's owner.

Returns User | Member | Promise<Member>
- Defined in lib/structures/Guild.ts:129

Methods

awardMember

awardMember(memberID, amount): Promise<number>
Award a member using the built-in EXP system.
Parameters
- memberID: string
  ID of the member to award.
- amount: number
  Amount of experience to give.
Returns Promise<number>
- Defined in lib/structures/Guild.ts:139

awardRole

awardRole(roleID, amount): Promise<void>
Award every member of a guild having a role using the built-in EXP system.
Parameters
- roleID: number
  ID of a role.
- amount: number
  Amount of experience.
Returns Promise<void>
- Defined in lib/structures/Guild.ts:147

bulkAwardXPMembers

bulkAwardXPMembers(options): Promise<{
    totalsByUserId: {
        [key: string]: number;
    };
}>
Bulk Award XP Members
Parameters
- options: BulkXPOptions
  Members to award XP and amount of XP to award.
Returns Promise<{
    totalsByUserId: {
        [key: string]: number;
    };
}>
- Defined in lib/structures/Guild.ts:154

bulkSetXPMembers

bulkSetXPMembers(options): Promise<{
    totalsByUserId: {
        [key: string]: number;
    };
}>
Bulk set XP Members
Parameters
- options: BulkXPOptions
  Members to set XP and amount of XP to set.
Returns Promise<{
    totalsByUserId: {
        [key: string]: number;
    };
}>
- Defined in lib/structures/Guild.ts:161

createBan

createBan(memberID, reason?): Promise<BannedMember>
Ban a member.
Parameters
- memberID: string
  ID of the member to ban.
- Optionalreason: string
  The reason of the ban.
Returns Promise<BannedMember>
- Defined in lib/structures/Guild.ts:169

createCategory

createCategory(options): Promise<Category>
Create a category
Parameters
- options: {
  groupId?: string;
  name: string;
  }
  Create options.
  - OptionalgroupId?: string
    Group ID
    
    Description
    The ID of the group. If not provided, the category will be created in the "Server home" group from serverId.
  - name: string
    Description
    Name of the category
Returns Promise<Category>
- Defined in lib/structures/Guild.ts:177

deleteCategory

deleteCategory(categoryID): Promise<Category>
Delete a category.
Parameters
- categoryID: number
  ID of the category you want to read.
Returns Promise<Category>
- Defined in lib/structures/Guild.ts:185

editCategory

editCategory(categoryID, options): Promise<Category>
Edit a category.
Parameters
- categoryID: number
  ID of the category you want to read.
- options: {
  name?: string;
  priority?: number;
  }
  Options to update a category.
  - Optionalname?: string
    Description
    Name of the category
  - Optionalpriority?: number
    Priority
    
    Description
    The priority of the category will determine its position relative to other categories in the group. The higher the value, the higher up it will be displayed in the UI. Returned values can be null, in which case sorting will be done by createdAt in descending order. Due to legacy issues, sending a null value is not possible
Returns Promise<Category>
- Defined in lib/structures/Guild.ts:194

getCategory

getCategory(categoryID): Promise<Category>
Read a guild category.
Parameters
- categoryID: number
  ID of the category you want to read.
Returns Promise<Category>
- Defined in lib/structures/Guild.ts:202

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
- Defined in lib/structures/Guild.ts:209

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
- Defined in lib/structures/Guild.ts:217

getSubscription

getSubscription(subscriptionID): Promise<Subscription>
Get Subscription
Parameters
- subscriptionID: string
  ID of the subscription to get.
Returns Promise<Subscription>
- Defined in lib/structures/Guild.ts:225

getSubscriptions

getSubscriptions(): Promise<Subscription[]>
Get Subscriptions

Returns Promise<Subscription[]>
- Defined in lib/structures/Guild.ts:230

removeBan

removeBan(memberID): Promise<void>
Unban a member.
Parameters
- memberID: string
  ID of the member to unban.
Returns Promise<void>
- Defined in lib/structures/Guild.ts:237

setMemberXP

setMemberXP(memberID, amount): Promise<number>
Set member's experience using the built-in EXP system.
Parameters
- memberID: string
  ID of the member to award.
- amount: number
  Amount of experience to set.
Returns Promise<number>
- Defined in lib/structures/Guild.ts:245

toJSON

toJSON(): JSONGuild
Returns JSONGuild
Overrides Base.toJSON
- Defined in lib/structures/Guild.ts:249

Class Guild

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optionalabout?: string

Description

Optionalavatar?: string

Description

Optionalbanner?: string

Description

createdAt: string

Description

OptionaldefaultChannelId?: string

Description

id: string

Description

OptionalisVerified?: boolean

Description

name: string

Description

ownerId: string

Description

Optionaltimezone?: string

Description

Optionaltype?: ServerType

Description

Optionalurl?: string

Description

Returns Guild

Properties

OptionalbannerURL

channels

Type declaration

OptionalarchivedAt?: string

Description

OptionalarchivedBy?: string

Description

OptionalcategoryId?: number

Description

createdAt: string

Description

createdBy: string

Description

groupId: string

Description

id: string

Description

OptionalmessageId?: string

Description

name: string

Description

OptionalparentId?: string

Description

Optionalpriority?: number

Description

OptionalrootId?: string

Description

serverId: string

Description

Optionaltopic?: string

Description

type: ServerChannelType

Description

OptionalupdatedAt?: string

Description

Optionalvisibility?: null | "private" | "public"

Description

client

createdAt

OptionaldefaultChannelID

Optionaldescription

groups

Type declaration

OptionalarchivedAt?: string

`Optional`about?: string

`Optional`avatar?: string

`Optional`banner?: string

`Optional`defaultChannelId?: string

`Optional`isVerified?: boolean

`Optional`timezone?: string

`Optional`type?: ServerType

`Optional`url?: string

`Optional`bannerURL

`Optional`archivedAt?: string

`Optional`archivedBy?: string

`Optional`categoryId?: number

`Optional`messageId?: string

`Optional`parentId?: string

`Optional`priority?: number

`Optional`rootId?: string

`Optional`topic?: string

`Optional`updatedAt?: string

`Optional`visibility?: null | "private" | "public"

`Optional`defaultChannelID

`Optional`description

`Optional`archivedAt?: string

`Optional`archivedBy?: string

`Optional`avatar?: string

`Optional`description?: string

`Optional`emoteId?: number

`Optional`isHome?: boolean

`Optional`updatedAt?: string

`Optional`updatedBy?: string

`Optional`iconURL

`Optional`nickname?: string

user: {
avatar?: string;
banner?: string;
createdAt: string;
id: string;
name: string;
status?: {
content?: string;
emoteId: number;
};
type?: UserType;
}

`Optional`avatar?: string

`Optional`banner?: string

`Optional`status?: {
content?: string;
emoteId: number;
}

`Optional`content?: string

`Optional`type?: UserType

`Optional`botUserId?: string

`Optional`colors?: number[]

`Optional`icon?: string