Struct telegram_bot_api::methods::BanChatMember

pub struct BanChatMember {
    pub chat_id: ChatId,
    pub user_id: i64,
    pub until_date: Option<i64>,
    pub revoke_messages: Option<bool>,
}

Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Fields

chat_id: ChatId

Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)

user_id: i64

Unique identifier of the target user

until_date: Option<i64>

Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.

revoke_messages: Option<bool>

Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.

Implementations

impl BanChatMember

pub fn new(chat_id: ChatId, user_id: i64) -> Self

Trait Implementations

impl Clone for BanChatMember

fn clone(&self) -> BanChatMember

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BanChatMember

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BanChatMember

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

Deserialize this value from the given Serde deserializer.

impl Methods for BanChatMember

fn endpoint(&self) -> String

fn files(&self) -> HashMap<String, InputFile>

impl Serialize for BanChatMember

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

Serialize this value into the given Serde serializer.