td::td_api::banChatMember Class Reference

Inherits td::td_api::Function.

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

Public Member Functions
	banChatMember ()
	banChatMember (int53 chat_id_, object_ptr< MessageSender > &&member_id_, int32 banned_until_date_, bool revoke_messages_)
std::int32_t	get_id () const final
void	store (TlStorerToString &s, const char *field_name) const final
Public Member Functions inherited from td::TlObject
virtual void	store (TlStorerUnsafe &s) const
virtual void	store (TlStorerCalcLength &s) const
	TlObject ()=default
	TlObject (const TlObject &)=delete
TlObject &	operator= (const TlObject &)=delete
	TlObject (TlObject &&)=default
TlObject &	operator= (TlObject &&)=default
virtual	~TlObject ()=default

Public Attributes
int53	chat_id_
	Chat identifier.
object_ptr< MessageSender >	member_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.

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

Detailed Description

Bans a member in a chat. 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>.

Constructor & Destructor Documentation

banChatMember() [1/2]

td::td_api::banChatMember::banChatMember

(

)

Default constructor for a function, which bans a member in a chat. 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]

td::td_api::banChatMember::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. 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.

Member Function Documentation

get_id()

std::int32_t td::td_api::banChatMember::get_id ( ) const

inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns

this->ID.

Implements td::TlObject.

store()

void td::td_api::banChatMember::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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements td::TlObject.

---

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

• td/generate/auto/td/telegram/td_api.h