DiscordGuild | /template/beginner/deps.ts | discordeno@18.0.1

interface DiscordGuild

Re-export

import { type DiscordGuild } from "https://deno.land/x/discordeno@18.0.1/template/beginner/deps.ts";

https://discord.com/developers/docs/resources/guild#guild-object

Properties

name: string

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

optional

owner: boolean

True if the user is the owner of the guild

afk_timeout: number

Afk timeout in seconds

optional

widget_enabled: boolean

True if the server widget is enabled

verification_level: VerificationLevels

Verification level required for the guild

default_message_notifications: DefaultMessageNotificationLevels

Default message notifications level

explicit_content_filter: ExplicitContentFilterLevels

Explicit content filter level

features: GuildFeatures[]

Enabled guild features

mfa_level: MfaLevels

Required MFA level for the guild

system_channel_flags: SystemChannelFlags

System channel flags

optional

large: boolean

True if this is considered a large guild

optional

unavailable: boolean

True if this guild is unavailable due to an outage

optional

member_count: number

Total number of members in this guild

optional

max_presences: number | null

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

optional

max_members: number

The maximum number of members for the guild

vanity_url_code: string | null

The vanity url code for the guild

description: string | null

The description of a guild

premium_tier: PremiumTiers

Premium tier (Server Boost level)

optional

premium_subscription_count: number

The number of boosts this guild currently has

optional

max_video_channel_users: number

The maximum amount of users in a video channel

optional

approximate_member_count: number

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

optional

approximate_presence_count: number

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

nsfw_level: GuildNsfwLevel

Guild NSFW level

premium_progress_bar_enabled: boolean

Whether the guild has the boost progress bar enabled

id: string

Guild id

icon: string | null

Icon hash

optional

icon_hash: string | null

Icon hash, returned when in the template object

splash: string | null

Splash hash

discovery_splash: string | null

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

owner_id: string

Id of the owner

optional

permissions: string

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

afk_channel_id: string | null

Id of afk channel

optional

widget_channel_id: string | null

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

roles: DiscordRole[]

Roles in the guild

emojis: DiscordEmoji[]

Custom guild emojis

application_id: string | null

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

system_channel_id: string | null

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

rules_channel_id: string | null

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

optional

joined_at: string

When this guild was joined at

optional

voice_states: Omit<DiscordVoiceState, "guildId">[]

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

optional

members: DiscordMember[]

Users in the guild

optional

channels: DiscordChannel[]

Channels in the guild

optional

threads: DiscordChannel[]

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

optional

presences: Partial<DiscordPresenceUpdate>[]

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

banner: string | null

Banner hash

preferred_locale: string

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

public_updates_channel_id: string | null

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

optional

welcome_screen: DiscordWelcomeScreen

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

optional

stage_instances: DiscordStageInstance[]

Stage instances in the guild