Skip to main content

Class: Guild

Hierarchy​

  • Base

    ↳ Guild

Constructors​

constructor​

• new Guild(app, raw)

Parameters​

NameType
appApp
rawAPIGuild

Overrides​

Base.constructor

Defined in​

packages/disploy/src/structs/Guild.ts:94

Properties​

afkChannel​

• afkChannel: null | ToBeFetched<GuildVoiceChannel>

The AFK channel of the guild.

Defined in​

packages/disploy/src/structs/Guild.ts:30


afkChannelId​

• afkChannelId: null | string

The AFK channel's ID of the guild.

Defined in​

packages/disploy/src/structs/Guild.ts:35


afkTimeout​

• afkTimeout: number

The time in seconds a user has to be AFK before being moved to the AFK channel.

Defined in​

packages/disploy/src/structs/Guild.ts:40


app​

• app: App

Inherited from​

Base.app

Defined in​

packages/disploy/src/structs/Base.ts:4


applicationId​

• applicationId: null | string

The ID of the application that owns the guild. (if it is a bot application)

Defined in​

packages/disploy/src/structs/Guild.ts:45


approximateMemberCount​

• Optional approximateMemberCount: number

The approximate number of members in the guild.

Warning

You will need to use fetch to get this value.

Defined in​

packages/disploy/src/structs/Guild.ts:51


approximatePresenceCount​

• Optional approximatePresenceCount: number

The approximate number of presences in the guild.

Warning

You will need to use fetch to get this value.

Defined in​

packages/disploy/src/structs/Guild.ts:57


• banner: null | string

The hash of the guild banner

Defined in​

packages/disploy/src/structs/Guild.ts:62


bans​

• bans: StructureManager<GuildBan>

The ban manager for this guild.

Defined in​

packages/disploy/src/structs/Guild.ts:67


channels​

• channels: ChannelManager

Shortcut to channels

Defined in​

packages/disploy/src/structs/Guild.ts:72


createdTimestamp​

• createdTimestamp: number

Timestamp of when the channel was created.

Defined in​

packages/disploy/src/structs/Guild.ts:77


description​

• description: null | string

The description of the guild (if it has one).

Defined in​

packages/disploy/src/structs/Guild.ts:82


id​

• id: string

The ID of the guild.

Defined in​

packages/disploy/src/structs/Guild.ts:15


members​

• members: StructureManager<GuildMember>

The member manager for this guild.

Defined in​

packages/disploy/src/structs/Guild.ts:87


name​

• name: string

The name of the guild.

Defined in​

packages/disploy/src/structs/Guild.ts:25


nsfwLevel​

• nsfwLevel: number

The NSFW level for this guild.

Defined in​

packages/disploy/src/structs/Guild.ts:92


ownerId​

• ownerId: string

The owner ID of the guild.

Defined in​

packages/disploy/src/structs/Guild.ts:20

Methods​

fetch​

▸ fetch(): Promise<Guild>

Returns​

Promise<Guild>

Defined in​

packages/disploy/src/structs/Guild.ts:137


patch​

▸ Private patch(raw): Guild

Parameters​

NameType
rawAPIGuild

Returns​

Guild

Defined in​

packages/disploy/src/structs/Guild.ts:100