Skip to main content
Module

x/denord/mod.ts>Guild

🗣 Discord API module
amatiasq/deno
Latest
interface Guild
import { type Guild } from "https://deno.land/x/denord@0.1.0/mod.ts";

Properties

id: GuildId

guild id

name: string

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

icon: ImageData

icon hash

splash: ImageData

splash hash

discoverySplash: ImageData

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: UserId

id of owner

optional
permissions: Permission[]

total permissions for the user in the guild (excludes overrides)

region: VoiceRegionId

voice region id for the guild

afkChannelId: ChannelId

id of afk channel

afkTimeout: integer

afk timeout in seconds

optional
embedEnabled: boolean

true if the server widget is enabled (deprecated, replaced with widgetEnabled)

optional
embedChannelId: ChannelId

the channel id that the widget will generate an invite to, or null if set to no invite (deprecated, replaced with widgetChannelId)

verificationLevel: VerificationLevel

verification level required for the guild

defaultMessageNotifications: MessageNotificationLevel

default message notifications level

explicitContentFilter: ExplicitContentFilterLevel

explicit content filter level

roles: Role[]

roles in the guild

emojis: Emoji[]

custom guild emojis

features: GuildFeature[]

enabled guild features

mfaLevel: MfaLevel

required MFA level for the guild

applicationId: ApplicationId

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

optional
widgetEnabled: boolean

true if the server widget is enabled

optional
widgetChannelId: ChannelId

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

systemChannelId: ChannelId

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

systemChannelFlags: SystemChannelFlag[]

system channel flags

rulesChannelId: ChannelId

the id of the channel where guilds with the "PUBLIC" feature can display rules and/or guidelines

optional
maxPresences: integer

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

optional
maxMembers: integer

the maximum number of members for the guild

vanityUrlCode: string | null

the vanity url code for the guild

description: string | null

the description for the guild, if the guild is discoverable

banner: ImageData | null

banner hash

premiumTier: PremiumTier

premium tier (Server Boost level)

optional
premiumSubscriptionCount: integer

the number of boosts this guild currently has

preferredLocale: string

the preferred locale of a guild with the "PUBLIC" feature; used in server discovery and notices from Discord; defaults to "en-US"

publicUpdatesChannelId: ChannelId

the id of the channel where admins and moderators of guilds with the "PUBLIC" feature receive notices from Discord

optional
maxVideoChannelUsers: integer

the maximum amount of users in a video channel

optional
approximateMemberCount: integer

approximate number of members in this guild, returned from the GET /guild/ endpoint when withCounts is true

optional
approximatePresenceCount: integer

approximate number of non-offline members in this guild, returned from the GET /guild/ endpoint when withCounts is true