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

Inherits Function.

Description

Stops the downloading of a file. If a file has already been downloaded, does nothing.

Returns object_ptr<Ok>.

Public Types

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

Public Member Functions

 cancelDownloadFile ()
 cancelDownloadFile (int32 file_id_, bool only_if_pending_)
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 file_id_
 Identifier of a file to stop downloading.
bool only_if_pending_
 Pass true to stop downloading only if it hasn't been started, i.e. request hasn't been sent to server.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ cancelDownloadFile() [1/2]

cancelDownloadFile ( )

Default constructor for a function, which stops the downloading of a file. If a file has already been downloaded, does nothing.

Returns object_ptr<Ok>.

◆ cancelDownloadFile() [2/2]

cancelDownloadFile ( int32 file_id_,
bool only_if_pending_ )

Creates a function, which stops the downloading of a file. If a file has already been downloaded, does nothing.

Returns object_ptr<Ok>.

Parameters
[in]file_id_Identifier of a file to stop downloading.
[in]only_if_pending_Pass true to stop downloading only if it hasn't been started, i.e. request hasn't been sent to server.

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: