List of all members | Public Fields | Public Instance Methods | Static Public Attributes
messageLocation Class Referencefinal

Inherits MessageContent.

Description

A message with a location.

Public Fields

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; if 0x7FFFFFFF, then location can be updated forever.
 
int32 expires_in_
 Left time for which the location can be updated, in seconds. If 0, then the location can't be updated anymore. The update 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.
 

Public Instance Methods

 messageLocation ()
 
 messageLocation (object_ptr< location > &&location_, int32 live_period_, int32 expires_in_, int32 heading_, int32 proximity_alert_radius_)
 
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
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Static Public Attributes

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

Constructor & Destructor Documentation

◆ messageLocation() [1/2]

A message with a location.

◆ messageLocation() [2/2]

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; if 0x7FFFFFFF, then location can be updated forever.
[in]expires_in_Left time for which the location can be updated, in seconds. If 0, then the location can't be updated anymore. The update 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.

Method 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: