TDLib
Loading...
Searching...
No Matches
td::td_api::setNetworkType Class Referencefinal

Inherits td::td_api::Function.

Public Types

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

Public Member Functions

 setNetworkType ()
 
 setNetworkType (object_ptr< NetworkType > &&type_)
 
std::int32_t get_id () const final
 
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
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Public Attributes

object_ptr< NetworkTypetype_
 The new network type; pass null to set network type to networkTypeOther.
 

Static Public Attributes

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

Detailed Description

Sets the current network type. Can be called before authorization. Calling this method forces all network connections to reopen, mitigating the delay in switching between different networks, so it must be called whenever the network is changed, even if the network type remains the same. Network type is used to check whether the library can use the network at all and also for collecting detailed network data usage statistics.

Returns object_ptr<Ok>.

Constructor & Destructor Documentation

◆ setNetworkType() [1/2]

td::td_api::setNetworkType::setNetworkType ( )

Default constructor for a function, which sets the current network type. Can be called before authorization. Calling this method forces all network connections to reopen, mitigating the delay in switching between different networks, so it must be called whenever the network is changed, even if the network type remains the same. Network type is used to check whether the library can use the network at all and also for collecting detailed network data usage statistics.

Returns object_ptr<Ok>.

◆ setNetworkType() [2/2]

td::td_api::setNetworkType::setNetworkType ( object_ptr< NetworkType > &&  type_)
explicit

Creates a function, which sets the current network type. Can be called before authorization. Calling this method forces all network connections to reopen, mitigating the delay in switching between different networks, so it must be called whenever the network is changed, even if the network type remains the same. Network type is used to check whether the library can use the network at all and also for collecting detailed network data usage statistics.

Returns object_ptr<Ok>.

Parameters
[in]type_The new network type; pass null to set network type to networkTypeOther.

Member Function Documentation

◆ get_id()

std::int32_t td::td_api::setNetworkType::get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements td::TlObject.

◆ store()

void td::td_api::setNetworkType::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 td::TlObject.


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