TDLib
Loading...
Searching...
No Matches
setChatMemberStatus Class Referencefinal

Inherits Function.

Description

Changes the status of a chat member; requires can_invite_users member right to add a chat member, can_promote_members administrator right to change administrator rights of the member, and can_restrict_members administrator right to change restrictions of a user. This function is currently not suitable for transferring chat ownership; use transferChatOwnership instead. Use addChatMember or banChatMember if some additional parameters need to be passed.

Returns object_ptr<Ok>.

Public Types

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

Public Member Functions

 setChatMemberStatus ()
 setChatMemberStatus (int53 chat_id_, object_ptr< MessageSender > &&member_id_, object_ptr< ChatMemberStatus > &&status_)
void store (TlStorerToString &s, const char *field_name) const final
Public Member Functions inherited from TlObject
TlObject & operator= (const TlObject &)=delete
TlObject & operator= (TlObject &&)=default
virtual void store (TlStorerCalcLength &s) const
virtual void store (TlStorerUnsafe &s) const
 TlObject ()=default
 TlObject (const TlObject &)=delete
 TlObject (TlObject &&)=default
virtual ~TlObject ()=default

Public Attributes

int53 chat_id_
 Chat identifier.
object_ptr< MessageSender > member_id_
 Member identifier. Chats can be only banned and unbanned in supergroups and channels.
object_ptr< ChatMemberStatus > status_
 The new status of the member in the chat.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ setChatMemberStatus() [1/2]

setChatMemberStatus ( )

Default constructor for a function, which changes the status of a chat member; requires can_invite_users member right to add a chat member, can_promote_members administrator right to change administrator rights of the member, and can_restrict_members administrator right to change restrictions of a user. This function is currently not suitable for transferring chat ownership; use transferChatOwnership instead. Use addChatMember or banChatMember if some additional parameters need to be passed.

Returns object_ptr<Ok>.

◆ setChatMemberStatus() [2/2]

setChatMemberStatus ( int53 chat_id_,
object_ptr< MessageSender > && member_id_,
object_ptr< ChatMemberStatus > && status_ )

Creates a function, which changes the status of a chat member; requires can_invite_users member right to add a chat member, can_promote_members administrator right to change administrator rights of the member, and can_restrict_members administrator right to change restrictions of a user. This function is currently not suitable for transferring chat ownership; use transferChatOwnership instead. Use addChatMember or banChatMember if some additional parameters need to be passed.

Returns object_ptr<Ok>.

Parameters
[in]chat_id_Chat identifier.
[in]member_id_Member identifier. Chats can be only banned and unbanned in supergroups and channels.
[in]status_The new status of the member in the chat.

Member Function 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: