Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Guild

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

bans

bans: GuildBanManager

A manager of the {@link GuildBan}s belonging to this guild You should manually fetch bans before using this

channels

channels: GuildChannelManager

A manager of the Channels belonging to this guild

client

client: Client

The client that instantiated this structure

commands

commands: GuildApplicationCommandManager

A manager of the ApplicationCommands belonging to this guild

data

data: GatewayGuildCreateDispatchData

Raw guild data

members

members: GuildMemberManager

A manager of the GuildMembers belonging to this guild

roles

roles: RoleManager

A manager of the Roles belonging to this guild

Accessors

afkChannel

  • get afkChannel(): undefined | Channel

  • The object of the voice channel where AFK members are moved

    Returns undefined | Channel

afkChannelId

  • get afkChannelId(): null | string

  • The Id of the voice channel where AFK members are moved

    Returns null | string

afkTimeout

  • get afkTimeout(): number

  • The time in seconds before a user is counted as "away from keyboard"

    Returns number

approximateMemberCount

  • get approximateMemberCount(): undefined | number

  • The approximate amount of members the guild has

    Returns undefined | number

approximatePresenceCount

  • get approximatePresenceCount(): undefined | number

  • The approximate amount of presences the guild has

    Returns undefined | number

available

  • get available(): boolean

  • Whether the guild is available

    Returns boolean

createdAt

  • get createdAt(): Date

  • The time the guild was created at

    Returns Date

createdTimestamp

  • get createdTimestamp(): number

  • The timestamp the guild was created at

    Returns number

description

  • get description(): null | string

  • The description of the guild, if any

    Returns null | string

features

  • An array of features available to this guild

    Returns GuildFeature[]

id

  • get id(): string

  • The guild's Id

    Returns string

large

  • get large(): boolean

memberCount

  • get memberCount(): number

  • The full amount of members in this guild

    Returns number

name

  • get name(): string

  • The name of this guild

    Returns string

owner

  • get owner(): undefined | User

  • Returns undefined | User

ownerId

  • get ownerId(): string

  • The user Id of this guild's owner

    Returns string

premiumProgressBarEnabled

  • get premiumProgressBarEnabled(): boolean

  • Whether the guild has the boost progress bar enabled

    Returns boolean

publicUpdatesChannel

  • get publicUpdatesChannel(): undefined | Channel

  • Public updates channel for this guild

    Returns undefined | Channel

publicUpdatesChannelId

  • get publicUpdatesChannelId(): null | string

  • The community updates channel's Id for the guild

    Returns null | string

rulesChannel

  • get rulesChannel(): undefined | Channel

  • Rules channel for this guild

    Returns undefined | Channel

rulesChannelId

  • get rulesChannelId(): null | string

  • The rules channel's Id for the guild

    Returns null | string

systemChannel

  • get systemChannel(): undefined | Channel

  • System channel for this guild

    Returns undefined | Channel

systemChannelFlags

systemChannelId

  • get systemChannelId(): null | string

  • The system channel's Id

    Returns null | string

widgetChannel

  • get widgetChannel(): undefined | Channel

  • Widget channel for this guild

    Returns undefined | Channel

widgetChannelId

  • get widgetChannelId(): undefined | null | string

  • The widget channel's Id, if enabled

    Returns undefined | null | string

widgetEnabled

  • get widgetEnabled(): undefined | boolean

  • Whether widget images are enabled on this guild

    Returns undefined | boolean

Methods

clone

  • clone(): any

  • Returns any

edit

  • edit(data: Partial<Guild>, reason?: string): Promise<Guild>

  • Edits this guild

    Parameters

    • data: Partial<Guild>
    • reason: string = ''

    Returns Promise<Guild>

fetch

  • Fetches this guild

    Returns Promise<Guild>

fetchOwner

  • fetchOwner(): Promise<User>

  • Fetches the owner of the guild. If the member object isn't needed, use Guild.ownerId instead

    Returns Promise<User>

fetchWebhooks

  • Fetches all webhooks for the guild.

    Returns Promise<Collection<string, Webhook>>

leave

  • leave(): Promise<undefined>

  • Leaves the guild

    Returns Promise<undefined>

Private parseData

setOwner

  • setOwner(id: string, reason?: string): Promise<Guild>

  • Sets a new owner of the guild

    Parameters

    • id: string

      The Id of the new owner of the guild

    • reason: string = ''

      Reason for setting the new owner

    Returns Promise<Guild>

setWidgetSettings

  • Edits the guild's widget settings

    Parameters

    • settings: GuildWidgetSettingsData

      The widget settings for the guild

    • reason: string = ''

      Reason for changing the guild's widget settings

    Returns Promise<null>

toString

  • toString(): string

  • Returns the name of the guild

    Returns string

Generated using TypeDoc version 0.22.16, the 9/16/2022 at 1:09:15 AM