TDLib
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
removeAllFilesFromDownloads Class Referencefinal

Inherits Function.

Description

Removes all files from the file download list.

Returns object_ptr<Ok>.

Public Types

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

Public Member Functions

 removeAllFilesFromDownloads ()
 
 removeAllFilesFromDownloads (bool only_active_, bool only_completed_, bool delete_from_cache_)
 
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

bool delete_from_cache_
 Pass true to delete the file from the TDLib file cache.
 
bool only_active_
 Pass true to remove only active downloads, including paused.
 
bool only_completed_
 Pass true to remove only completed downloads.
 

Static Public Attributes

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

Constructor & Destructor Documentation

◆ removeAllFilesFromDownloads() [1/2]

Default constructor for a function, which removes all files from the file download list.

Returns object_ptr<Ok>.

◆ removeAllFilesFromDownloads() [2/2]

removeAllFilesFromDownloads ( bool  only_active_,
bool  only_completed_,
bool  delete_from_cache_ 
)

Creates a function, which removes all files from the file download list.

Returns object_ptr<Ok>.

Parameters
[in]only_active_Pass true to remove only active downloads, including paused.
[in]only_completed_Pass true to remove only completed downloads.
[in]delete_from_cache_Pass true to delete the file from the TDLib file cache.

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: