messageSendOptions Class Referencefinal
Inherits Object.
Description
Options to be used when a message is sent.
Public Member Functions | |
| messageSendOptions () | |
| messageSendOptions (object_ptr< inputSuggestedPostInfo > &&suggested_post_info_, bool disable_notification_, bool from_background_, bool protect_content_, bool allow_paid_broadcast_, int53 paid_message_star_count_, bool update_order_of_installed_sticker_sets_, object_ptr< MessageSchedulingState > &&scheduling_state_, int64 effect_id_, int32 sending_id_, bool only_preview_) | |
| 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 | |
| bool | allow_paid_broadcast_ |
| Pass true to allow the message to ignore regular broadcast limits for a small fee; for bots only. | |
| bool | disable_notification_ |
| Pass true to disable notification for the message. | |
| int64 | effect_id_ |
| Identifier of the effect to apply to the message; pass 0 if none; applicable only to sendMessage, sendMessageAlbum in private chats and forwardMessages with one message to private chats. | |
| bool | from_background_ |
| Pass true if the message is sent from the background. | |
| bool | only_preview_ |
| Pass true to get a fake message instead of actually sending them. | |
| int53 | paid_message_star_count_ |
| The number of Telegram Stars the user agreed to pay to send the messages. | |
| bool | protect_content_ |
| Pass true if the content of the message must be protected from forwarding and saving; for bots only. | |
| object_ptr< MessageSchedulingState > | scheduling_state_ |
| Message scheduling state; pass null to send message immediately. Messages sent to a secret chat, to a chat with paid messages, to a channel direct messages chat, live location messages and self-destructing messages can't be scheduled. | |
| 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< inputSuggestedPostInfo > | suggested_post_info_ |
| Information about the suggested post; pass null if none. For messages to channel direct messages chat only. Applicable only to sendMessage and addOffer. | |
| bool | update_order_of_installed_sticker_sets_ |
| Pass true if the user explicitly chosen a sticker or a custom emoji from an installed sticker set; applicable only to sendMessage and sendMessageAlbum. | |
Static Public Attributes | |
| static const std::int32_t | ID = -1725581906 |
| Identifier uniquely determining a type of the object. | |
Constructor & Destructor Documentation
◆ messageSendOptions() [1/2]
| messageSendOptions | ( | ) |
Options to be used when a message is sent.
◆ messageSendOptions() [2/2]
| messageSendOptions | ( | object_ptr< inputSuggestedPostInfo > && | suggested_post_info_, |
| bool | disable_notification_, | ||
| bool | from_background_, | ||
| bool | protect_content_, | ||
| bool | allow_paid_broadcast_, | ||
| int53 | paid_message_star_count_, | ||
| bool | update_order_of_installed_sticker_sets_, | ||
| object_ptr< MessageSchedulingState > && | scheduling_state_, | ||
| int64 | effect_id_, | ||
| int32 | sending_id_, | ||
| bool | only_preview_ ) |
Options to be used when a message is sent.
- Parameters
-
[in] suggested_post_info_ Information about the suggested post; pass null if none. For messages to channel direct messages chat only. Applicable only to sendMessage and addOffer. [in] disable_notification_ Pass true to disable notification for the message. [in] from_background_ Pass true if the message is sent from the background. [in] protect_content_ Pass true if the content of the message must be protected from forwarding and saving; for bots only. [in] allow_paid_broadcast_ Pass true to allow the message to ignore regular broadcast limits for a small fee; for bots only. [in] paid_message_star_count_ The number of Telegram Stars the user agreed to pay to send the messages. [in] update_order_of_installed_sticker_sets_ Pass true if the user explicitly chosen a sticker or a custom emoji from an installed sticker set; applicable only to sendMessage and sendMessageAlbum. [in] scheduling_state_ Message scheduling state; pass null to send message immediately. Messages sent to a secret chat, to a chat with paid messages, to a channel direct messages chat, live location messages and self-destructing messages can't be scheduled. [in] effect_id_ Identifier of the effect to apply to the message; pass 0 if none; applicable only to sendMessage, sendMessageAlbum in private chats and forwardMessages with one message to private chats. [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.
Member Function Documentation
◆ store()
|
finalvirtual |
The documentation for this class was generated from the following file:
- td/generate/auto/td/telegram/td_api.h
Generated by
1.17.0