Struct tgbot::methods::RestrictChatMember

pub struct RestrictChatMember { /* fields omitted */ }

Restrict a user in a supergroup

The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights.

Pass True for all boolean parameters to lift restrictions from a user

Methods

impl RestrictChatMember

pub fn new<C: Into<ChatId>>(chat_id: C, user_id: Integer) -> Self

Creates a new RestrictChatMember with empty optional parameters

Arguments

• chat_id - Unique identifier for the target chat
• user_id - Unique identifier of the target user

pub fn with_permissions(self, permissions: ChatPermissions) -> Self

Replace current permissions with the new one

pub fn restrict_all(self) -> Self

Restrict everything

pub fn allow_all(self) -> Self

Allow everything

pub fn until_date(self, until_date: Integer) -> Self

Date when restrictions will be lifted for the user, unix time

If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever

pub fn can_send_messages(self, can_send_messages: bool) -> Self

Pass True, if the user can send text messages, contacts, locations and venues

Deprecated, to be removed in tgbot 0.5.0. Use with_permissions() instead.

pub fn can_send_media_messages(self, can_send_media_messages: bool) -> Self

Pass True, if the user can send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages

Deprecated, to be removed in tgbot 0.5.0. Use with_permissions() instead.

pub fn can_send_other_messages(self, can_send_other_messages: bool) -> Self

Pass True, if the user can send animations, games, stickers and use inline bots, implies can_send_media_messages

Deprecated, to be removed in tgbot 0.5.0. Use with_permissions() instead.

pub fn can_add_web_page_previews(self, can_add_web_page_previews: bool) -> Self

Pass True, if the user may add web page previews to their messages, implies can_send_media_messages

Deprecated, to be removed in tgbot 0.5.0. Use with_permissions() instead.

Trait Implementations

impl Clone for RestrictChatMember

fn clone(&self) -> RestrictChatMember

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RestrictChatMember

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

Formats the value using the given formatter.

impl Method for RestrictChatMember

type Response = bool

Type of successful result in API response

fn into_request(self) -> Request

Returns information about HTTP request

impl Serialize for RestrictChatMember

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

Serialize this value into the given Serde serializer.