Skip to main content

Guild

Documentation

Documentation / @discordeno/bot / Guild

Interface: Guild

Defined in: transformers/types.ts:878

Properties​

afkChannelId?​

optional afkChannelId?: bigint

Defined in: transformers/types.ts:946

Id of afk channel

afkTimeout​

afkTimeout: number

Defined in: transformers/types.ts:884

Afk timeout in seconds

applicationId?​

optional applicationId?: bigint

Defined in: transformers/types.ts:954

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

approximateMemberCount?​

optional approximateMemberCount?: number

Defined in: transformers/types.ts:924

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

approximatePresenceCount?​

optional approximatePresenceCount?: number

Defined in: transformers/types.ts:926

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

optional banner?: bigint

Defined in: transformers/types.ts:972

Banner hash

channels​

channels: Collection<bigint, Channel>

Defined in: transformers/types.ts:966

Channels in the guild

defaultMessageNotifications​

defaultMessageNotifications: DefaultMessageNotificationLevels

Defined in: transformers/types.ts:890

Default message notifications level

description?​

optional description?: string

Defined in: transformers/types.ts:912

The description of a guild

discoverySplash?​

optional discoverySplash?: bigint

Defined in: transformers/types.ts:940

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

emojis​

emojis: Collection<bigint, Emoji>

Defined in: transformers/types.ts:952

Custom guild emojis

explicitContentFilter​

explicitContentFilter: ExplicitContentFilterLevels

Defined in: transformers/types.ts:892

Explicit content filter level

features​

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

Defined in: transformers/types.ts:894

Enabled guild features

icon?​

optional icon?: bigint

Defined in: transformers/types.ts:934

Icon hash

iconHash?​

optional iconHash?: bigint

Defined in: transformers/types.ts:936

Icon hash, returned when in the template object

id​

id: bigint

Defined in: transformers/types.ts:932

Guild id

incidentsData​

incidentsData: IncidentsData

Defined in: transformers/types.ts:986

The incidents data for this guild

joinedAt?​

optional joinedAt?: number

Defined in: transformers/types.ts:960

When this guild was joined at

large?​

optional large?: boolean

Defined in: transformers/types.ts:900

True if this is considered a large guild

maxMembers?​

optional maxMembers?: number

Defined in: transformers/types.ts:908

The maximum number of members for the guild

maxPresences?​

optional maxPresences?: number

Defined in: transformers/types.ts:906

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

maxStageVideoChannelUsers?​

optional maxStageVideoChannelUsers?: number

Defined in: transformers/types.ts:922

Maximum amount of users in a stage video channel

maxVideoChannelUsers?​

optional maxVideoChannelUsers?: number

Defined in: transformers/types.ts:920

The maximum amount of users in a video channel

memberCount​

memberCount: number

Defined in: transformers/types.ts:904

Total number of members in this guild

members​

members: Collection<bigint, Member>

Defined in: transformers/types.ts:964

Users in the guild

mfaLevel​

mfaLevel: MfaLevels

Defined in: transformers/types.ts:896

Required MFA level for the guild

name​

name: string

Defined in: transformers/types.ts:880

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

nsfwLevel​

nsfwLevel: GuildAgeRestrictionLevel

Defined in: transformers/types.ts:928

Guild NSFW level

owner?​

optional owner?: boolean

Defined in: transformers/types.ts:882

True if the user is the owner of the guild

ownerId​

ownerId: bigint

Defined in: transformers/types.ts:942

Id of the owner

permissions​

permissions: bigint

Defined in: transformers/types.ts:944

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

preferredLocale​

preferredLocale: string

Defined in: transformers/types.ts:974

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

premiumProgressBarEnabled​

premiumProgressBarEnabled: boolean

Defined in: transformers/types.ts:930

Whether the guild has the boost progress bar enabled

premiumSubscriptionCount?​

optional premiumSubscriptionCount?: number

Defined in: transformers/types.ts:918

The number of boosts this guild currently has

premiumTier​

premiumTier: PremiumTiers

Defined in: transformers/types.ts:916

Premium tier (Server Boost level)

presences?​

optional presences?: Partial<PresenceUpdate>[]

Defined in: transformers/types.ts:970

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

publicUpdatesChannelId?​

optional publicUpdatesChannelId?: bigint

Defined in: transformers/types.ts:976

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

roles​

roles: Collection<bigint, Role>

Defined in: transformers/types.ts:950

Roles in the guild

rulesChannelId?​

optional rulesChannelId?: bigint

Defined in: transformers/types.ts:958

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

safetyAlertsChannelId?​

optional safetyAlertsChannelId?: bigint

Defined in: transformers/types.ts:984

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

shardId​

shardId: number

Defined in: transformers/types.ts:914

splash?​

optional splash?: bigint

Defined in: transformers/types.ts:938

Splash hash

stageInstances?​

optional stageInstances?: StageInstance[]

Defined in: transformers/types.ts:980

Stage instances in the guild

stickers?​

optional stickers?: Collection<bigint, Sticker>

Defined in: transformers/types.ts:982

Custom guild stickers

systemChannelFlags​

systemChannelFlags: SystemChannelFlags

Defined in: transformers/types.ts:898

System channel flags

systemChannelId?​

optional systemChannelId?: bigint

Defined in: transformers/types.ts:956

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

threads​

threads: Collection<bigint, Channel>

Defined in: transformers/types.ts:968

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

toggles​

toggles: GuildToggles

Defined in: transformers/types.ts:913

unavailable?​

optional unavailable?: boolean

Defined in: transformers/types.ts:902

True if this guild is unavailable due to an outage

vanityUrlCode?​

optional vanityUrlCode?: string

Defined in: transformers/types.ts:910

The vanity url code for the guild

verificationLevel​

verificationLevel: VerificationLevels

Defined in: transformers/types.ts:888

Verification level required for the guild

voiceStates​

voiceStates: Collection<bigint, VoiceState>

Defined in: transformers/types.ts:962

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

welcomeScreen?​

optional welcomeScreen?: WelcomeScreen

Defined in: transformers/types.ts:978

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

widgetChannelId?​

optional widgetChannelId?: bigint

Defined in: transformers/types.ts:948

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

widgetEnabled?​

optional widgetEnabled?: boolean

Defined in: transformers/types.ts:886

True if the server widget is enabled