Class Guild

Represents a Guild, also called server.

Hierarchy

Constructors

constructor

Properties

bannerURL? channels client createdAt defaultChannelID? description? iconURL? id members name ownerID timezone? type? url? verified

Accessors

owner

Methods

createBan getChannel getMember removeBan toJSON

Constructors

constructor

Properties

Optional bannerURL

bannerURL?: null | string

Guild banner URL.

channels

channels: TypedCollection<string, APIGuildChannel, AnyChannel, []>

Cached guild channels.

client

client: Client

Bot'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.

Optional iconURL

iconURL?: null | string

Guild icon URL.

id

id: string

Item ID

members

members: TypedCollection<string, APIGuildMember, Member, [guildID: string]>

Cached guild members.

name

name: string

The name of the guild.

ownerID

ownerID: string

ID of the guild owner.

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

Methods

createBan

getChannel

  • Get a channel from this guild, if cached.

    Parameters

    • channelID: string

      The ID of the channel to get from cache.

    Returns undefined | Channel

getMember

  • Get a member from this guild, if cached.

    Parameters

    • memberID: string

      The ID of the member to get.

    Returns undefined | Member

removeBan

  • Unban a member.

    Parameters

    • memberID: string

      ID of the member to unban.

    Returns Promise<void>

toJSON

Settings

Member Visibility

Theme