GuildPreview class

A preview of a Guild.

Inheritance

Properties

approximateMemberCount → int
An approximate number of members in the guild.
final
approximatePresenceCount → int
An approximate number of presences in the guild.
final
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
commands → GuildApplicationCommandManager
A GuildApplicationCommandManager for the application commands of this guild.
no setterinherited
description → String?
The guild's description.
final
discoverySplashHash → String?
The hash of the guild's discovery splash image.
final
emojiList → List<Emoji>
The emojis in the guild.
final
emojis → EmojiManager
An EmojiManager for the emojis of this guild.
no setterinherited
features → GuildFeatures
The features enabled in the guild.
final
hashCode → int
The hash code for this object.
no setterinherited
iconHash → String?
The hash of the guild's icon.
final
id → Snowflake
The id of this entity.
finalinherited
integrations → IntegrationManager
An IntegrationManager for the integrations of this guild.
no setterinherited
manager → GuildManager
The manager for this entity.
finalinherited
members → MemberManager
A MemberManager for the members of this guild.
no setterinherited
name → String
The name of the guild.
final
roles → RoleManager
A RoleManager for the roles of this guild.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scheduledEvents → ScheduledEventManager
A ScheduledEventManager for the scheduled events of this guild.
no setterinherited
splashHash → String?
The hash of the 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
voiceStates → Cache<VoiceState>
A Cache for VoiceStates in this guild.
no setterinherited

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 and roleIds.
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 and roleIds.
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