AutoModRule

discord_http.automod module

class discord_http.automod.AutoModRule(*, state, data)

Bases: PartialAutoModRule

Represents an auto moderation rule in a guild.

Parameters:
name: str

The name of the automod rule.

property created_at: datetime

The datetime of the snowflake.

async delete(*, reason=None) → None

Delete the automod rule.

Parameters:

reason (str | None) – Reason for deleting the automod

Return type:

None

async edit(*, name=<MISSING>, event_type=<MISSING>, keyword_filter=<MISSING>, regex_patterns=<MISSING>, presets=<MISSING>, allow_list=<MISSING>, mention_total_limit=<MISSING>, mention_raid_protection_enabled=<MISSING>, alert_channel=<MISSING>, timeout_seconds=<MISSING>, message=<MISSING>, enabled=<MISSING>, exempt_roles=<MISSING>, exempt_channels=<MISSING>, reason=None) → AutoModRule

Create an automod rule.

Parameters:

  • name (str | None) – Name of the automod

  • event_type (AutoModRuleEventType | int | None) – What type of event

  • keyword_filter (list[str] | None) – Keywords to filter

  • regex_patterns (list[str] | None) – Keywords in regex pattern to filter

  • presets (list[AutoModRulePresetType] | None) – Automod presets to include

  • allow_list (list[str] | None) – List of keywords that are allowed

  • mention_total_limit (int | None) – How many unique mentions allowed before trigger

  • mention_raid_protection_enabled (bool) – If this should apply for raids

  • alert_channel (Snowflake | int | None) – Where the action should be logged

  • timeout_seconds (int | None) – How many seconds the user in question should be timed out

  • message (str | None) – What message the user gets when action is taken

  • enabled (bool) – If the automod should be enabled or not

  • exempt_roles (list[Snowflake | int] | None) – Which roles are allowed to bypass

  • exempt_channels (list[Snowflake | int] | None) – Which channels are allowed to bypass

  • reason (str | None) – Reason for editing the automod

Return type:

AutoModRule

Returns:

The automod that was just edited

async fetch() → AutoModRule

Fetches more information about the automod rule.

Return type:

AutoModRule

property guild: Guild | PartialGuild | None

The guild object this event is in.

guild_id: int

The ID of the guild this automod rule is in.

id: int

The ID of the snowflake.

creator_id: int

The ID of the user that created the automod rule.

event_type: AutoModRuleEventType

The type of event that triggers the automod rule.

trigger_type: AutoModRuleTriggerType

The type of trigger for the automod rule.

actions: list[AutoModRuleAction]

The actions that the automod rule takes when triggered.

trigger_metadata: AutoModRuleTriggers | None

The metadata for the trigger of the automod rule.

enabled: bool

Whether the automod rule is enabled or not.

exempt_roles: list[PartialRole]

The roles that are exempt from the automod rule.

exempt_channels: list[PartialChannel]

The channels that are exempt from the automod rule.

property creator: PartialUser

The user that created the automod rule in User object form.

class discord_http.automod.AutoModRuleAction(*, type, channel_id=None, duration_seconds=None, custom_message=None)

Bases: object

Represents an action for an auto moderation rule.

Parameters:
type: AutoModRuleActionType

The type of action to take when the auto moderation rule is triggered.

channel_id

The channel to send the alert message to if action type is send_alert_message.

custom_message: str | None

The message shown to the user if action type is block_message.

duration_seconds: int | None

The timeout duration in seconds if action type is timeout.

to_dict() → dict

The auto moderation rule action as a dictionary.

Return type:

dict

classmethod from_dict(data) → Self

Create an auto moderation rule action from a dictionary.

Parameters:

data (dict) – The dictionary to create the auto moderation rule action from

Return type:

Self

Returns:

The auto moderation rule action

classmethod create_message(message) → Self

Create an auto moderation rule action to block a message.

Parameters:

message (str) – The message to block

Return type:

Self

Returns:

The auto moderation rule action

classmethod create_alert_location(channel) → Self

Create an auto moderation rule action to send an alert message.

Parameters:

channel (Snowflake | int) – The channel to send the alert message to

Return type:

Self

Returns:

The auto moderation rule action

classmethod create_timeout(seconds) → Self

Create an auto moderation rule action to timeout a user.

Parameters:

seconds (int) – The number of seconds to timeout the user for

Return type:

Self

Returns:

The auto moderation rule action

class discord_http.automod.AutoModRuleTriggers(*, keyword_filter=None, regex_patterns=None, presets=None, allow_list=None, mention_total_limit=None, mention_raid_protection_enabled=False)

Bases: object

Represents the triggers for an auto moderation rule.

Parameters:
keyword_filter: list[str] | None

List of keywords to filter.

regex_patterns: list[str] | None

List of regex patterns to filter.

presets: list[AutoModRulePresetType] | None

List of auto moderation presets to filter.

allow_list: list[str] | None

List of keywords that are allowed and will not trigger the rule.

mention_total_limit: int | None

How many unique mentions are allowed before trigger.

mention_raid_protection_enabled: bool

Whether this should apply for raids.

to_dict() → dict

The auto moderation rule as a dictionary.

Return type:

dict

classmethod from_dict(data) → Self

Create an auto moderation rule from a dictionary.

Parameters:

data (dict) – The dictionary to create the auto moderation rule from

Return type:

Self

Returns:

The auto moderation rule

class discord_http.automod.PartialAutoModRule(*, state, id, guild_id)

Bases: PartialBase

Represents a partial auto moderation rule, usually from an event.

Parameters:
guild_id: int

The ID of the guild this automod rule is in.

property guild: Guild | PartialGuild | None

The guild object this event is in.

async fetch() → AutoModRule

Fetches more information about the automod rule.

Return type:

AutoModRule

async delete(*, reason=None) → None

Delete the automod rule.

Parameters:

reason (str | None) – Reason for deleting the automod

Return type:

None

async edit(*, name=<MISSING>, event_type=<MISSING>, keyword_filter=<MISSING>, regex_patterns=<MISSING>, presets=<MISSING>, allow_list=<MISSING>, mention_total_limit=<MISSING>, mention_raid_protection_enabled=<MISSING>, alert_channel=<MISSING>, timeout_seconds=<MISSING>, message=<MISSING>, enabled=<MISSING>, exempt_roles=<MISSING>, exempt_channels=<MISSING>, reason=None) → AutoModRule

Create an automod rule.

Parameters:

  • name (str | None) – Name of the automod

  • event_type (AutoModRuleEventType | int | None) – What type of event

  • keyword_filter (list[str] | None) – Keywords to filter

  • regex_patterns (list[str] | None) – Keywords in regex pattern to filter

  • presets (list[AutoModRulePresetType] | None) – Automod presets to include

  • allow_list (list[str] | None) – List of keywords that are allowed

  • mention_total_limit (int | None) – How many unique mentions allowed before trigger

  • mention_raid_protection_enabled (bool) – If this should apply for raids

  • alert_channel (Snowflake | int | None) – Where the action should be logged

  • timeout_seconds (int | None) – How many seconds the user in question should be timed out

  • message (str | None) – What message the user gets when action is taken

  • enabled (bool) – If the automod should be enabled or not

  • exempt_roles (list[Snowflake | int] | None) – Which roles are allowed to bypass

  • exempt_channels (list[Snowflake | int] | None) – Which channels are allowed to bypass

  • reason (str | None) – Reason for editing the automod

Return type:

AutoModRule

Returns:

The automod that was just edited

property created_at: datetime

The datetime of the snowflake.

id: int

The ID of the snowflake.