Description

Removes all files from the file download list.

Returns object_ptr<Ok>.

Public Fields
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.

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

Public Instance Methods
	removeAllFilesFromDownloads ()

	removeAllFilesFromDownloads (bool only_active_, bool only_completed_, bool delete_from_cache_)

void	store (TlStorerToString &s, const char *field_name) const final

Public Instance Methods inherited from 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

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

Constructor & Destructor Documentation

removeAllFilesFromDownloads ( )

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

Returns object_ptr<Ok>.

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.

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 TlObject.

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