Struct ChannelChatMessageV1Payload

#[non_exhaustive]
pub struct ChannelChatMessageV1Payload {

    pub broadcaster_user_id: UserId,
    pub broadcaster_user_name: DisplayName,
    pub broadcaster_user_login: UserName,
    pub chatter_user_id: UserId,
    pub chatter_user_name: DisplayName,
    pub chatter_user_login: UserName,
    pub message_id: MsgId,
    pub message: Message,
    pub message_type: MessageType,
    pub badges: Vec<Badge>,
    pub cheer: Option<Cheer>,
    pub color: HexColor,
    pub reply: Option<Reply>,
    pub channel_points_custom_reward_id: Option<RewardId>,
    pub channel_points_animation_id: Option<String>,
    pub source_broadcaster_user_id: Option<UserId>,
    pub source_broadcaster_user_name: Option<DisplayName>,
    pub source_broadcaster_user_login: Option<UserName>,
    pub source_message_id: Option<MsgId>,
    pub source_badges: Vec<Badge>,
    pub is_source_only: Option<bool>,
}

Available on crate feature eventsub only.

channel.chat.message response payload.

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.

broadcaster_user_id: UserId

The broadcaster user ID.

broadcaster_user_name: DisplayName

The broadcaster display name.

broadcaster_user_login: UserName

The broadcaster login.

chatter_user_id: UserId

The user ID of the user that sent the message.

chatter_user_name: DisplayName

The user name of the user that sent the message.

chatter_user_login: UserName

The user login of the user that sent the message.

message_id: MsgId

A UUID that identifies the message.

message: Message

The structured chat message.

message_type: MessageType

The type of message.

badges: Vec<Badge>

List of chat badges.

cheer: Option<Cheer>

Metadata if this message is a cheer.

color: HexColor

The color of the user’s name in the chat room. This is a hexadecimal RGB color code in the form, #<RGB>. This may be empty if it is never set.

reply: Option<Reply>

Metadata if this message is a reply.

channel_points_custom_reward_id: Option<RewardId>

The ID of a channel points custom reward that was redeemed.

channel_points_animation_id: Option<String>

An ID for the type of animation selected as part of an “animate my message” redemption.

source_broadcaster_user_id: Option<UserId>

Only present when in a shared chat session. The broadcaster user ID of the channel the message was sent from.

source_broadcaster_user_name: Option<DisplayName>

Only present when in a shared chat session. The user name of the broadcaster of the channel the message was sent from.

source_broadcaster_user_login: Option<UserName>

Only present when in a shared chat session. The login of the broadcaster of the channel the message was sent from.

source_message_id: Option<MsgId>

Only present when in a shared chat session. The UUID that identifies the source message from the channel the message was sent from.

source_badges: Vec<Badge>

Only present when in a shared chat session. The list of chat badges for the chatter in the channel the message was sent from.

is_source_only: Option<bool>

Determines if a message delivered during a shared chat session is only sent to the source channel.

Trait Implementations

impl Clone for ChannelChatMessageV1Payload

fn clone(&self) -> ChannelChatMessageV1Payload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelChatMessageV1Payload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChannelChatMessageV1Payload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChannelChatMessageV1Payload

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ChannelChatMessageV1Payload

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ChannelChatMessageV1Payload

impl StructuralPartialEq for ChannelChatMessageV1Payload