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

Inherits Object.

Description

Options to be used when a message is sent.

Public Fields

bool disable_notification_
 Pass true to disable notification for the message.
 
bool from_background_
 Pass true if the message is sent from the background.
 
bool protect_content_
 Pass true if the content of the message must be protected from forwarding and saving; for bots only.
 
bool allow_paid_broadcast_
 Pass true to allow the message to ignore regular broadcast limits for a small fee; for bots only.
 
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.
 
object_ptr< MessageSchedulingStatescheduling_state_
 Message scheduling state; pass null to send message immediately. Messages sent to a secret chat, live location messages and self-destructing messages can't be scheduled.
 
int64 effect_id_
 Identifier of the effect to apply to the message; pass 0 if none; applicable only to sendMessage and sendMessageAlbum in private chats.
 
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.
 
bool only_preview_
 Pass true to get a fake message instead of actually sending them.
 

Public Instance Methods

 messageSendOptions ()
 
 messageSendOptions (bool disable_notification_, bool from_background_, bool protect_content_, bool allow_paid_broadcast_, 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 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 = 776354378
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ messageSendOptions() [1/2]

Options to be used when a message is sent.

◆ messageSendOptions() [2/2]

messageSendOptions ( bool  disable_notification_,
bool  from_background_,
bool  protect_content_,
bool  allow_paid_broadcast_,
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]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]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, 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 and sendMessageAlbum in 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.

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: