UserGuild class
A collection of channels & users.
Guilds are often referred to as servers.
- Inheritance
- Implementers
Properties
- approximateMemberCount → int?
-
An approximate number of members in this guild.
final
- approximatePresenceCount → int?
-
An approximate number of presences in this 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
- currentUserPermissions → Permissions?
-
The current user's permissions.
final
- emojis → EmojiManager
-
An EmojiManager for the emojis of this guild.
no setterinherited
- features → GuildFeatures
-
A set of features enabled in this guild.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- icon → CdnAsset?
-
This guild's icon.
no setter
- iconHash → String?
-
The hash of this guild's icon.
final
- 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.
final
- manager → GuildManager
-
The manager for this entity.
finalinherited
- members → MemberManager
-
A MemberManager for the members of this guild.
no setterinherited
- name → String
-
This guild's name.
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
- 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
daysandroleIds.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
daysandroleIds.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