DiscordGuild class
Constructors
-
DiscordGuild({required DiscordSnowflake id, required String name, String? icon, String? iconHash, String? splash, String? discoverySplash, bool? owner, required DiscordSnowflake ownerId, String? permissions, @Deprecated("Use channel.rtc_region instead") String? region, DiscordSnowflake? afkChannelId, required int afkTimeout, bool? widgetEnabled, DiscordSnowflake? widgetChannelId, required int verificationLevel, required int defaultMessageNotifications, required int explicitContentFilter, required List<DiscordRole> roles, required List<DiscordEmoji> emojis, required List<String> features, required int mfaLevel, DiscordSnowflake? applicationId, DiscordSnowflake? systemChannelId, required int systemChannelFlags, DiscordSnowflake? rulesChannelId, String? joinedAt, bool? large, bool? unavailable, int? memberCount, List<DiscordVoiceState>? voiceStates, List<DiscordGuildMember>? members, List<DiscordChannel>? channels, List<DiscordChannel>? threads, List<DiscordPresenceUpdate>? presences, int? maxPresences, int? maxMembers, String? vanityUrlCode, String? description, String? banner, required int premiumTier, int? premiumSubscriptionCount, required String preferredLocale, DiscordSnowflake? publicUpdatesChannelId, int? maxVideoChannelUsers, int? approximateMemberCount, int? approximatePresenceCount, DiscordWelcomeScreen? welcomeScreen, required int nsfwLevel, List<DiscordStageInstance>? stageInstances, List<DiscordSticker>? stickers, List<DiscordGuildScheduledEvent>? guildScheduledEvents, required bool premiumProgressBarEnabled})
-
-
DiscordGuild.fromJson(Map<String, dynamic> json)
-
factory
Properties
-
afkChannelId
→ DiscordSnowflake?
-
id of afk channel
final
-
afkTimeout
→ int
-
afk timeout in seconds
final
-
applicationId
→ DiscordSnowflake?
-
application id of the guild creator if it is bot-created
final
-
approximateMemberCount
→ int?
-
approximate number of members in this guild, returned
from the
GET /guilds/<id> endpoint when with_counts is true
final
-
approximatePresenceCount
→ int?
-
approximate number of non-offline members in this guild, returned
from the
GET /guilds/<id> endpoint when with_counts is true
final
-
banner
→ String?
-
banner hash
final
-
channels
→ List<DiscordChannel>?
-
channels in the guild
final
-
defaultMessageNotifications
→ int
-
default message notifications level
final
-
defaultMessageNotificationsAsEnum
→ DiscordMessageNotificationsLevel
-
no setter
-
description
→ String?
-
the description of a Community guild
final
-
discoverySplash
→ String?
-
discovery splash hash;
only presents for guilds with the "DISCOVERABLE" feature
final
-
emojis
→ List<DiscordEmoji>
-
custom guild emojis
final
-
explicitContentFilter
→ int
-
explicit content filter level
final
-
explicitContentFilterAsEnum
→ DiscordExplicitContentFilterLevel
-
no setter
-
features
→ List<String>
-
enabled guild
final
-
featuresAsEnum
→ List<DiscordGuildFeature>
-
no setter
-
guildScheduledEvents
→ List<DiscordGuildScheduledEvent>?
-
the scheduled events in the guild
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
icon
→ String?
-
icon hash
final
-
iconHash
→ String?
-
icon hash,
returned when in the template object
final
-
id
→ DiscordSnowflake
-
guild id
final
-
joinedAt
→ String?
-
when this guild was joined at
as an ISO 8601 datetime string
final
-
joinedAtAsDateTime
→ DateTime?
-
no setter
-
large
→ bool?
-
true if this is considered a large guild
final
-
maxMembers
→ int?
-
the maximum number of members for the guild
final
-
maxPresences
→ int?
-
the maximum number of presences for the guild
(
null is always returned, apart from the largest of guilds)
final
-
maxVideoChannelUsers
→ int?
-
the maximum amount of users in a video channel
final
-
memberCount
→ int?
-
total number of members in this guild
final
-
members
→ List<DiscordGuildMember>?
-
users in the guild
final
-
mfaLevel
→ int
-
required MFA level
for the guild
final
-
mfaLevelAsEnum
→ DiscordMfaLevel
-
no setter
-
name
→ String
-
guild name (2-100 characters, excluding trailing and leading whitespace)
final
-
nsfwLevel
→ int
-
guild NSFW level
final
-
nsfwLevelAsEnum
→ DiscordNsfwLevel
-
no setter
-
owner
→ bool?
-
true if the user
is the owner of the guild
final
-
ownerId
→ DiscordSnowflake
-
id of owner
final
-
permissions
→ String?
-
total permissions for the user
in the guild (excludes overwrites)
final
-
preferredLocale
→ String
-
the preferred locale
of a Community guild; used in server discovery and
notices from Discord, and sent in interactions;
defaults to "en-US"
final
-
premiumProgressBarEnabled
→ bool
-
whether the guild has the boost progress bar enabled
final
-
premiumSubscriptionCount
→ int?
-
the number of boosts this guild currently has
final
-
premiumTier
→ int
-
premium tier
(Server Boost level)
final
-
premiumTierAsEnum
→ DiscordGuildPremiumTier
-
no setter
-
presences
→ List<DiscordPresenceUpdate>?
-
presences of the members in the guild, will only include
non-offline members if the size is greater than
large threshold
final
-
publicUpdatesChannelId
→ DiscordSnowflake?
-
the id of the channel where admins and moderators
of Community guilds receive notices from Discord
final
-
region
→ String?
-
voice region
id for the guild (deprecated)
final
-
roles
→ List<DiscordRole>
-
roles in the guild
final
-
rulesChannelId
→ DiscordSnowflake?
-
the id of the channel where Community guilds
can display rules and/or guidelines
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
splash
→ String?
-
splash hash
final
-
stageInstances
→ List<DiscordStageInstance>?
-
Stage instances in the guild
final
-
stickers
→ List<DiscordSticker>?
-
custom guild stickers
final
-
systemChannelFlags
→ int
-
system channel flags
final
-
systemChannelFlagsAsEnum
→ List<DiscordSystemChannelFlag>
-
no setter
-
systemChannelId
→ DiscordSnowflake?
-
the id of the channel where guild notices such as welcome
messages and boost events are posted
final
-
threads
→ List<DiscordChannel>?
-
all active threads in the guild that current user has permission to view
final
-
unavailable
→ bool?
-
true if this guild is unavailable due to an outage
final
-
vanityUrlCode
→ String?
-
the vanity url code for the guild
final
-
verificationLevel
→ int
-
verification level
required for the guild
final
-
verificationLevelAsEnum
→ DiscordVerificationLevel
-
no setter
-
voiceStates
→ List<DiscordVoiceState>?
-
states of members currently in voice channels;
lacks the
guild_id key
final
-
welcomeScreen
→ DiscordWelcomeScreen?
-
the welcome screen of a Community guild, shown to new members,
returned in an Invite's
guild object
final
-
widgetChannelId
→ DiscordSnowflake?
-
the channel id that the widget will generate
an invite to, or
null if set to no invite
final
-
widgetEnabled
→ bool?
-
true if the server widget is enabled
final
Methods
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
