TDLib
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
liveLocation Class Referencefinal

Inherits Object.

Description

A live location.

Public Member Functions

 liveLocation ()
 
 liveLocation (object_ptr< location > &&location_, int32 live_period_, int32 heading_, int32 proximity_alert_radius_)
 
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 heading_
 The direction in which the location moves, in degrees; 1-360; 0 if unknown.
 
int32 live_period_
 Time relative to the message send date, for which the location can be updated, in seconds; if 0x7FFFFFFF, then location can be updated forever.
 
object_ptr< location > location_
 The current location.
 
int32 proximity_alert_radius_
 The maximum distance to another chat member for proximity alerts, in meters (0-100000). 0 if the notification is disabled. Can't be enabled in direct messages chats, channels and Saved Messages. Available only to the message sender.
 

Static Public Attributes

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

Constructor & Destructor Documentation

◆ liveLocation() [1/2]

A live location.

◆ liveLocation() [2/2]

liveLocation ( object_ptr< location > &&  location_,
int32  live_period_,
int32  heading_,
int32  proximity_alert_radius_ 
)

A live location.

Parameters
[in]location_The current location.
[in]live_period_Time relative to the message send date, for which the location can be updated, in seconds; if 0x7FFFFFFF, then location can be updated forever.
[in]heading_The direction in which the location moves, in degrees; 1-360; 0 if unknown.
[in]proximity_alert_radius_The maximum distance to another chat member for proximity alerts, in meters (0-100000). 0 if the notification is disabled. Can't be enabled in direct messages chats, channels and Saved Messages. Available only to the message sender.

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: