Struct twitch_api2::helix::chat::update_chat_settings::UpdateChatSettingsBody

#[non_exhaustive]
pub struct UpdateChatSettingsBody {
    pub emote_mode: Option<bool>,
    pub follower_mode: Option<bool>,
    pub follower_mode_duration: Option<u64>,
    pub non_moderator_chat_delay: Option<bool>,
    pub non_moderator_chat_delay_duration: Option<u64>,
    pub slow_mode: Option<bool>,
    pub slow_mode_wait_time: Option<u64>,
    pub subscriber_mode: Option<bool>,
    pub unique_chat_mode: Option<bool>,
}

Available on crate feature helix only.

Body Parameters for Update Chat Settingss

update-chat-settings

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

emote_mode: Option<bool>

A Boolean value that determines whether chat messages must contain only emotes.

Set to true, if only messages that are 100% emotes are allowed; otherwise, false. Default is false.

follower_mode: Option<bool>

A Boolean value that determines whether the broadcaster restricts the chat room to followers only, based on how long they’ve followed.

Set to true, if the broadcaster restricts the chat room to followers only; otherwise, false. Default is true.

See follower_mode_duration for how long the followers must have followed the broadcaster to participate in the chat room.

follower_mode_duration: Option<u64>

The length of time, in minutes, that the followers must have followed the broadcaster to participate in the chat room (see follower_mode).

You may specify a value in the range: 0 (no restriction) through 129600 (3 months). The default is 0.

non_moderator_chat_delay: Option<bool>

A Boolean value that determines whether the broadcaster adds a short delay before chat messages appear in the chat room. This gives chat moderators and bots a chance to remove them before viewers can see the message.

Set to true, if the broadcaster applies a delay; otherwise, false. Default is false.

See non_moderator_chat_delay_duration for the length of the delay.

non_moderator_chat_delay_duration: Option<u64>

The amount of time, in seconds, that messages are delayed from appearing in chat.

Possible values are:

• 2 — 2 second delay (recommended)
• 4 — 4 second delay
• 6 — 6 second delay

See non_moderator_chat_delay.

slow_mode: Option<bool>

A Boolean value that determines whether the broadcaster limits how often users in the chat room are allowed to send messages.

Set to true, if the broadcaster applies a wait period messages; otherwise, false. Default is false.

See slow_mode_wait_time for the delay.

slow_mode_wait_time: Option<u64>

The amount of time, in seconds, that users need to wait between sending messages (see slow_mode).

You may specify a value in the range: 3 (3 second delay) through 120 (2 minute delay). The default is 30 seconds.

subscriber_mode: Option<bool>

A Boolean value that determines whether only users that subscribe to the broadcaster’s channel can talk in the chat room.

Set to true, if the broadcaster restricts the chat room to subscribers only; otherwise, false. Default is false.

unique_chat_mode: Option<bool>

A Boolean value that determines whether the broadcaster requires users to post only unique messages in the chat room.

Set to true, if the broadcaster requires unique messages only; otherwise, false. Default is false.

Implementations

impl UpdateChatSettingsBody

pub fn builder(
) -> UpdateChatSettingsBodyBuilder<((), (), (), (), (), (), (), (), ())>

Create a builder for building UpdateChatSettingsBody. On the builder, call .emote_mode(...)(optional), .follower_mode(...)(optional), .follower_mode_duration(...)(optional), .non_moderator_chat_delay(...)(optional), .non_moderator_chat_delay_duration(...)(optional), .slow_mode(...)(optional), .slow_mode_wait_time(...)(optional), .subscriber_mode(...)(optional), .unique_chat_mode(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of UpdateChatSettingsBody.

Trait Implementations

impl Clone for UpdateChatSettingsBody

fn clone(&self) -> UpdateChatSettingsBody

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateChatSettingsBody

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UpdateChatSettingsBody

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<UpdateChatSettingsBody> for UpdateChatSettingsBody

fn eq(&self, other: &UpdateChatSettingsBody) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &UpdateChatSettingsBody) -> bool

This method tests for !=.

impl Serialize for UpdateChatSettingsBody

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UpdateChatSettingsBody