MessageSendOptions class final

MessageSendOptions (messageSendOptions) - basic class

Options to be used when a message is sent.

  • disableNotification: Pass true to disable notification for the message.
  • fromBackground: Pass true if the message is sent from the background.
  • protectContent: Pass true if the content of the message must be protected from forwarding and saving; for bots only.
  • updateOrderOfInstalledStickerSets: Pass true if the user explicitly chosen a sticker or a custom emoji from an installed sticker set; applicable only to sendMessage and sendMessageAlbum.
  • schedulingState: 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 (optional).
  • effectId: Identifier of the effect to apply to the message; pass 0 if none; applicable only to sendMessage and sendMessageAlbum in private chats.
  • sendingId: Non-persistent identifier, which will be returned back in messageSendingStatePending object and can be used to match sent messages and corresponding updateNewMessage updates.
  • onlyPreview: Pass true to get a fake message instead of actually sending them.
Inheritance

Constructors

MessageSendOptions({required bool disableNotification, required bool fromBackground, required bool protectContent, required bool updateOrderOfInstalledStickerSets, MessageSchedulingState? schedulingState, required int effectId, required int sendingId, required bool onlyPreview})
MessageSendOptions (messageSendOptions) - basic class
const
MessageSendOptions.fromJson(Map<String, dynamic> json)
Parse from a json
factory

Properties

clientId → int?
Client ID, from which this object was received
no setterinherited
currentObjectId → String
TDLib object type for current class instance
no setteroverride
disableNotification → bool
Pass true to disable notification for the message
final
effectId → int
Identifier of the effect to apply to the message; pass 0 if none; applicable only to sendMessage and sendMessageAlbum in private chats
final
extra → dynamic
A sign from TDLib update
no setterinherited
fromBackground → bool
Pass true if the message is sent from the background
final
hashCode → int
The hash code for this object.
no setterinherited
onlyPreview → bool
Pass true to get a fake message instead of actually sending them
final
protectContent → bool
Pass true if the content of the message must be protected from forwarding and saving; for bots only
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schedulingState → MessageSchedulingState?
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
final
sendingId → int
Non-persistent identifier, which will be returned back in messageSendingStatePending object and can be used to match sent messages and corresponding updateNewMessage updates
final
updateOrderOfInstalledStickerSets → bool
Pass true if the user explicitly chosen a sticker or a custom emoji from an installed sticker set; applicable only to sendMessage and sendMessageAlbum
final

Methods

copyWith({bool? disableNotification, bool? fromBackground, bool? protectContent, bool? updateOrderOfInstalledStickerSets, MessageSchedulingState? schedulingState, int? effectId, int? sendingId, bool? onlyPreview}) → MessageSendOptions
Copy model with modified properties.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Convert model to TDLib JSON format
override
toString() → String
Convert model to TDLib JSON format, encoded into String.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

defaultObjectId → const String
TDLib object type