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

Inherits td::td_api::MessageContent.

Public Member Functions

 messageLocation ()
 
 messageLocation (object_ptr< location > &&location_, int32 live_period_, int32 expires_in_, int32 heading_, int32 proximity_alert_radius_)
 
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< locationlocation_
 The location description.
 
int32 live_period_
 Time relative to the message send date, for which the location can be updated, in seconds.
 
int32 expires_in_
 Left time for which the location can be updated, in seconds. updateMessageContent is not sent when this field changes.
 
int32 heading_
 For live locations, a direction in which the location moves, in degrees; 1-360. If 0 the direction is unknown.
 
int32 proximity_alert_radius_
 For live locations, a maximum distance to another chat member for proximity alerts, in meters (0-100000). 0 if the notification is disabled. Available only to the message sender.
 

Static Public Attributes

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

Detailed Description

A message with a location.

Constructor & Destructor Documentation

◆ messageLocation() [1/2]

td::td_api::messageLocation::messageLocation ( )

A message with a location.

◆ messageLocation() [2/2]

td::td_api::messageLocation::messageLocation ( object_ptr< location > &&  location_,
int32  live_period_,
int32  expires_in_,
int32  heading_,
int32  proximity_alert_radius_ 
)

A message with a location.

Parameters
[in]location_The location description.
[in]live_period_Time relative to the message send date, for which the location can be updated, in seconds.
[in]expires_in_Left time for which the location can be updated, in seconds. updateMessageContent is not sent when this field changes.
[in]heading_For live locations, a direction in which the location moves, in degrees; 1-360. If 0 the direction is unknown.
[in]proximity_alert_radius_For live locations, a maximum distance to another chat member for proximity alerts, in meters (0-100000). 0 if the notification is disabled. Available only to the message sender.

Member Function Documentation

◆ get_id()

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

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements td::TlObject.

◆ store()

void td::td_api::messageLocation::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: