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

Inherits Function.

Description

Returns an HTTPS link to a message in a chat. Available only for already sent messages in supergroups and channels, or if message.can_get_media_timestamp_links and a media timestamp link is generated. This is an offline request.

Returns object_ptr<MessageLink>.

Public Fields

int53 chat_id_
 Identifier of the chat to which the message belongs.
 
int53 message_id_
 Identifier of the message.
 
int32 media_timestamp_
 If not 0, timestamp from which the video/audio/video note/voice note/story playing must start, in seconds. The media can be in the message content or in its web page preview.
 
bool for_album_
 Pass true to create a link for the whole media album.
 
bool in_message_thread_
 Pass true to create a link to the message as a channel post comment, in a message thread, or a forum topic.
 

Public Types

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

Public Instance Methods

 getMessageLink ()
 
 getMessageLink (int53 chat_id_, int53 message_id_, int32 media_timestamp_, bool for_album_, bool in_message_thread_)
 
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 = -984158342
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ getMessageLink() [1/2]

Default constructor for a function, which returns an HTTPS link to a message in a chat. Available only for already sent messages in supergroups and channels, or if message.can_get_media_timestamp_links and a media timestamp link is generated. This is an offline request.

Returns object_ptr<MessageLink>.

◆ getMessageLink() [2/2]

getMessageLink ( int53  chat_id_,
int53  message_id_,
int32  media_timestamp_,
bool  for_album_,
bool  in_message_thread_ 
)

Creates a function, which returns an HTTPS link to a message in a chat. Available only for already sent messages in supergroups and channels, or if message.can_get_media_timestamp_links and a media timestamp link is generated. This is an offline request.

Returns object_ptr<MessageLink>.

Parameters
[in]chat_id_Identifier of the chat to which the message belongs.
[in]message_id_Identifier of the message.
[in]media_timestamp_If not 0, timestamp from which the video/audio/video note/voice note/story playing must start, in seconds. The media can be in the message content or in its web page preview.
[in]for_album_Pass true to create a link for the whole media album.
[in]in_message_thread_Pass true to create a link to the message as a channel post comment, in a message thread, or a forum topic.

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: