Struct twitch_api::helix::chat::send_chat_announcement::SendChatAnnouncementBody

#[non_exhaustive]
pub struct SendChatAnnouncementBody<'a> {
    pub message: Cow<'a, str>,
    pub color: AnnouncementColor,
}

Available on crate feature helix only.

Body Parameters for Send Chat Announcement

send-chat-announcement

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.

message: Cow<'a, str>

The announcement to make in the broadcaster’s chat room. Announcements are limited to a maximum of 500 characters; announcements longer than 500 characters are truncated.

color: AnnouncementColor

The color used to highlight the announcement. Possible case-sensitive values are:

• blue
• green
• orange
• purple
• primary (default)

If color is set to primary or is not set, the channel’s accent color is used to highlight the announcement (see Profile Accent Color under profile settings, Channel and Videos, and Brand).

Implementations

impl<'a> SendChatAnnouncementBody<'a>

pub fn builder() -> SendChatAnnouncementBodyBuilder<'a, ((), ())>

Create a builder for building SendChatAnnouncementBody. On the builder, call .message(...), .color(...) to set the values of the fields. Finally, call .build() to create the instance of SendChatAnnouncementBody.

impl<'a> SendChatAnnouncementBody<'a>

pub fn new<E>(
    message: impl Into<Cow<'a, str>>,
    color: impl TryInto<AnnouncementColor, Error = E>
) -> Result<Self, E>

Create a new announcement with specified color

Examples found in repository

src/helix/client/client_ext.rs (line 664)

↕

    pub async fn send_chat_announcement<'b, T, E>(
        &'a self,
        broadcaster_id: impl types::IntoCow<'b, types::UserIdRef> + 'b,
        moderator_id: impl types::IntoCow<'b, types::UserIdRef> + 'b,
        message: impl Into<&'b str>,
        color: impl std::convert::TryInto<helix::chat::AnnouncementColor, Error = E>,
        token: &T,
    ) -> Result<helix::chat::SendChatAnnouncementResponse, ClientExtError<'a, C, E>>
    where
        T: TwitchToken + ?Sized,
    {
        let req = helix::chat::SendChatAnnouncementRequest::new(broadcaster_id, moderator_id);
        let body = helix::chat::SendChatAnnouncementBody::new(message.into(), color)?;
        Ok(self
            .req_post(req, body, token)
            .await
            .map_err(ClientExtError::ClientError)?
            .data)
    }

Trait Implementations

impl<'a> Clone for SendChatAnnouncementBody<'a>

fn clone(&self) -> SendChatAnnouncementBody<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SendChatAnnouncementBody<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for SendChatAnnouncementBody<'a>

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

Deserialize this value from the given Serde deserializer.

impl<'a> PartialEq<SendChatAnnouncementBody<'a>> for SendChatAnnouncementBody<'a>

fn eq(&self, other: &SendChatAnnouncementBody<'a>) -> bool

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

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

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

impl<'a> Serialize for SendChatAnnouncementBody<'a>

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

Serialize this value into the given Serde serializer.

impl<'a> Eq for SendChatAnnouncementBody<'a>

impl<'a> StructuralEq for SendChatAnnouncementBody<'a>

impl<'a> StructuralPartialEq for SendChatAnnouncementBody<'a>