Birb / Guild
Class: Guild
Hierarchy
-
↳
Guild
Table of contents
Constructors
Properties
- afkChannelId
- afkTimeout
- approximateMemberCount
- approximatePresenceCount
- available
- bannerHash
- boostCount
- boostProgressBarEnabled
- boostTier
- client
- defaultMessageNotificationsLevel
- deleted
- description
- discoverySplashHash
- explicitContentFilterLevel
- features
- iconHash
- id
- isOwner
- maxMembers
- maxPresences
- maxVideoChannelUsers
- members
- mfaLevel
- name
- nsfwLevel
- preferredLocale
- publicUpdatesChannelId
- rulesChannelId
- splashHash
- stickers
- systemChannelFlags
- systemChannelId
- vanityUrlCode
- verificationLevel
- welcomeScreen
- widgetChannelId
- widgetEnabled
Methods
Constructors
constructor
• new Guild(client, guild)
Parameters
Overrides
Defined in
src/classes/Guild.ts:172
Properties
afkChannelId
• afkChannelId: null | string
The channel ID (snowflake) of the guild’s AFK channel as a string
Defined in
src/classes/Guild.ts:50
afkTimeout
• afkTimeout: number
The guild’s AFK timeout in seconds
Defined in
src/classes/Guild.ts:54
approximateMemberCount
• approximateMemberCount: undefined | number
An aproximation of the guild’s member count (not exact)
Defined in
src/classes/Guild.ts:145
approximatePresenceCount
• approximatePresenceCount: undefined | number
An aproximation of the guild’s user presence count (not exact)
Defined in
src/classes/Guild.ts:149
available
• available: boolean = false
It is recommended to check if this value is true before performing actions on the guild. If this value is false, the guild is unavailable due to a temporary Discord outage.
Inherited from
Defined in
src/classes/GuildPartial.ts:21
bannerHash
• bannerHash: null | string
The guild’s channel list banner hash (not URL)
Defined in
src/classes/Guild.ts:121
boostCount
• boostCount: undefined | number
The amount of boosts the guild has
Defined in
src/classes/Guild.ts:129
boostProgressBarEnabled
• boostProgressBarEnabled: boolean
Whether or not the guild has enabled the nitro boost progress bar
Defined in
src/classes/Guild.ts:165
boostTier
• boostTier: GuildPremiumTierLevel
The guild’s boost level
Defined in
src/classes/Guild.ts:125
client
• client: Birb
The Birb client
Inherited from
Defined in
src/classes/GuildPartial.ts:11
defaultMessageNotificationsLevel
• defaultMessageNotificationsLevel: GuildMessageNotificationLevel
The default message notification level of the guild
Defined in
src/classes/Guild.ts:71
deleted
• deleted: boolean = false
true if the guild is no longer available to the client (e.g. the client has left or was kicked from the guild), false otherwise
Defined in
src/classes/Guild.ts:170
description
• description: null | string
The guild’s description
Defined in
src/classes/Guild.ts:117
discoverySplashHash
• discoverySplashHash: null | string
The guild’s discovery splash screen hash (not URL)
Defined in
src/classes/Guild.ts:42
explicitContentFilterLevel
• explicitContentFilterLevel: GuildExplicitContentFilterLevel
The explicit content filter level of the guild
Defined in
src/classes/Guild.ts:76
features
• features: GuildFeature[]
The features enabled for the guild
Defined in
src/classes/Guild.ts:81
iconHash
• iconHash: null | string
The guild’s icon hash (not URL)
Defined in
src/classes/Guild.ts:34
id
• Readonly id: string
The guild’s ID (snowflake) as a string
Inherited from
Defined in
src/classes/GuildPartial.ts:15
isOwner
• isOwner: boolean = false
If true, the client’s user is the guild’s owner
Defined in
src/classes/Guild.ts:46
maxMembers
• maxMembers: undefined | number
The maximum amount of members the guild can have
Defined in
src/classes/Guild.ts:109
maxPresences
• maxPresences: undefined | null | number
The maximum amount of presences the guild can have
Defined in
src/classes/Guild.ts:105
maxVideoChannelUsers
• maxVideoChannelUsers: undefined | number
The maximum amount of users allowed to watch a stream in the guild
Defined in
src/classes/Guild.ts:141
members
• members: GuildMemberManager
A manager that stores data on the guild’s members
Defined in
src/classes/Guild.ts:101
mfaLevel
• mfaLevel: GuildMFALevel
The multi-factor authentication moderation requirement level of the guild
Defined in
src/classes/Guild.ts:85
name
• name: string
The guild’s name
Defined in
src/classes/Guild.ts:30
nsfwLevel
• nsfwLevel: GuildNSFWLevel
The explicit content level for the guild (set by Discord, mainly for iOS)
Defined in
src/classes/Guild.ts:157
preferredLocale
• preferredLocale: string
The preferred locale of the guild (defaults to en-US)
Defined in
src/classes/Guild.ts:133
publicUpdatesChannelId
• publicUpdatesChannelId: null | string
The channel ID (snowflake) of the guild’s updates as a string
Defined in
src/classes/Guild.ts:137
rulesChannelId
• rulesChannelId: null | string
The channel ID (snowflake) of the guild’s rules channel as a string
Defined in
src/classes/Guild.ts:97
splashHash
• splashHash: null | string
The guild’s invite splash screen hash (not URL)
Defined in
src/classes/Guild.ts:38
stickers
• stickers: undefined | any[]
A manager that stores data on the guild’s stickers
Defined in
src/classes/Guild.ts:161
systemChannelFlags
• systemChannelFlags: SystemChannelFlags
The flags that affect the guild’s system messages (e.g. welcome messages)
Defined in
src/classes/Guild.ts:93
systemChannelId
• systemChannelId: null | string
The channel ID (snowflake) of the guild’s system message channel as a string
Defined in
src/classes/Guild.ts:89
vanityUrlCode
• vanityUrlCode: null | string
If the guild has a vanity invite code, the guild’s invite code
Defined in
src/classes/Guild.ts:113
verificationLevel
• verificationLevel: GuildVerificationLevel
The verification level of the guild
Defined in
src/classes/Guild.ts:67
welcomeScreen
• welcomeScreen: any
The guild’s Welcome Screen and Membership Gating settings
Defined in
src/classes/Guild.ts:153
widgetChannelId
• widgetChannelId: undefined | null | string
If the guild has enabled the HTML widget, the channel ID (snowflake) of the guild’s widget channel as a string
Defined in
src/classes/Guild.ts:63
widgetEnabled
• widgetEnabled: undefined | boolean
true if the guild has enabled the HTML widget, false otherwise
Defined in
src/classes/Guild.ts:58
Methods
edit
▸ edit(options, reason?): Promise<Guild>
Parameters
| Name | Type |
|---|---|
options | GuildEditOptions |
reason? | string |
Returns
Defined in
src/classes/Guild.ts:297
fetch
Returns
Inherited from
Defined in
src/classes/GuildPartial.ts:36
isPartial
▸ isPartial(): boolean
Returns
boolean
true if this is a partial guild, false otherwise.
Overrides
Defined in
src/classes/Guild.ts:427