List of all members | Public Fields | Public Types | Public Instance Methods | Static Public Attributes
banChatMember Class Referencefinal

Inherits Function.

Description

Bans a member in a chat; requires can_restrict_members administrator right. Members can't be banned in private or secret chats. In supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first.

Returns object_ptr<Ok>.

Public Fields

int53 chat_id_
 Chat identifier.
 
object_ptr< MessageSendermember_id_
 Member identifier.
 
int32 banned_until_date_
 Point in time (Unix timestamp) when the user will be unbanned; 0 if never. If the user is banned for more than 366 days or for less than 30 seconds from the current time, the user is considered to be banned forever. Ignored in basic groups and if a chat is banned.
 
bool revoke_messages_
 Pass true to delete all messages in the chat for the user that is being removed. Always true for supergroups and channels.
 

Public Types

using ReturnType = object_ptr< ok >
 Typedef for the type returned by the function.
 

Public Instance Methods

 banChatMember ()
 
 banChatMember (int53 chat_id_, object_ptr< MessageSender > &&member_id_, int32 banned_until_date_, bool revoke_messages_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Instance Methods inherited from TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Static Public Attributes

static const std::int32_t ID = -888111748
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ banChatMember() [1/2]

Default constructor for a function, which bans a member in a chat; requires can_restrict_members administrator right. Members can't be banned in private or secret chats. In supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first.

Returns object_ptr<Ok>.

◆ banChatMember() [2/2]

banChatMember ( int53  chat_id_,
object_ptr< MessageSender > &&  member_id_,
int32  banned_until_date_,
bool  revoke_messages_ 
)

Creates a function, which bans a member in a chat; requires can_restrict_members administrator right. Members can't be banned in private or secret chats. In supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first.

Returns object_ptr<Ok>.

Parameters
[in]chat_id_Chat identifier.
[in]member_id_Member identifier.
[in]banned_until_date_Point in time (Unix timestamp) when the user will be unbanned; 0 if never. If the user is banned for more than 366 days or for less than 30 seconds from the current time, the user is considered to be banned forever. Ignored in basic groups and if a chat is banned.
[in]revoke_messages_Pass true to delete all messages in the chat for the user that is being removed. Always true for supergroups and channels.

Method Documentation

◆ store()

void store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements TlObject.


The documentation for this class was generated from the following file: