Guild class
A collection of channels & users.
Guilds are often referred to as servers.
- Inheritance
Properties
- afkChannel → PartialChannel?
-
The AFK channel.
no setter
- afkChannelId → Snowflake?
-
The ID of this guild's AFK channel.
final
- afkTimeout → Duration
-
The time after which members are moved into the AFK channel.
final
- application → PartialApplication?
-
The application that created this guild.
no setter
- applicationId → Snowflake?
-
The ID of the application that created this guild.
final
- approximateMemberCount → int?
-
An approximate number of members in this guild.
finalinherited
- approximatePresenceCount → int?
-
An approximate number of presences in this guild.
finalinherited
- auditLogs → AuditLogManager
-
An AuditLogManager for the audit log of this guild.
no setterinherited
- autoModerationRules → AutoModerationManager
-
An AutoModerationManager for the auto moderation rules of this guild.
no setterinherited
-
This guild's banner.
no setter
-
The hash of this guild's banner.
final
- commands → GuildApplicationCommandManager
-
A GuildApplicationCommandManager for the application commands of this guild.
no setterinherited
- currentUserPermissions → Permissions?
-
The current user's permissions.
finalinherited
- defaultMessageNotificationLevel → MessageNotificationLevel
-
The default message notification level.
final
- description → String?
-
This guild's description.
final
- discoverySplash → CdnAsset?
-
This guild's discovery splash image.
no setter
- discoverySplashHash → String?
-
The hash of this guild's discovery splash image.
final
-
emojiList
→ List<
Emoji> -
A list of emojis in this guild.
final
- emojis → EmojiManager
-
An EmojiManager for the emojis of this guild.
no setterinherited
- explicitContentFilterLevel → ExplicitContentFilterLevel
-
The explicit content filter level for this guild.
final
- features → GuildFeatures
-
A set of features enabled in this guild.
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasPremiumProgressBarEnabled → bool
-
Whether this guild has the premium progress bar enabled.
final
- icon → CdnAsset?
-
This guild's icon.
no setterinherited
- iconHash → String?
-
The hash of this guild's icon.
finalinherited
- id → Snowflake
-
The id of this entity.
finalinherited
- integrations → IntegrationManager
-
An IntegrationManager for the integrations of this guild.
no setterinherited
- isOwnedByCurrentUser → bool?
-
Whether this guild is owned by the current user.
finalinherited
- isWidgetEnabled → bool
-
Whether the widget is enabled in this guild.
final
- manager → GuildManager
-
The manager for this entity.
finalinherited
- maxMembers → int?
-
The maximum number of members in this guild.
final
- maxPresences → int?
-
The maximum number of presences in this guild.
final
- maxStageChannelUsers → int?
-
The maximum number of users in a stage video channel.
final
- maxVideoChannelUsers → int?
-
The maximum number of users in a video channel.
final
- members → MemberManager
-
A MemberManager for the members of this guild.
no setterinherited
- mfaLevel → MfaLevel
-
This guild's MFA level.
final
- name → String
-
This guild's name.
finalinherited
- nsfwLevel → NsfwLevel
-
This guild's NSFW level.
final
- owner → PartialUser
-
The owner of the guild.
no setter
- ownerId → Snowflake
-
The ID of this guild's owner.
final
- ownerMember → PartialMember
-
The member for the owner of the guild.
no setter
- preferredLocale → Locale
-
This guild's preferred locale.
final
-
The number of members who have boosted this guild.
final
-
The current premium tier of this guild.
final
- publicUpdatesChannel → PartialTextChannel?
-
The public updates channel in a community server.
no setter
- publicUpdatesChannelId → Snowflake?
-
The ID of the public updates channel in a community guild.
final
-
roleList
→ List<
Role> -
A list of roles in this guild.
final
- roles → RoleManager
-
A RoleManager for the roles of this guild.
no setterinherited
- rulesChannel → PartialTextChannel?
-
The rules channel in a community server.
no setter
- rulesChannelId → Snowflake?
-
The ID of the rules channel in a community guild.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- safetyAlertsChannel → PartialTextChannel?
-
The channel safety alerts are sent to.
no setter
- safetyAlertsChannelId → Snowflake?
-
The ID of the channel safety alerts are sent to.
final
- scheduledEvents → ScheduledEventManager
-
A ScheduledEventManager for the scheduled events of this guild.
no setterinherited
- splash → CdnAsset?
-
This guild's splash image.
no setter
- splashHash → String?
-
The hash of this guild's splash image.
final
-
stickerList
→ List<
GuildSticker> -
A list of stickers in this guild.
final
- stickers → GuildStickerManager
-
An GuildStickerManager for the stickers of this guild.
no setterinherited
- systemChannel → PartialTextChannel?
-
The channel system messages are sent to.
no setter
- systemChannelFlags → SystemChannelFlags
-
The configuration for this guild's system channel.
final
- systemChannelId → Snowflake?
-
The ID of the channel system messages are sent to.
final
- vanityUrlCode → String?
-
This guild's vanity invite URL code.
final
- verificationLevel → VerificationLevel
-
This guild's verification level.
final
-
voiceStates
→ Cache<
VoiceState> -
A Cache for
VoiceState
s in this guild.no setterinherited - welcomeScreen → WelcomeScreen?
-
This guild's welcome screen.
final
- widgetChannel → PartialChannel?
-
The channel this guild's widget will send users to.
no setter
- widgetChannelId → Snowflake?
-
The channel ID the widget's invite will send users to.
final
Methods
-
bulkBan(
List< Snowflake> userIds, {Duration? deleteMessages, String? auditLogReason}) → Future<BulkBanResponse> -
Ban up to 200 users from a guild, and optionally delete previous messages sent by the banned users.
inherited
-
createBan(
Snowflake userId, {Duration? deleteMessages, String? auditLogReason}) → Future< void> -
Ban a user in this guild.
inherited
-
createChannel<
T extends GuildChannel> (GuildChannelBuilder< T> builder, {String? auditLogReason}) → Future<T> -
Create a channel in this guild.
inherited
-
createTemplate(
GuildTemplateBuilder builder) → Future< GuildTemplate> -
Create a template in this guild.
inherited
-
defaultToString(
) → String -
Same as toString, but only called when dart:mirrors is not available.
inherited
-
delete(
) → Future< void> -
Delete this entity.
inherited
-
deleteBan(
Snowflake userId, {String? auditLogReason}) → Future< void> -
Unban a user in this guild.
inherited
-
deleteTemplate(
String code) → Future< GuildTemplate> -
Delete a template in this guild.
inherited
-
fetch(
{bool? withCounts}) → Future< Guild> -
Fetch this entity from the API.
inherited
-
fetchChannels(
) → Future< List< GuildChannel> > -
Fetch the channels in this guild.
inherited
-
fetchCurrentMember(
) → Future< Member> -
Fetch the current user's member in this guild.
inherited
-
fetchOnboarding(
) → Future< Onboarding> -
Fetch the onboarding information for this guild.
inherited
-
fetchPreview(
) → Future< GuildPreview> -
Fetch this guild's preview.
inherited
-
fetchPruneCount(
{int? days, List< Snowflake> ? roleIds}) → Future<int> -
Fetch the member prune count for the given
days
androleIds
.inherited -
fetchVanityCode(
) → Future< String?> -
Fetch this guild's vanity invite code.
inherited
-
fetchWelcomeScreen(
) → Future< WelcomeScreen> -
Fetch this guild's welcome screen.
inherited
-
fetchWidget(
) → Future< GuildWidget> -
Fetch this guild's widget information.
inherited
-
fetchWidgetImage(
{WidgetImageStyle? style}) → Future< Uint8List> -
Fetch this guild's widget image.
inherited
-
fetchWidgetSettings(
) → Future< WidgetSettings> -
Fetch this guild's widget settings.
inherited
-
get(
) → Future< Guild> -
If this entity exists in the manager's cache, return the cached instance. Otherwise, fetch
this entity and return it.
inherited
-
leave(
) → Future< void> -
Leave this guild.
inherited
-
listActiveThreads(
) → Future< ThreadList> -
List the active threads in this guild.
inherited
-
listBans(
{int? limit, Snowflake? after, Snowflake? before}) → Future< List< Ban> > -
List the bans in this guild.
inherited
-
listInvites(
) → Future< List< Invite> > -
List the invites to this guild.
inherited
-
listTemplates(
) → Future< List< GuildTemplate> > -
List the templates in this guild.
inherited
-
listVoiceRegions(
) → Future< List< VoiceRegion> > -
List the voice regions available in the guild.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
startPrune(
{int? days, bool? computeCount, List< Snowflake> ? roleIds, String? auditLogReason}) → Future<int?> -
Start a member prune with the given
days
androleIds
.inherited -
syncTemplate(
String code) → Future< GuildTemplate> -
Sync a template in this guild.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
update(
covariant UpdateBuilder< Guild> builder) → Future<Guild> -
Update this entity using the provided builder and return the updated entity.
inherited
-
updateChannelPositions(
List< ChannelPositionBuilder> positions) → Future<void> -
Update the channel positions in this guild.
inherited
-
updateCurrentUserVoiceState(
CurrentUserVoiceStateUpdateBuilder builder) → Future< void> -
Update the current user's voice state in this guild.
inherited
-
updateMfaLevel(
MfaLevel level, {String? auditLogReason}) → Future< MfaLevel> -
Update a guild's MFA level.
inherited
-
updateTemplate(
String code, GuildTemplateUpdateBuilder builder) → Future< GuildTemplate> -
Update a template in this guild.
inherited
-
updateVoiceState(
Snowflake userId, VoiceStateUpdateBuilder builder) → Future< void> -
Update a member's voice state in this guild.
inherited
-
updateWelcomeScreen(
WelcomeScreenUpdateBuilder builder, {String? auditLogReason}) → Future< WelcomeScreen> -
Update this guild's welcome screen.
inherited
-
updateWidgetSettings(
WidgetSettingsUpdateBuilder builder, {String? auditLogReason}) → Future< WidgetSettings> -
Update this guild's widget settings.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited