Class Guild

Represents a Guild, also called server.

Hierarchy

Constructors

constructor

Properties

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

Accessors

owner

Methods

createBan getChannel removeBan

Constructors

constructor

Properties

Optional bannerURL

bannerURL?: null | string

Guild banner URL.

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 | number

Item ID

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.

Accessors

owner

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

  • Retrieve guild's owner, if cached. If there is no cached member or user, this will make a request which returns a Promise. If the request fails, this will throw an error or return you undefined as a value.

    Returns undefined | User | Member | Promise<Member>

Methods

createBan

  • Ban a member.

    Parameters

    • memberID: string

      ID of the member to ban.

    • Optional reason: string

      The reason of the ban.

    Returns Promise<BannedMember>

getChannel

  • Get a channel from this guild.

    Parameters

    • channelID: string

      The ID of the channel to get.

    Returns Promise<Channel>

removeBan

  • Unban a member.

    Parameters

    • memberID: string

      ID of the member to unban.

    Returns Promise<void>

Settings

Member Visibility

Theme