View Source Nostrum.Struct.AutoModerationRule.ActionMetadata (Nostrum v0.10.0)

Struct representing any additional data used when an action is taken.

Summary

Types

The id of the channel to send an alert message to.

t()

The type of metadata present depends on the action type.

The number of seconds to timeout the user for, has a maximum of 2419200 seconds (4 weeks).

Types

Link to this type

send_alert_message_metadata()

View Source (since 0.7.0)
@type send_alert_message_metadata() ::
  %Nostrum.Struct.AutoModerationRule.ActionMetadata{
    channel_id: Nostrum.Snowflake.t(),
    duration_seconds: term()
  }

The id of the channel to send an alert message to.

The type of metadata present depends on the action type.

valuetype
--------
channel_idSEND_ALERT_MESSAGE
duration_secondsTIMEOUT
Link to this type

timeout_metadata()

View Source (since 0.7.0)
@type timeout_metadata() :: %Nostrum.Struct.AutoModerationRule.ActionMetadata{
  channel_id: term(),
  duration_seconds: 1..2_419_200
}

The number of seconds to timeout the user for, has a maximum of 2419200 seconds (4 weeks).