TDLib
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
td::td_api::deleteChatHistory Class Referencefinal

Inherits td::td_api::Function.

Public Types

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

Public Member Functions

 deleteChatHistory ()
 
 deleteChatHistory (int53 chat_id_, bool remove_from_chat_list_, bool revoke_)
 
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.
 
bool remove_from_chat_list_
 Pass true to remove the chat from all chat lists.
 
bool revoke_
 Pass true to delete chat history for all users.
 

Static Public Attributes

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

Detailed Description

Deletes all messages in the chat. Use chat.can_be_deleted_only_for_self and chat.can_be_deleted_for_all_users fields to find whether and how the method can be applied to the chat.

Returns object_ptr<Ok>.

Constructor & Destructor Documentation

◆ deleteChatHistory() [1/2]

td::td_api::deleteChatHistory::deleteChatHistory ( )

Default constructor for a function, which deletes all messages in the chat. Use chat.can_be_deleted_only_for_self and chat.can_be_deleted_for_all_users fields to find whether and how the method can be applied to the chat.

Returns object_ptr<Ok>.

◆ deleteChatHistory() [2/2]

td::td_api::deleteChatHistory::deleteChatHistory ( int53  chat_id_,
bool  remove_from_chat_list_,
bool  revoke_ 
)

Creates a function, which deletes all messages in the chat. Use chat.can_be_deleted_only_for_self and chat.can_be_deleted_for_all_users fields to find whether and how the method can be applied to the chat.

Returns object_ptr<Ok>.

Parameters
[in]chat_id_Chat identifier.
[in]remove_from_chat_list_Pass true to remove the chat from all chat lists.
[in]revoke_Pass true to delete chat history for all users.

Member Function Documentation

◆ get_id()

std::int32_t td::td_api::deleteChatHistory::get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements td::TlObject.

◆ store()

void td::td_api::deleteChatHistory::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 td::TlObject.

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