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

Inherits Function.

Description

Searches for files in the file download list or recently downloaded files from the list.

Returns object_ptr<FoundFileDownloads>.

Public Types

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

Public Member Functions

 searchFileDownloads ()
 searchFileDownloads (string const &query_, bool only_active_, bool only_completed_, string const &offset_, int32 limit_)
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

int32 limit_
 The maximum number of files to be returned.
string offset_
 Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results.
bool only_active_
 Pass true to search only for active downloads, including paused.
bool only_completed_
 Pass true to search only for completed downloads.
string query_
 Query to search for; may be empty to return all downloaded files.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ searchFileDownloads() [1/2]

searchFileDownloads ( )

Default constructor for a function, which searches for files in the file download list or recently downloaded files from the list.

Returns object_ptr<FoundFileDownloads>.

◆ searchFileDownloads() [2/2]

searchFileDownloads ( string const & query_,
bool only_active_,
bool only_completed_,
string const & offset_,
int32 limit_ )

Creates a function, which searches for files in the file download list or recently downloaded files from the list.

Returns object_ptr<FoundFileDownloads>.

Parameters
[in]query_Query to search for; may be empty to return all downloaded files.
[in]only_active_Pass true to search only for active downloads, including paused.
[in]only_completed_Pass true to search only for completed downloads.
[in]offset_Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results.
[in]limit_The maximum number of files to be returned.

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: