td::td_api::searchFileDownloads Class Reference

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::searchFileDownloads:

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 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
string	query_
	Query to search for; may be empty to return all downloaded files.
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	offset_
	Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results.
int32	limit_
	The maximum number of files to be returned.

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

Detailed Description

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

Returns object_ptr<FoundFileDownloads>.

Definition at line 123932 of file td_api.h.

Member Typedef Documentation

ReturnType

using td::td_api::searchFileDownloads::ReturnType = object_ptr<foundFileDownloads>

Typedef for the type returned by the function.

Definition at line 123977 of file td_api.h.

Constructor & Destructor Documentation

searchFileDownloads() [1/2]

td::td_api::searchFileDownloads::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]

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

Member Data Documentation

ID

const std::int32_t td::td_api::searchFileDownloads::ID = 706611286

static

Identifier uniquely determining a type of the object.

Definition at line 123974 of file td_api.h.

limit_

int32 td::td_api::searchFileDownloads::limit_

The maximum number of files to be returned.

Definition at line 123951 of file td_api.h.

offset_

string td::td_api::searchFileDownloads::offset_

Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results.

Definition at line 123949 of file td_api.h.

only_active_

bool td::td_api::searchFileDownloads::only_active_

Pass true to search only for active downloads, including paused.

Definition at line 123945 of file td_api.h.

only_completed_

bool td::td_api::searchFileDownloads::only_completed_

Pass true to search only for completed downloads.

Definition at line 123947 of file td_api.h.

query_

string td::td_api::searchFileDownloads::query_

Query to search for; may be empty to return all downloaded files.

Definition at line 123943 of file td_api.h.

---

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

• /home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h