Struct twitch_api2::helix::chat::ChatSettings
source · [−]#[non_exhaustive]pub struct ChatSettings {
pub broadcaster_id: UserId,
pub emote_mode: bool,
pub follower_mode: bool,
pub follower_mode_duration: Option<u64>,
pub moderator_id: Option<UserId>,
pub non_moderator_chat_delay: Option<bool>,
pub non_moderator_chat_delay_duration: Option<u64>,
pub slow_mode: bool,
pub slow_mode_wait_time: Option<u64>,
pub subscriber_mode: bool,
pub unique_chat_mode: bool,
}
helix
only.Expand description
Chat settings
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.broadcaster_id: UserId
The ID of the broadcaster specified in the request.
emote_mode: bool
A Boolean value that determines whether chat messages must contain only emotes. Is true, if only messages that are 100% emotes are allowed; otherwise, false.
follower_mode: bool
A Boolean value that determines whether the broadcaster restricts the chat room to followers only, based on how long they’ve followed.
Is true, if the broadcaster restricts the chat room to followers only; otherwise, false.
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
.
Is null if follower_mode
is false.
moderator_id: Option<UserId>
The ID of the moderator specified in the request for chat settings.
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.
Is true, if the broadcaster applies a delay; otherwise, false.
See non_moderator_chat_delay_duration
for the length of the delay.
Notes
This field and non_moderator_chat_delay_duration
are not received when the request is made without a specified moderator_id
.
non_moderator_chat_delay_duration: Option<u64>
The amount of time, in seconds, that messages are delayed from appearing in chat. See non_moderator_chat_delay
.
Is null if non_moderator_chat_delay
is false.
slow_mode: bool
A Boolean value that determines whether the broadcaster limits how often users in the chat room are allowed to send messages.
Is true, if the broadcaster applies a delay; otherwise, 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.
Is null if slow_mode is false.
subscriber_mode: bool
A Boolean value that determines whether only users that subscribe to the broadcaster’s channel can talk in the chat room.
Is true, if the broadcaster restricts the chat room to subscribers only; otherwise, false.
unique_chat_mode: bool
A Boolean value that determines whether the broadcaster requires users to post only unique messages in the chat room.
Is true, if the broadcaster requires unique messages only; otherwise, false.
Trait Implementations
sourceimpl Clone for ChatSettings
impl Clone for ChatSettings
sourcefn clone(&self) -> ChatSettings
fn clone(&self) -> ChatSettings
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ChatSettings
impl Debug for ChatSettings
sourceimpl<'de> Deserialize<'de> for ChatSettings
impl<'de> Deserialize<'de> for ChatSettings
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<ChatSettings> for ChatSettings
impl PartialEq<ChatSettings> for ChatSettings
sourcefn eq(&self, other: &ChatSettings) -> bool
fn eq(&self, other: &ChatSettings) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ChatSettings) -> bool
fn ne(&self, other: &ChatSettings) -> bool
This method tests for !=
.
sourceimpl Serialize for ChatSettings
impl Serialize for ChatSettings
impl StructuralPartialEq for ChatSettings
Auto Trait Implementations
impl RefUnwindSafe for ChatSettings
impl Send for ChatSettings
impl Sync for ChatSettings
impl Unpin for ChatSettings
impl UnwindSafe for ChatSettings
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more