A rule use for auto-moderation in a Guild.
- Inheritance
Properties
-
actions
→ List<
AutoModerationAction> -
The actions taken when this rule is triggered.
final
- creator → PartialUser
-
no setter
- creatorId → Snowflake
-
The ID of the user that created this rule.
final
- creatorMember → PartialMember
-
no setter
- eventType → AutoModerationEventType
-
The type of event on which this rule triggers.
final
-
exemptChannelIds
→ List<
Snowflake> -
The IDs of the channels exempt to this rule.
final
-
exemptChannels
→ List<
PartialChannel> -
no setter
-
exemptRoleIds
→ List<
Snowflake> -
The IDs of the roles exempt to this rule.
final
-
exemptRoles
→ List<
PartialRole> -
no setter
- guild → PartialGuild
-
no setter
- guildId → Snowflake
-
The ID of the guild this rule is in.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → Snowflake
-
The id of this entity.
finalinherited
- isEnabled → bool
-
Whether this rule is enabled.
final
- manager → AutoModerationManager
-
The manager for this entity.
finalinherited
- metadata → TriggerMetadata
-
Any metadata associated with this rule.
final
- name → String
-
The name of this rule.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- triggerType → TriggerType
-
The type of trigger for this rule.
final
Methods
-
defaultToString(
) → String -
Same as toString, but only called when dart:mirrors is not available.
inherited
-
delete(
) → Future< void> -
Delete this entity.
inherited
-
fetch(
) → Future< AutoModerationRule> -
Fetch this entity from the API.
inherited
-
get(
) → Future< AutoModerationRule> -
If this entity exists in the manager's cache, return the cached instance. Otherwise, fetch
this entity and return it.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
update(
covariant UpdateBuilder< AutoModerationRule> builder) → Future<AutoModerationRule> -
Update this entity using the provided builder and return the updated entity.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited