getMessageLink Class Reference

Inherits Function.

Description

Returns an HTTPS link to a message in a chat. Available only if messageProperties.can_get_link, or if messageProperties.can_get_media_timestamp_links and a media timestamp link is generated. This is an offline method.

Returns object_ptr<MessageLink>.

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

Public Member Functions
	getMessageLink ()
	getMessageLink (int53 chat_id_, int53 message_id_, int32 media_timestamp_, int32 checklist_task_id_, string const &poll_option_id_, bool for_album_, bool in_message_thread_)
void	store (TlStorerToString &s, const char *field_name) const final
Public Member Functions inherited from TlObject
TlObject &	operator= (const TlObject &)=delete
TlObject &	operator= (TlObject &&)=default
virtual void	store (TlStorerCalcLength &s) const
virtual void	store (TlStorerUnsafe &s) const
	TlObject ()=default
	TlObject (const TlObject &)=delete
	TlObject (TlObject &&)=default
virtual	~TlObject ()=default

Public Attributes
int53	chat_id_
	Identifier of the chat to which the message belongs.
int32	checklist_task_id_
	If not 0, identifier of the checklist task in the message to be linked.
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.
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 link preview.
int53	message_id_
	Identifier of the message.
string	poll_option_id_
	If not empty, identifier of the poll option in the message to be linked.

Static Public Attributes
static const std::int32_t	ID = -498469915
	Identifier uniquely determining a type of the object.

Constructor & Destructor Documentation

getMessageLink() [1/2]

getMessageLink

(

)

Default constructor for a function, which returns an HTTPS link to a message in a chat. Available only if messageProperties.can_get_link, or if messageProperties.can_get_media_timestamp_links and a media timestamp link is generated. This is an offline method.

Returns object_ptr<MessageLink>.

getMessageLink() [2/2]

getMessageLink	(	int53	chat_id_,
		int53	message_id_,
		int32	media_timestamp_,
		int32	checklist_task_id_,
		string const &	poll_option_id_,
		bool	for_album_,
		bool	in_message_thread_ )

Creates a function, which returns an HTTPS link to a message in a chat. Available only if messageProperties.can_get_link, or if messageProperties.can_get_media_timestamp_links and a media timestamp link is generated. This is an offline method.

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 link preview.
[in]	checklist_task_id_	If not 0, identifier of the checklist task in the message to be linked.
[in]	poll_option_id_	If not empty, identifier of the poll option in the message to be linked.
[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.

Member Function 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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements TlObject.

---

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

• td/generate/auto/td/telegram/td_api.h