td::td_api::removeAllFilesFromDownloads Class Reference

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

Inheritance diagram for td::td_api::removeAllFilesFromDownloads:

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 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
bool	only_active_
	Pass true to remove only active downloads, including paused.
bool	only_completed_
	Pass true to remove only completed downloads.
bool	delete_from_cache_
	Pass true to delete the file from the TDLib file cache.

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

Detailed Description

Removes all files from the file download list.

Returns object_ptr<Ok>.

Definition at line 119605 of file td_api.h.

Member Typedef Documentation

ReturnType

using td::td_api::removeAllFilesFromDownloads::ReturnType = object_ptr<ok>

Typedef for the type returned by the function.

Definition at line 119644 of file td_api.h.

Constructor & Destructor Documentation

removeAllFilesFromDownloads() [1/2]

td::td_api::removeAllFilesFromDownloads::removeAllFilesFromDownloads

(

)

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

Returns object_ptr<Ok>.

removeAllFilesFromDownloads() [2/2]

td::td_api::removeAllFilesFromDownloads::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 td::td_api::removeAllFilesFromDownloads::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

delete_from_cache_

bool td::td_api::removeAllFilesFromDownloads::delete_from_cache_

Pass true to delete the file from the TDLib file cache.

Definition at line 119620 of file td_api.h.

ID

const std::int32_t td::td_api::removeAllFilesFromDownloads::ID = -1186433402

static

Identifier uniquely determining a type of the object.

Definition at line 119641 of file td_api.h.

only_active_

bool td::td_api::removeAllFilesFromDownloads::only_active_

Pass true to remove only active downloads, including paused.

Definition at line 119616 of file td_api.h.

only_completed_

bool td::td_api::removeAllFilesFromDownloads::only_completed_

Pass true to remove only completed downloads.

Definition at line 119618 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