tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::editMessageLiveLocation Class Referencefinal

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::editMessageLiveLocation:
td::td_api::Function td::TlObject

Public Types

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

Public Member Functions

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

int53 chat_id_
 The chat the message belongs to.
 
int53 message_id_
 Identifier of the message. Use messageProperties.can_be_edited to check whether the message can be edited.
 
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.
 

Static Public Attributes

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

Detailed 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.

Returns object_ptr<Message>.

Definition at line 98667 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 98718 of file td_api.h.

Constructor & Destructor Documentation

◆ editMessageLiveLocation() [1/2]

td::td_api::editMessageLiveLocation::editMessageLiveLocation ( )

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.

Returns object_ptr<Message>.

◆ editMessageLiveLocation() [2/2]

td::td_api::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_ 
)

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.

Returns object_ptr<Message>.

Parameters
[in]chat_id_The chat the message belongs to.
[in]message_id_Identifier of the message. Use messageProperties.can_be_edited to check whether the message can be edited.
[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.

Member Function Documentation

◆ store()

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

Member Data Documentation

◆ chat_id_

int53 td::td_api::editMessageLiveLocation::chat_id_

The chat the message belongs to.

Definition at line 98678 of file td_api.h.

◆ heading_

int32 td::td_api::editMessageLiveLocation::heading_

The new direction in which the location moves, in degrees; 1-360. Pass 0 if unknown.

Definition at line 98688 of file td_api.h.

◆ ID

const std::int32_t td::td_api::editMessageLiveLocation::ID = -1890511980
static

Identifier uniquely determining a type of the object.

Definition at line 98715 of file td_api.h.

◆ live_period_

int32 td::td_api::editMessageLiveLocation::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.

Definition at line 98686 of file td_api.h.

◆ location_

object_ptr<location> td::td_api::editMessageLiveLocation::location_

New location content of the message; pass null to stop sharing the live location.

Definition at line 98684 of file td_api.h.

◆ message_id_

int53 td::td_api::editMessageLiveLocation::message_id_

Identifier of the message. Use messageProperties.can_be_edited to check whether the message can be edited.

Definition at line 98680 of file td_api.h.

◆ proximity_alert_radius_

int32 td::td_api::editMessageLiveLocation::proximity_alert_radius_

The new maximum distance for proximity alerts, in meters (0-100000). Pass 0 if the notification is disabled.

Definition at line 98690 of file td_api.h.

◆ reply_markup_

object_ptr<ReplyMarkup> td::td_api::editMessageLiveLocation::reply_markup_

The new message reply markup; pass null if none; for bots only.

Definition at line 98682 of file td_api.h.


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