Struct BanRequest 

pub struct BanRequest {
    pub broadcaster_user_id: u64,
    pub user_id: u64,
    pub reason: Option<String>,
    pub duration: Option<u32>,
}

Request body for banning a user

If duration is provided, this is a timeout (temporary ban). If duration is None, this is a permanent ban.

Example

use kick_api::BanRequest;

// Permanent ban
let ban = BanRequest {
    broadcaster_user_id: 12345,
    user_id: 67890,
    reason: Some("Spamming".to_string()),
    duration: None,
};

// 10-minute timeout
let timeout = BanRequest {
    broadcaster_user_id: 12345,
    user_id: 67890,
    reason: Some("Cool off".to_string()),
    duration: Some(600),
};

Fields

broadcaster_user_id: u64

The broadcaster’s channel where the ban applies

user_id: u64

The user to ban

reason: Option<String>

Reason for the ban

duration: Option<u32>

Duration in seconds (None = permanent ban)

Trait Implementations

impl Clone for BanRequest

fn clone(&self) -> BanRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BanRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BanRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BanRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.