class PrivateParlorXT::RelayParameters

• PrivateParlorXT::RelayParameters
• Reference
• Object

Overview

A container used for storing values necessary for Tourmaline send message methods

Defined in:

Constructors

• .new(original_message : MessageID, sender : UserID, receivers : Array(UserID), replies : Hash(UserID, ReplyParameters) = {} of UserID => ReplyParameters, text : String = "", entities : Array(Tourmaline::MessageEntity) | Nil = nil, link_preview_options : Tourmaline::LinkPreviewOptions | Nil = nil, media : String = "", spoiler : Bool | Nil = nil, effect : String | Nil = nil, caption_above_media : Bool | Nil = nil)

Instance Method Summary

• #caption_above_media : Bool | Nil

  Set to true if the message caption of photos, videos, or animations should be above the media, false or nil if the captoin should be below

• #effect : String | Nil

  ID of the message effect that should be attached to this message

• #entities : Array(Tourmaline::MessageEntity) | Nil

  The message entities for this message

• #link_preview_options : Tourmaline::LinkPreviewOptions | Nil

  Determines how the link in the text will be displayed

• #media : String

  A media file id

• #original_message : MessageID

  The message group MessageID

• #receivers : Array(UserID)

  Array of UserID who will receive this message

• #replies : Hash(UserID, ReplyParameters)

  A Hash of UserID to ReplyParameters, containing the message ID for that user's message which this message will reply to

• #sender : UserID

  UserID of the user who sent this message

• #spoiler : Bool | Nil

  Set to true if the message media should be spoiled, false or nil if message's media should not have a spoiler

• #text : String

  The text or caption of this message

Constructor Detail

Instance Method Detail