Skip to main content
Module

x/natico/discordeno_deps.ts>Guild

A powerful and customizable framework for Discordeno
naticoo/framework
Latest
interface Guild
Re-export
import { type Guild } from "https://deno.land/x/natico@4.0.0-pre.4/discordeno_deps.ts";

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

Properties

id: string

Guild id

name: string

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

icon: string | null

Icon hash

optional
iconHash: string | null

Icon hash, returned when in the template object

splash: string | null

Splash hash

discoverySplash: string | null

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

optional
owner: boolean

True if the user is the owner of the guild

ownerId: string

Id of the owner

optional
permissions: string

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

afkChannelId: string | null

Id of afk channel

afkTimeout: number

Afk timeout in seconds

optional
widgetEnabled: boolean

True if the server widget is enabled

optional
widgetChannelId: string | null

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

verificationLevel: VerificationLevels

Verification level required for the guild

defaultMessageNotifications: DefaultMessageNotificationLevels

Default message notifications level

explicitContentFilter: ExplicitContentFilterLevels

Explicit content filter level

roles: Role[]

Roles in the guild

emojis: Emoji[]

Custom guild emojis

features: GuildFeatures[]

Enabled guild features

mfaLevel: MfaLevels

Required MFA level for the guild

applicationId: string | null

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

systemChannelId: string | null

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

systemChannelFlags: SystemChannelFlags

System channel flags

rulesChannelId: string | null

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

optional
joinedAt: string

When this guild was joined at

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
memberCount: number

Total number of members in this guild

optional
voiceStates: Omit<VoiceState, "guildId">[]

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

optional
members: GuildMember[]

Users in the guild

optional
channels: Channel[]

Channels in the guild

optional
threads: Channel[]

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

optional
presences: Partial<PresenceUpdate>[]

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

optional
maxPresences: number | null

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

optional
maxMembers: number

The maximum number of members for the guild

vanityUrlCode: string | null

The vaniy url code for the guild

description: string | null

The description of a Community guild

banner: string | null

Banner hash

premiumTier: PremiumTiers

Premium tier (Server Boost level)

optional
premiumSubscriptionCount: number

The number of boosts this guild currently has

preferredLocale: string

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

publicUpdatesChannelId: string | null

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

optional
maxVideoChannelUsers: number

The maximum amount of users in a video channel

optional
approximateMemberCount: number

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

optional
approximatePresenceCount: number

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

optional
welcomeScreen: WelcomeScreen

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

nsfwLevel: GuildNsfwLevel

Guild NSFW level

optional
stageInstances: StageInstance[]

Stage instances in the guild