Enum AutomodCommand 

pub enum AutomodCommand {
    Start {
        parameter: Parameter,
        allow_list: Option<Vec<ParticipantId>>,
        playlist: Option<Vec<ParticipantId>>,
    },
    Edit {
        allow_list: Option<Vec<ParticipantId>>,
        playlist: Option<Vec<ParticipantId>>,
    },
    Stop,
    Select(Select),
    Yield {
        next: Option<ParticipantId>,
    },
}

Commands received by the automod module

Variants

Start

Start the auto-moderation with a provided config

Fields

parameter: Parameter

The parameters for the automod session

allow_list: Option<Vec<ParticipantId>>

Depending on the selection strategy, the list of Participant that can be chosen from.

• Strategy = none, random or nomination: The allow_list acts as pool of participants which can be selected (by nomination or randomly etc).

• Strategy = playlist The allow_list does not get used by this strategy.

playlist: Option<Vec<ParticipantId>>

Ordered list of queued participants

• Strategy = none, random or nomination: The playlist does not get used by these strategies.

• Strategy = playlist The playlist is a ordered list of participants which will get used to select the next participant when yielding. It is also used as a pool to select participants randomly from (moderator command Select).

Edit

Set either the allow_list or playlist or both

Fields

allow_list: Option<Vec<ParticipantId>>

Edit the allow_list. If None, it should not be edited.

playlist: Option<Vec<ParticipantId>>

Edit the playlist. If None, it should not be edited.

Stop

Stop the auto-moderation

Select(Select)

Select a user to be active speaker

Yield

User yields it’s speaker status

Fields

next: Option<ParticipantId>

In some cases a user must select the next participant to be speaker

Implementations

impl AutomodCommand

pub fn requires_moderator_privileges(&self) -> bool

Returns if the issued command requires the participant to be a moderator

Trait Implementations

impl CreateReplica<AutomodEvent> for AutomodCommand

fn replicate(&self) -> Option<AutomodEvent>

impl Debug for AutomodCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AutomodCommand

fn deserialize<__D>( __deserializer: __D, ) -> Result<AutomodCommand, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AutomodCommand

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.