Struct teloxide::payloads::BanChatMember

pub struct BanChatMember {
    pub chat_id: Recipient,
    pub user_id: UserId,
    pub until_date: Option<DateTime<Utc>>,
    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 return 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 admin rights. Returns True on success.

Fields

chat_id: Recipient

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

user_id: UserId

Unique identifier of the target user

until_date: Option<DateTime<Utc>>

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

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: impl Into<Recipient>, user_id: UserId) -> BanChatMember

Trait Implementations

impl Clone for BanChatMember

fn clone(&self) -> BanChatMember

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BanChatMember

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

Formats the value using the given formatter.

impl Hash for BanChatMember

fn hash<__H>(&self, state: &mut __H)where
    __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<BanChatMember> for BanChatMember

fn eq(&self, other: &BanChatMember) -> 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 Payload for BanChatMember

type Output = True

The return type of a Telegram method.

const NAME: &'static str = "BanChatMember"

Name of a Telegram method.

fn timeout_hint(&self) -> Option<Duration>

If this payload may take long time to execute (e.g. GetUpdates with big timeout), the minimum timeout that should be used.

impl Serialize for BanChatMember

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

Serialize this value into the given Serde serializer.

impl Eq for BanChatMember

impl StructuralEq for BanChatMember

impl StructuralPartialEq for BanChatMember