TDLib
Loading...
Searching...
No Matches
sendEphemeralMessage Class Referencefinal

Inherits Function.

Description

Sends an ephemeral message which will be received only by one bot in a chat. Currently, only ephemeral bot commands and replies to bot ephemeral messages can be sent using the method. The message is persistent across application restarts only if the message database is used. Returns the sent message.

Returns object_ptr<Message>.

Public Types

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

Public Member Functions

 sendEphemeralMessage ()
 sendEphemeralMessage (int53 chat_id_, object_ptr< MessageTopic > &&topic_id_, int53 receiver_user_id_, int64 callback_query_id_, object_ptr< InputMessageReplyTo > &&reply_to_, int32 sending_id_, bool only_preview_, object_ptr< ReplyMarkup > &&reply_markup_, object_ptr< InputMessageContent > &&input_message_content_)
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

int64 callback_query_id_
 Identifier of the callback query which triggered the message; for bots only.
int53 chat_id_
 Target chat.
object_ptr< InputMessageContent > input_message_content_
 The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageAnimation, inputMessageAudio, inputMessageDocument, inputMessagePhoto, inputMessageSticker, inputMessageVideo, inputMessageVideoNote, inputMessageVoiceNote, inputMessageLocation, inputMessageVenue, inputMessageContact.
bool only_preview_
 Pass true to get a fake message instead of actually sending them.
int53 receiver_user_id_
 Identifier of the user who will receive the message.
object_ptr< ReplyMarkup > reply_markup_
 Markup for replying to the message; pass null if none; for bots only.
object_ptr< InputMessageReplyTo > reply_to_
 Information about the message to be replied; pass null if none. The message can be an incoming ephemeral message.
int32 sending_id_
 Non-persistent identifier, which will be returned back in messageSendingStatePending object and can be used to match sent messages and corresponding updateNewMessage updates.
object_ptr< MessageTopic > topic_id_
 Topic in which the message will be sent; pass null if none.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ sendEphemeralMessage() [1/2]

sendEphemeralMessage ( )

Default constructor for a function, which sends an ephemeral message which will be received only by one bot in a chat. Currently, only ephemeral bot commands and replies to bot ephemeral messages can be sent using the method. The message is persistent across application restarts only if the message database is used. Returns the sent message.

Returns object_ptr<Message>.

◆ sendEphemeralMessage() [2/2]

sendEphemeralMessage ( int53 chat_id_,
object_ptr< MessageTopic > && topic_id_,
int53 receiver_user_id_,
int64 callback_query_id_,
object_ptr< InputMessageReplyTo > && reply_to_,
int32 sending_id_,
bool only_preview_,
object_ptr< ReplyMarkup > && reply_markup_,
object_ptr< InputMessageContent > && input_message_content_ )

Creates a function, which sends an ephemeral message which will be received only by one bot in a chat. Currently, only ephemeral bot commands and replies to bot ephemeral messages can be sent using the method. The message is persistent across application restarts only if the message database is used. Returns the sent message.

Returns object_ptr<Message>.

Parameters
[in]chat_id_Target chat.
[in]topic_id_Topic in which the message will be sent; pass null if none.
[in]receiver_user_id_Identifier of the user who will receive the message.
[in]callback_query_id_Identifier of the callback query which triggered the message; for bots only.
[in]reply_to_Information about the message to be replied; pass null if none. The message can be an incoming ephemeral message.
[in]sending_id_Non-persistent identifier, which will be returned back in messageSendingStatePending object and can be used to match sent messages and corresponding updateNewMessage updates.
[in]only_preview_Pass true to get a fake message instead of actually sending them.
[in]reply_markup_Markup for replying to the message; pass null if none; for bots only.
[in]input_message_content_The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageAnimation, inputMessageAudio, inputMessageDocument, inputMessagePhoto, inputMessageSticker, inputMessageVideo, inputMessageVideoNote, inputMessageVoiceNote, inputMessageLocation, inputMessageVenue, inputMessageContact.

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