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

Inherits Function.

Description

Edits the message content of a live location. Messages can be edited for a limited period of time specified in the live location. Returns the edited message after the edit is completed on the server side. Can be used only if message.can_be_edited == true.

Returns object_ptr<Message>.

Public Fields

int53 chat_id_
 The chat the message belongs to.
 
int53 message_id_
 Identifier of the message.
 
object_ptr< ReplyMarkupreply_markup_
 The new message reply markup; pass null if none; for bots only.
 
object_ptr< locationlocation_
 New location content of the message; pass null to stop sharing the live location.
 
int32 live_period_
 New time relative to the message send date, for which the location can be updated, in seconds. If 0x7FFFFFFF specified, then the location can be updated forever. Otherwise, must not exceed the current live_period by more than a day, and the live location expiration date must remain in the next 90 days. Pass 0 to keep the current live_period.
 
int32 heading_
 The new direction in which the location moves, in degrees; 1-360. Pass 0 if unknown.
 
int32 proximity_alert_radius_
 The new maximum distance for proximity alerts, in meters (0-100000). Pass 0 if the notification is disabled.
 

Public Types

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

Public Instance Methods

 editMessageLiveLocation ()
 
 editMessageLiveLocation (int53 chat_id_, int53 message_id_, object_ptr< ReplyMarkup > &&reply_markup_, object_ptr< location > &&location_, int32 live_period_, 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 = -1890511980
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ editMessageLiveLocation() [1/2]

Default constructor for a function, which edits the message content of a live location. Messages can be edited for a limited period of time specified in the live location. Returns the edited message after the edit is completed on the server side. Can be used only if message.can_be_edited == true.

Returns object_ptr<Message>.

◆ editMessageLiveLocation() [2/2]

editMessageLiveLocation ( int53  chat_id_,
int53  message_id_,
object_ptr< ReplyMarkup > &&  reply_markup_,
object_ptr< location > &&  location_,
int32  live_period_,
int32  heading_,
int32  proximity_alert_radius_ 
)

Creates a function, which edits the message content of a live location. Messages can be edited for a limited period of time specified in the live location. Returns the edited message after the edit is completed on the server side. Can be used only if message.can_be_edited == true.

Returns object_ptr<Message>.

Parameters
[in]chat_id_The chat the message belongs to.
[in]message_id_Identifier of the message.
[in]reply_markup_The new message reply markup; pass null if none; for bots only.
[in]location_New location content of the message; pass null to stop sharing the live location.
[in]live_period_New time relative to the message send date, for which the location can be updated, in seconds. If 0x7FFFFFFF specified, then the location can be updated forever. Otherwise, must not exceed the current live_period by more than a day, and the live location expiration date must remain in the next 90 days. Pass 0 to keep the current live_period.
[in]heading_The new direction in which the location moves, in degrees; 1-360. Pass 0 if unknown.
[in]proximity_alert_radius_The new maximum distance for proximity alerts, in meters (0-100000). Pass 0 if the notification is disabled.

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: