Skip to main content

Guild

@discordeno/bot • Docs

Documentation / @discordeno/bot / Guild

Interface: Guild

Properties​

afkChannelId?​

optional afkChannelId: bigint

Id of afk channel

Defined in​

packages/bot/src/transformers/types.ts:751

afkTimeout​

afkTimeout: number

Afk timeout in seconds

Defined in​

packages/bot/src/transformers/types.ts:689

applicationId?​

optional applicationId: bigint

Application id of the guild creator if it is bot-created

Defined in​

packages/bot/src/transformers/types.ts:759

approximateMemberCount?​

optional approximateMemberCount: number

Approximate number of members in this guild, returned from the GET /guilds/id endpoint when with_counts is true

Defined in​

packages/bot/src/transformers/types.ts:729

approximatePresenceCount?​

optional approximatePresenceCount: number

Approximate number of non-offline members in this guild, returned from the GET /guilds/id endpoint when with_counts is true

Defined in​

packages/bot/src/transformers/types.ts:731

optional banner: bigint

Banner hash

Defined in​

packages/bot/src/transformers/types.ts:777

channels​

channels: Collection<bigint, Channel>

Channels in the guild

Defined in​

packages/bot/src/transformers/types.ts:771

defaultMessageNotifications​

defaultMessageNotifications: DefaultMessageNotificationLevels

Default message notifications level

Defined in​

packages/bot/src/transformers/types.ts:695

description?​

optional description: string

The description of a guild

Defined in​

packages/bot/src/transformers/types.ts:717

discoverySplash?​

optional discoverySplash: bigint

Discovery splash hash; only present for guilds with the "DISCOVERABLE" feature

Defined in​

packages/bot/src/transformers/types.ts:745

emojis​

emojis: Collection<bigint, Emoji>

Custom guild emojis

Defined in​

packages/bot/src/transformers/types.ts:757

explicitContentFilter​

explicitContentFilter: ExplicitContentFilterLevels

Explicit content filter level

Defined in​

packages/bot/src/transformers/types.ts:697

features​

features: ("banner" | "verified" | "animatedBanner" | "animatedIcon" | "applicationCommandPermissionsV2" | "autoModeration" | "community" | "creatorMonetizableProvisional" | "creatorStorePage" | "developerSupportServer" | "discoverable" | "featurable" | "invitesDisabled" | "inviteSplash" | "memberVerificationGateEnabled" | "moreSoundboard" | "moreStickers" | "news" | "partnered" | "previewEnabled" | "raidAlertsDisabled" | "roleIcons" | "roleSubscriptionsAvailableForPurchase" | "roleSubscriptionsEnabled" | "ticketedEventsEnabled" | "vanityUrl" | "vipRegions" | "welcomeScreenEnabled")[]

Enabled guild features

Defined in​

packages/bot/src/transformers/types.ts:699

icon?​

optional icon: bigint

Icon hash

Defined in​

packages/bot/src/transformers/types.ts:739

iconHash?​

optional iconHash: bigint

Icon hash, returned when in the template object

Defined in​

packages/bot/src/transformers/types.ts:741

id​

id: bigint

Guild id

Defined in​

packages/bot/src/transformers/types.ts:737

joinedAt?​

optional joinedAt: number

When this guild was joined at

Defined in​

packages/bot/src/transformers/types.ts:765

large?​

optional large: boolean

True if this is considered a large guild

Defined in​

packages/bot/src/transformers/types.ts:705

maxMembers?​

optional maxMembers: number

The maximum number of members for the guild

Defined in​

packages/bot/src/transformers/types.ts:713

maxPresences?​

optional maxPresences: number

The maximum number of presences for the guild (the default value, currently 25000, is in effect when null is returned)

Defined in​

packages/bot/src/transformers/types.ts:711

maxStageVideoChannelUsers?​

optional maxStageVideoChannelUsers: number

Maximum amount of users in a stage video channel

Defined in​

packages/bot/src/transformers/types.ts:727

maxVideoChannelUsers?​

optional maxVideoChannelUsers: number

The maximum amount of users in a video channel

Defined in​

packages/bot/src/transformers/types.ts:725

memberCount​

memberCount: number

Total number of members in this guild

Defined in​

packages/bot/src/transformers/types.ts:709

members​

members: Collection<bigint, Member>

Users in the guild

Defined in​

packages/bot/src/transformers/types.ts:769

mfaLevel​

mfaLevel: MfaLevels

Required MFA level for the guild

Defined in​

packages/bot/src/transformers/types.ts:701

name​

name: string

Guild name (2-100 characters, excluding trailing and leading whitespace)

Defined in​

packages/bot/src/transformers/types.ts:685

nsfwLevel​

nsfwLevel: GuildNsfwLevel

Guild NSFW level

Defined in​

packages/bot/src/transformers/types.ts:733

owner?​

optional owner: boolean

True if the user is the owner of the guild

Defined in​

packages/bot/src/transformers/types.ts:687

ownerId​

ownerId: bigint

Id of the owner

Defined in​

packages/bot/src/transformers/types.ts:747

permissions​

permissions: bigint

Total permissions for the user in the guild (excludes overwrites and implicit permissions)

Defined in​

packages/bot/src/transformers/types.ts:749

preferredLocale​

preferredLocale: string

The preferred locale of a Community guild; used in server discovery and notices from Discord; defaults to "en-US"

Defined in​

packages/bot/src/transformers/types.ts:779

premiumProgressBarEnabled​

premiumProgressBarEnabled: boolean

Whether the guild has the boost progress bar enabled

Defined in​

packages/bot/src/transformers/types.ts:735

premiumSubscriptionCount?​

optional premiumSubscriptionCount: number

The number of boosts this guild currently has

Defined in​

packages/bot/src/transformers/types.ts:723

premiumTier​

premiumTier: PremiumTiers

Premium tier (Server Boost level)

Defined in​

packages/bot/src/transformers/types.ts:721

presences?​

optional presences: PresenceUpdate[]

Presences of the members in the guild, will only include non-offline members if the size is greater than large threshold

Defined in​

packages/bot/src/transformers/types.ts:775

publicUpdatesChannelId?​

optional publicUpdatesChannelId: bigint

The id of the channel where admins and moderators of Community guilds receive notices from Discord

Defined in​

packages/bot/src/transformers/types.ts:781

roles​

roles: Collection<bigint, Role>

Roles in the guild

Defined in​

packages/bot/src/transformers/types.ts:755

rulesChannelId?​

optional rulesChannelId: bigint

The id of the channel where community guilds can display rules and/or guidelines

Defined in​

packages/bot/src/transformers/types.ts:763

safetyAlertsChannelId?​

optional safetyAlertsChannelId: bigint

The id of the channel where admins and moderators of Community guilds receive safety alerts from Discord

Defined in​

packages/bot/src/transformers/types.ts:789

shardId​

shardId: number

Defined in​

packages/bot/src/transformers/types.ts:719

splash?​

optional splash: bigint

Splash hash

Defined in​

packages/bot/src/transformers/types.ts:743

stageInstances?​

optional stageInstances: StageInstance[]

Stage instances in the guild

Defined in​

packages/bot/src/transformers/types.ts:785

stickers?​

optional stickers: Collection<bigint, Sticker>

Custom guild stickers

Defined in​

packages/bot/src/transformers/types.ts:787

systemChannelFlags​

systemChannelFlags: SystemChannelFlags

System channel flags

Defined in​

packages/bot/src/transformers/types.ts:703

systemChannelId?​

optional systemChannelId: bigint

The id of the channel where guild notices such as welcome messages and boost events are posted

Defined in​

packages/bot/src/transformers/types.ts:761

threads​

threads: Collection<bigint, Channel>

All active threads in the guild that the current user has permission to view

Defined in​

packages/bot/src/transformers/types.ts:773

toggles​

toggles: GuildToggles

Defined in​

packages/bot/src/transformers/types.ts:718

unavailable?​

optional unavailable: boolean

True if this guild is unavailable due to an outage

Defined in​

packages/bot/src/transformers/types.ts:707

vanityUrlCode?​

optional vanityUrlCode: string

The vanity url code for the guild

Defined in​

packages/bot/src/transformers/types.ts:715

verificationLevel​

verificationLevel: VerificationLevels

Verification level required for the guild

Defined in​

packages/bot/src/transformers/types.ts:693

voiceStates​

voiceStates: Collection<bigint, VoiceState>

States of members currently in voice channels; lacks the guild_id key

Defined in​

packages/bot/src/transformers/types.ts:767

welcomeScreen?​

optional welcomeScreen: WelcomeScreen

The welcome screen of a Community guild, shown to new members, returned in an Invite's guild object

Defined in​

packages/bot/src/transformers/types.ts:783

widgetChannelId?​

optional widgetChannelId: bigint

The channel id that the widget will generate an invite to, or null if set to no invite

Defined in​

packages/bot/src/transformers/types.ts:753

widgetEnabled?​

optional widgetEnabled: boolean

True if the server widget is enabled

Defined in​

packages/bot/src/transformers/types.ts:691