Class: TD::Types::MessageSendOptions

Inherits:
Base
  • Object
show all
Defined in:
lib/tdlib/types/message_send_options.rb

Overview

Options to be used when a message is sent.

Instance Attribute Summary collapse

Method Summary

Methods inherited from Base

#to_hash, #to_json

Instance Attribute Details

#disable_notificationBoolean

Pass true to disable notification for the message.



19
20
21
# File 'lib/tdlib/types/message_send_options.rb', line 19

def disable_notification
  @disable_notification
end

#effect_idInteger

Identifier of the effect to apply to the message; pass 0 if none; applicable only to sendMessage and sendMessageAlbum in private chats.



19
20
21
# File 'lib/tdlib/types/message_send_options.rb', line 19

def effect_id
  @effect_id
end

#from_backgroundBoolean

Pass true if the message is sent from the background.



19
20
21
# File 'lib/tdlib/types/message_send_options.rb', line 19

def from_background
  @from_background
end

#only_previewBoolean

Pass true to get a fake message instead of actually sending them.



19
20
21
# File 'lib/tdlib/types/message_send_options.rb', line 19

def only_preview
  @only_preview
end

#protect_contentBoolean

Pass true if the content of the message must be protected from forwarding and saving; for bots only.



19
20
21
# File 'lib/tdlib/types/message_send_options.rb', line 19

def protect_content
  @protect_content
end

#scheduling_stateTD::Types::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.



19
20
21
# File 'lib/tdlib/types/message_send_options.rb', line 19

def scheduling_state
  @scheduling_state
end

#sending_idInteger

Non-persistent identifier, which will be returned back in TD::Types::MessageSendingState::Pending object and can be used to match sent messages and corresponding Update::NewMessage updates.



19
20
21
# File 'lib/tdlib/types/message_send_options.rb', line 19

def sending_id
  @sending_id
end

#update_order_of_installed_sticker_setsBoolean

Pass true if the user explicitly chosen a sticker or a custom emoji from an installed sticker set; applicable only to sendMessage and sendMessageAlbum.



19
20
21
# File 'lib/tdlib/types/message_send_options.rb', line 19

def update_order_of_installed_sticker_sets
  @update_order_of_installed_sticker_sets
end