Struct DeleteChatMessagesRequest 

#[non_exhaustive]
pub struct DeleteChatMessagesRequest<'a> {
    pub broadcaster_id: Cow<'a, UserIdRef>,
    pub moderator_id: Cow<'a, UserIdRef>,
    pub message_id: Option<Cow<'a, MsgIdRef>>,
}

Available on crate feature helix only.

Query Parameters for Delete Chat Messages

delete-chat-messages

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_id: Cow<'a, UserIdRef>

The ID of the broadcaster that owns the chat room to remove messages from.

moderator_id: Cow<'a, UserIdRef>

The ID of a user that has permission to moderate the broadcaster’s chat room.

This ID must match the user ID in the OAuth token. If the broadcaster wants to remove messages themselves, set this parameter to the broadcaster’s ID, too.

message_id: Option<Cow<'a, MsgIdRef>>

The ID of the message to remove.

The id tag in the PRIVMSG contains the message’s ID (see PRIVMSG Tags).

Restrictions

The message must have been created within the last 6 hours. The message must not belong to the broadcaster. The message must not belong to another moderator.

If not specified, the request removes all messages in the broadcaster’s chat room.

Implementations

impl<'a> DeleteChatMessagesRequest<'a>

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

Create a builder for building DeleteChatMessagesRequest. On the builder, call .broadcaster_id(...), .moderator_id(...), .message_id(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of DeleteChatMessagesRequest.

impl<'a> DeleteChatMessagesRequest<'a>

pub fn new( broadcaster_id: impl IntoCow<'a, UserIdRef> + 'a, moderator_id: impl IntoCow<'a, UserIdRef> + 'a, ) -> Self

Remove chat message(s)

pub fn message_id(self, message_id: impl IntoCow<'a, MsgIdRef> + 'a) -> Self

A specific message to remove

Trait Implementations

impl<'a> Clone for DeleteChatMessagesRequest<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DeleteChatMessagesRequest<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for DeleteChatMessagesRequest<'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 for DeleteChatMessagesRequest<'a>

fn eq(&self, other: &DeleteChatMessagesRequest<'a>) -> 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 Request for DeleteChatMessagesRequest<'_>

const OPT_SCOPE: &'static [Scope]

Available on crate feature twitch_oauth2 only.

Optional scopes needed by this endpoint

const PATH: &'static str = "moderation/chat"

The path to the endpoint relative to the helix root. eg. channels for Get Channel Information

const SCOPE: Validator

Available on crate feature twitch_oauth2 only.

Scopes needed for this endpoint

type PaginationData = ()

Data to keep track of the pagination state.

type Response = DeleteChatMessagesResponse

Response type. twitch’s response will deserialize to this.

fn query(&self) -> Result<String, SerializeError>

Defines layout of the url parameters.

fn get_uri(&self) -> Result<Uri, InvalidUri>

Returns full URI for the request, including query parameters.

fn get_bare_uri() -> Result<Uri, InvalidUri>

Returns bare URI for the request, NOT including query parameters.

impl RequestDelete for DeleteChatMessagesRequest<'_>

fn parse_inner_response( request: Option<Self>, uri: &Uri, response: &str, status: StatusCode, ) -> Result<Response<Self, Self::Response>, HelixRequestDeleteError>

where Self: Sized,

Parse a response string into the response.

fn create_request( &self, token: &str, client_id: &str, ) -> Result<Request<Bytes>, CreateRequestError>

Create a http::Request from this Request in your client

fn parse_response<B: Into<Bytes>>( request: Option<Self>, uri: &Uri, response: Response<B>, ) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestDeleteError>

where Self: Sized,

Parse response.

impl<'a> Serialize for DeleteChatMessagesRequest<'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 DeleteChatMessagesRequest<'a>

impl<'a> StructuralPartialEq for DeleteChatMessagesRequest<'a>