class Tourmaline::Message

Overview

This object represents a message.

Included Modules

Defined in:

tourmaline/types/api.cr
tourmaline/types/custom/message.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(message_id : Int32 | Int64, date : Time, chat : Tourmaline::Chat, message_thread_id : Int32 | Int64 | Nil = nil, from : Tourmaline::User | Nil = nil, sender_chat : Tourmaline::Chat | Nil = nil, sender_boost_count : Int32 | Int64 | Nil = nil, sender_business_bot : Tourmaline::User | Nil = nil, business_connection_id : String | Nil = nil, forward_origin : Tourmaline::MessageOrigin | Nil = nil, is_topic_message : Bool | Nil = nil, is_automatic_forward : Bool | Nil = nil, reply_to_message : Tourmaline::Message | Nil = nil, external_reply : Tourmaline::ExternalReplyInfo | Nil = nil, quote : Tourmaline::TextQuote | Nil = nil, reply_to_story : Tourmaline::Story | Nil = nil, via_bot : Tourmaline::User | Nil = nil, edit_date : Int32 | Int64 | Nil = nil, has_protected_content : Bool | Nil = nil, is_from_offline : Bool | Nil = nil, media_group_id : String | Nil = nil, author_signature : String | Nil = nil, text : String | Nil = nil, entities : Array(Tourmaline::MessageEntity) = [] of Tourmaline::MessageEntity, link_preview_options : Tourmaline::LinkPreviewOptions | Nil = nil, effect_id : String | Nil = nil, animation : Tourmaline::Animation | Nil = nil, audio : Tourmaline::Audio | Nil = nil, document : Tourmaline::Document | Nil = nil, paid_media : Tourmaline::PaidMediaInfo | Nil = nil, photo : Array(Tourmaline::PhotoSize) = [] of Tourmaline::PhotoSize, sticker : Tourmaline::Sticker | Nil = nil, story : Tourmaline::Story | Nil = nil, video : Tourmaline::Video | Nil = nil, video_note : Tourmaline::VideoNote | Nil = nil, voice : Tourmaline::Voice | Nil = nil, caption : String | Nil = nil, caption_entities : Array(Tourmaline::MessageEntity) = [] of Tourmaline::MessageEntity, show_caption_above_media : Bool | Nil = nil, has_media_spoiler : Bool | Nil = nil, contact : Tourmaline::Contact | Nil = nil, dice : Tourmaline::Dice | Nil = nil, game : Tourmaline::Game | Nil = nil, poll : Tourmaline::Poll | Nil = nil, venue : Tourmaline::Venue | Nil = nil, location : Tourmaline::Location | Nil = nil, new_chat_members : Array(Tourmaline::User) = [] of Tourmaline::User, left_chat_member : Tourmaline::User | Nil = nil, new_chat_title : String | Nil = nil, new_chat_photo : Array(Tourmaline::PhotoSize) = [] of Tourmaline::PhotoSize, delete_chat_photo : Bool | Nil = nil, group_chat_created : Bool | Nil = nil, supergroup_chat_created : Bool | Nil = nil, channel_chat_created : Bool | Nil = nil, message_auto_delete_timer_changed : Tourmaline::MessageAutoDeleteTimerChanged | Nil = nil, migrate_to_chat_id : Int32 | Int64 | Nil = nil, migrate_from_chat_id : Int32 | Int64 | Nil = nil, pinned_message : Tourmaline::MaybeInaccessibleMessage | Nil = nil, invoice : Tourmaline::Invoice | Nil = nil, successful_payment : Tourmaline::SuccessfulPayment | Nil = nil, refunded_payment : Tourmaline::RefundedPayment | Nil = nil, users_shared : Tourmaline::UsersShared | Nil = nil, chat_shared : Tourmaline::ChatShared | Nil = nil, connected_website : String | Nil = nil, write_access_allowed : Tourmaline::WriteAccessAllowed | Nil = nil, passport_data : Tourmaline::PassportData | Nil = nil, proximity_alert_triggered : Tourmaline::ProximityAlertTriggered | Nil = nil, boost_added : Tourmaline::ChatBoostAdded | Nil = nil, chat_background_set : Tourmaline::ChatBackground | Nil = nil, forum_topic_created : Tourmaline::ForumTopicCreated | Nil = nil, forum_topic_edited : Tourmaline::ForumTopicEdited | Nil = nil, forum_topic_closed : Tourmaline::ForumTopicClosed | Nil = nil, forum_topic_reopened : Tourmaline::ForumTopicReopened | Nil = nil, general_forum_topic_hidden : Tourmaline::GeneralForumTopicHidden | Nil = nil, general_forum_topic_unhidden : Tourmaline::GeneralForumTopicUnhidden | Nil = nil, giveaway_created : Tourmaline::GiveawayCreated | Nil = nil, giveaway : Tourmaline::Giveaway | Nil = nil, giveaway_winners : Tourmaline::GiveawayWinners | Nil = nil, giveaway_completed : Tourmaline::GiveawayCompleted | Nil = nil, video_chat_scheduled : Tourmaline::VideoChatScheduled | Nil = nil, video_chat_started : Tourmaline::VideoChatStarted | Nil = nil, video_chat_ended : Tourmaline::VideoChatEnded | Nil = nil, video_chat_participants_invited : Tourmaline::VideoChatParticipantsInvited | Nil = nil, web_app_data : Tourmaline::WebAppData | Nil = nil, reply_markup : Tourmaline::InlineKeyboardMarkup | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def animation : Tourmaline::Animation | Nil #

Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set


[View source]
def animation=(animation : Tourmaline::Animation | Nil) #

Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set


[View source]
def audio : Tourmaline::Audio | Nil #

Optional. Message is an audio file, information about the file


[View source]
def audio=(audio : Tourmaline::Audio | Nil) #

Optional. Message is an audio file, information about the file


[View source]
def author_signature : String | Nil #

Optional. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator


[View source]
def author_signature=(author_signature : String | Nil) #

Optional. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator


[View source]
def boost_added : Tourmaline::ChatBoostAdded | Nil #

Optional. Service message: user boosted the chat


[View source]
def boost_added=(boost_added : Tourmaline::ChatBoostAdded | Nil) #

Optional. Service message: user boosted the chat


[View source]
def business_connection_id : String | Nil #

Optional. Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.


[View source]
def business_connection_id=(business_connection_id : String | Nil) #

Optional. Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.


[View source]
def caption : String | Nil #

Optional. Caption for the animation, audio, document, paid media, photo, video or voice


[View source]
def caption=(caption : String | Nil) #

Optional. Caption for the animation, audio, document, paid media, photo, video or voice


[View source]
def caption_entities : Array(Tourmaline::MessageEntity) #

Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption


[View source]
def caption_entities=(caption_entities : Array(Tourmaline::MessageEntity)) #

Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption


[View source]
def channel_chat_created=(channel_chat_created : Bool | Nil) #

Optional. Service message: the channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.


[View source]
def channel_chat_created? : Bool | Nil #

Optional. Service message: the channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.


[View source]
def chat : Tourmaline::Chat #

Chat the message belongs to


[View source]
def chat=(chat : Tourmaline::Chat) #

Chat the message belongs to


[View source]
def chat_background_set : Tourmaline::ChatBackground | Nil #

Optional. Service message: chat background set


[View source]
def chat_background_set=(chat_background_set : Tourmaline::ChatBackground | Nil) #

Optional. Service message: chat background set


[View source]
def chat_shared : Tourmaline::ChatShared | Nil #

Optional. Service message: a chat was shared with the bot


[View source]
def chat_shared=(chat_shared : Tourmaline::ChatShared | Nil) #

Optional. Service message: a chat was shared with the bot


[View source]
def chats #

[View source]
def chats(&block : Chat -> ) #

[View source]
def connected_website : String | Nil #

Optional. The domain name of the website on which the user has logged in. More about Telegram Login: https://core.telegram.org/widgets/login


[View source]
def connected_website=(connected_website : String | Nil) #

Optional. The domain name of the website on which the user has logged in. More about Telegram Login: https://core.telegram.org/widgets/login


[View source]
def contact : Tourmaline::Contact | Nil #

Optional. Message is a shared contact, information about the contact


[View source]
def contact=(contact : Tourmaline::Contact | Nil) #

Optional. Message is a shared contact, information about the contact


[View source]
def date : Time #

Date the message was sent in Unix time. It is always a positive number, representing a valid date.


[View source]
def date=(date : Time) #

Date the message was sent in Unix time. It is always a positive number, representing a valid date.


[View source]
def delete_chat_photo=(delete_chat_photo : Bool | Nil) #

Optional. Service message: the chat photo was deleted


[View source]
def delete_chat_photo? : Bool | Nil #

Optional. Service message: the chat photo was deleted


[View source]
def dice : Tourmaline::Dice | Nil #

Optional. Message is a dice with random value


[View source]
def dice=(dice : Tourmaline::Dice | Nil) #

Optional. Message is a dice with random value


[View source]
def document : Tourmaline::Document | Nil #

Optional. Message is a general file, information about the file


[View source]
def document=(document : Tourmaline::Document | Nil) #

Optional. Message is a general file, information about the file


[View source]
def edit_date : Time | Nil #

Optional. Date the message was last edited in Unix time


[View source]
def edit_date=(edit_date : Time | Nil) #

Optional. Date the message was last edited in Unix time


[View source]
def effect_id : String | Nil #

Optional. Unique identifier of the message effect added to the message


[View source]
def effect_id=(effect_id : String | Nil) #

Optional. Unique identifier of the message effect added to the message


[View source]
def entities : Array(Tourmaline::MessageEntity) #

Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text


[View source]
def entities=(entities : Array(Tourmaline::MessageEntity)) #

Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text


[View source]
def external_reply : Tourmaline::ExternalReplyInfo | Nil #

Optional. Information about the message that is being replied to, which may come from another chat or forum topic


[View source]
def external_reply=(external_reply : Tourmaline::ExternalReplyInfo | Nil) #

Optional. Information about the message that is being replied to, which may come from another chat or forum topic


[View source]
def file #

[View source]
def forum_topic_closed : Tourmaline::ForumTopicClosed | Nil #

Optional. Service message: forum topic closed


[View source]
def forum_topic_closed=(forum_topic_closed : Tourmaline::ForumTopicClosed | Nil) #

Optional. Service message: forum topic closed


[View source]
def forum_topic_created : Tourmaline::ForumTopicCreated | Nil #

Optional. Service message: forum topic created


[View source]
def forum_topic_created=(forum_topic_created : Tourmaline::ForumTopicCreated | Nil) #

Optional. Service message: forum topic created


[View source]
def forum_topic_edited : Tourmaline::ForumTopicEdited | Nil #

Optional. Service message: forum topic edited


[View source]
def forum_topic_edited=(forum_topic_edited : Tourmaline::ForumTopicEdited | Nil) #

Optional. Service message: forum topic edited


[View source]
def forum_topic_reopened : Tourmaline::ForumTopicReopened | Nil #

Optional. Service message: forum topic reopened


[View source]
def forum_topic_reopened=(forum_topic_reopened : Tourmaline::ForumTopicReopened | Nil) #

Optional. Service message: forum topic reopened


[View source]
def forward_origin : Tourmaline::MessageOrigin | Nil #

Optional. Information about the original message for forwarded messages


[View source]
def forward_origin=(forward_origin : Tourmaline::MessageOrigin | Nil) #

Optional. Information about the original message for forwarded messages


[View source]
def from : Tourmaline::User | Nil #

Optional. Sender of the message; may be empty for messages sent to channels. For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats


[View source]
def from=(from : Tourmaline::User | Nil) #

Optional. Sender of the message; may be empty for messages sent to channels. For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats


[View source]
def game : Tourmaline::Game | Nil #

Optional. Message is a game, information about the game. More about games: https://core.telegram.org/bots/api#games


[View source]
def game=(game : Tourmaline::Game | Nil) #

Optional. Message is a game, information about the game. More about games: https://core.telegram.org/bots/api#games


[View source]
def general_forum_topic_hidden : Tourmaline::GeneralForumTopicHidden | Nil #

Optional. Service message: the 'General' forum topic hidden


[View source]
def general_forum_topic_hidden=(general_forum_topic_hidden : Tourmaline::GeneralForumTopicHidden | Nil) #

Optional. Service message: the 'General' forum topic hidden


[View source]
def general_forum_topic_unhidden : Tourmaline::GeneralForumTopicUnhidden | Nil #

Optional. Service message: the 'General' forum topic unhidden


[View source]
def general_forum_topic_unhidden=(general_forum_topic_unhidden : Tourmaline::GeneralForumTopicUnhidden | Nil) #

Optional. Service message: the 'General' forum topic unhidden


[View source]
def giveaway : Tourmaline::Giveaway | Nil #

Optional. The message is a scheduled giveaway message


[View source]
def giveaway=(giveaway : Tourmaline::Giveaway | Nil) #

Optional. The message is a scheduled giveaway message


[View source]
def giveaway_completed : Tourmaline::GiveawayCompleted | Nil #

Optional. Service message: a giveaway without public winners was completed


[View source]
def giveaway_completed=(giveaway_completed : Tourmaline::GiveawayCompleted | Nil) #

Optional. Service message: a giveaway without public winners was completed


[View source]
def giveaway_created : Tourmaline::GiveawayCreated | Nil #

Optional. Service message: a scheduled giveaway was created


[View source]
def giveaway_created=(giveaway_created : Tourmaline::GiveawayCreated | Nil) #

Optional. Service message: a scheduled giveaway was created


[View source]
def giveaway_winners : Tourmaline::GiveawayWinners | Nil #

Optional. A giveaway with public winners was completed


[View source]
def giveaway_winners=(giveaway_winners : Tourmaline::GiveawayWinners | Nil) #

Optional. A giveaway with public winners was completed


[View source]
def group_chat_created=(group_chat_created : Bool | Nil) #

Optional. Service message: the group has been created


[View source]
def group_chat_created? : Bool | Nil #

Optional. Service message: the group has been created


[View source]
def has_media_spoiler=(has_media_spoiler : Bool | Nil) #

Optional. True, if the message media is covered by a spoiler animation


[View source]
def has_media_spoiler? : Bool | Nil #

Optional. True, if the message media is covered by a spoiler animation


[View source]
def has_protected_content=(has_protected_content : Bool | Nil) #

Optional. True, if the message can't be forwarded


[View source]
def has_protected_content? : Bool | Nil #

Optional. True, if the message can't be forwarded


[View source]
def invoice : Tourmaline::Invoice | Nil #

Optional. Message is an invoice for a payment, information about the invoice. More about payments: https://core.telegram.org/bots/api#payments


[View source]
def invoice=(invoice : Tourmaline::Invoice | Nil) #

Optional. Message is an invoice for a payment, information about the invoice. More about payments: https://core.telegram.org/bots/api#payments


[View source]
def is_automatic_forward=(is_automatic_forward : Bool | Nil) #

Optional. True, if the message is a channel post that was automatically forwarded to the connected discussion group


[View source]
def is_automatic_forward? : Bool | Nil #

Optional. True, if the message is a channel post that was automatically forwarded to the connected discussion group


[View source]
def is_from_offline=(is_from_offline : Bool | Nil) #

Optional. True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message


[View source]
def is_from_offline? : Bool | Nil #

Optional. True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message


[View source]
def is_topic_message=(is_topic_message : Bool | Nil) #

Optional. True, if the message is sent to a forum topic


[View source]
def is_topic_message? : Bool | Nil #

Optional. True, if the message is sent to a forum topic


[View source]
def left_chat_member : Tourmaline::User | Nil #

Optional. A member was removed from the group, information about them (this member may be the bot itself)


[View source]
def left_chat_member=(left_chat_member : Tourmaline::User | Nil) #

Optional. A member was removed from the group, information about them (this member may be the bot itself)


[View source]
def link #

[View source]
def link_preview_options : Tourmaline::LinkPreviewOptions | Nil #

Optional. Options used for link preview generation for the message, if it is a text message and link preview options were changed


[View source]
def link_preview_options=(link_preview_options : Tourmaline::LinkPreviewOptions | Nil) #

Optional. Options used for link preview generation for the message, if it is a text message and link preview options were changed


[View source]
def location : Tourmaline::Location | Nil #

Optional. Message is a shared location, information about the location


[View source]
def location=(location : Tourmaline::Location | Nil) #

Optional. Message is a shared location, information about the location


[View source]
def media_group_id : String | Nil #

Optional. The unique identifier of a media message group this message belongs to


[View source]
def media_group_id=(media_group_id : String | Nil) #

Optional. The unique identifier of a media message group this message belongs to


[View source]
def message_auto_delete_timer_changed : Tourmaline::MessageAutoDeleteTimerChanged | Nil #

Optional. Service message: auto-delete timer settings changed in the chat


[View source]
def message_auto_delete_timer_changed=(message_auto_delete_timer_changed : Tourmaline::MessageAutoDeleteTimerChanged | Nil) #

Optional. Service message: auto-delete timer settings changed in the chat


[View source]
def message_id : Int32 | Int64 #

Unique message identifier inside this chat. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent


[View source]
def message_id=(message_id : Int32 | Int64) #

Unique message identifier inside this chat. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent


[View source]
def message_thread_id : Int32 | Int64 | Nil #

Optional. Unique identifier of a message thread to which the message belongs; for supergroups only


[View source]
def message_thread_id=(message_thread_id : Int32 | Int64 | Nil) #

Optional. Unique identifier of a message thread to which the message belongs; for supergroups only


[View source]
def migrate_from_chat_id : Int32 | Int64 | Nil #

Optional. The supergroup has been migrated from a group with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.


[View source]
def migrate_from_chat_id=(migrate_from_chat_id : Int32 | Int64 | Nil) #

Optional. The supergroup has been migrated from a group with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.


[View source]
def migrate_to_chat_id : Int32 | Int64 | Nil #

Optional. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.


[View source]
def migrate_to_chat_id=(migrate_to_chat_id : Int32 | Int64 | Nil) #

Optional. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.


[View source]
def new_chat_members : Array(Tourmaline::User) #

Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)


[View source]
def new_chat_members=(new_chat_members : Array(Tourmaline::User)) #

Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)


[View source]
def new_chat_photo : Array(Tourmaline::PhotoSize) #

Optional. A chat photo was change to this value


[View source]
def new_chat_photo=(new_chat_photo : Array(Tourmaline::PhotoSize)) #

Optional. A chat photo was change to this value


[View source]
def new_chat_title : String | Nil #

Optional. A chat title was changed to this value


[View source]
def new_chat_title=(new_chat_title : String | Nil) #

Optional. A chat title was changed to this value


[View source]
def passport_data : Tourmaline::PassportData | Nil #

Optional. Telegram Passport data


[View source]
def passport_data=(passport_data : Tourmaline::PassportData | Nil) #

Optional. Telegram Passport data


[View source]
def photo : Array(Tourmaline::PhotoSize) #

Optional. Message is a photo, available sizes of the photo


[View source]
def photo=(photo : Array(Tourmaline::PhotoSize)) #

Optional. Message is a photo, available sizes of the photo


[View source]
def pinned_message : Tourmaline::MaybeInaccessibleMessage | Nil #

Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.


[View source]
def pinned_message=(pinned_message : Tourmaline::MaybeInaccessibleMessage | Nil) #

Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.


[View source]
def poll : Tourmaline::Poll | Nil #

Optional. Message is a native poll, information about the poll


[View source]
def poll=(poll : Tourmaline::Poll | Nil) #

Optional. Message is a native poll, information about the poll


[View source]
def proximity_alert_triggered : Tourmaline::ProximityAlertTriggered | Nil #

Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.


[View source]
def proximity_alert_triggered=(proximity_alert_triggered : Tourmaline::ProximityAlertTriggered | Nil) #

Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.


[View source]
def quote : Tourmaline::TextQuote | Nil #

Optional. For replies that quote part of the original message, the quoted part of the message


[View source]
def quote=(quote : Tourmaline::TextQuote | Nil) #

Optional. For replies that quote part of the original message, the quoted part of the message


[View source]
def refunded_payment : Tourmaline::RefundedPayment | Nil #

Optional. Message is a service message about a refunded payment, information about the payment. More about payments: https://core.telegram.org/bots/api#payments


[View source]
def refunded_payment=(refunded_payment : Tourmaline::RefundedPayment | Nil) #

Optional. Message is a service message about a refunded payment, information about the payment. More about payments: https://core.telegram.org/bots/api#payments


[View source]
def reply_markup : Tourmaline::InlineKeyboardMarkup | Nil #

Optional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons.


[View source]
def reply_markup=(reply_markup : Tourmaline::InlineKeyboardMarkup | Nil) #

Optional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons.


[View source]
def reply_to_message : Tourmaline::Message | Nil #

Optional. For replies in the same chat and message thread, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.


[View source]
def reply_to_message=(reply_to_message : Tourmaline::Message | Nil) #

Optional. For replies in the same chat and message thread, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.


[View source]
def reply_to_story : Tourmaline::Story | Nil #

Optional. For replies to a story, the original story


[View source]
def reply_to_story=(reply_to_story : Tourmaline::Story | Nil) #

Optional. For replies to a story, the original story


[View source]
def sender_boost_count : Int32 | Int64 | Nil #

Optional. If the sender of the message boosted the chat, the number of boosts added by the user


[View source]
def sender_boost_count=(sender_boost_count : Int32 | Int64 | Nil) #

Optional. If the sender of the message boosted the chat, the number of boosts added by the user


[View source]
def sender_business_bot : Tourmaline::User | Nil #

Optional. The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.


[View source]
def sender_business_bot=(sender_business_bot : Tourmaline::User | Nil) #

Optional. The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.


[View source]
def sender_chat : Tourmaline::Chat | Nil #

Optional. Sender of the message when sent on behalf of a chat. For example, the supergroup itself for messages sent by its anonymous administrators or a linked channel for messages automatically forwarded to the channel's discussion group. For backward compatibility, if the message was sent on behalf of a chat, the field from contains a fake sender user in non-channel chats.


[View source]
def sender_chat=(sender_chat : Tourmaline::Chat | Nil) #

Optional. Sender of the message when sent on behalf of a chat. For example, the supergroup itself for messages sent by its anonymous administrators or a linked channel for messages automatically forwarded to the channel's discussion group. For backward compatibility, if the message was sent on behalf of a chat, the field from contains a fake sender user in non-channel chats.


[View source]
def sender_type #

[View source]
def show_caption_above_media=(show_caption_above_media : Bool | Nil) #

Optional. True, if the caption must be shown above the message media


[View source]
def show_caption_above_media? : Bool | Nil #

Optional. True, if the caption must be shown above the message media


[View source]
def sticker : Tourmaline::Sticker | Nil #

Optional. Message is a sticker, information about the sticker


[View source]
def sticker=(sticker : Tourmaline::Sticker | Nil) #

Optional. Message is a sticker, information about the sticker


[View source]
def story : Tourmaline::Story | Nil #

Optional. Message is a forwarded story


[View source]
def story=(story : Tourmaline::Story | Nil) #

Optional. Message is a forwarded story


[View source]
def successful_payment : Tourmaline::SuccessfulPayment | Nil #

Optional. Message is a service message about a successful payment, information about the payment. More about payments: https://core.telegram.org/bots/api#payments


[View source]
def successful_payment=(successful_payment : Tourmaline::SuccessfulPayment | Nil) #

Optional. Message is a service message about a successful payment, information about the payment. More about payments: https://core.telegram.org/bots/api#payments


[View source]
def supergroup_chat_created=(supergroup_chat_created : Bool | Nil) #

Optional. Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.


[View source]
def supergroup_chat_created? : Bool | Nil #

Optional. Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.


[View source]
def text : String | Nil #

Optional. For text messages, the actual UTF-8 text of the message


[View source]
def text=(text : String | Nil) #

Optional. For text messages, the actual UTF-8 text of the message


[View source]
def text_entities(type : String) #

[View source]
def text_entities #

[View source]
def users #

[View source]
def users(&block : User -> ) #

[View source]
def users_shared : Tourmaline::UsersShared | Nil #

Optional. Service message: users were shared with the bot


[View source]
def users_shared=(users_shared : Tourmaline::UsersShared | Nil) #

Optional. Service message: users were shared with the bot


[View source]
def venue : Tourmaline::Venue | Nil #

Optional. Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set


[View source]
def venue=(venue : Tourmaline::Venue | Nil) #

Optional. Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set


[View source]
def via_bot : Tourmaline::User | Nil #

Optional. Bot through which the message was sent


[View source]
def via_bot=(via_bot : Tourmaline::User | Nil) #

Optional. Bot through which the message was sent


[View source]
def video : Tourmaline::Video | Nil #

Optional. Message is a video, information about the video


[View source]
def video=(video : Tourmaline::Video | Nil) #

Optional. Message is a video, information about the video


[View source]
def video_chat_ended : Tourmaline::VideoChatEnded | Nil #

Optional. Service message: video chat ended


[View source]
def video_chat_ended=(video_chat_ended : Tourmaline::VideoChatEnded | Nil) #

Optional. Service message: video chat ended


[View source]
def video_chat_participants_invited : Tourmaline::VideoChatParticipantsInvited | Nil #

Optional. Service message: new participants invited to a video chat


[View source]
def video_chat_participants_invited=(video_chat_participants_invited : Tourmaline::VideoChatParticipantsInvited | Nil) #

Optional. Service message: new participants invited to a video chat


[View source]
def video_chat_scheduled : Tourmaline::VideoChatScheduled | Nil #

Optional. Service message: video chat scheduled


[View source]
def video_chat_scheduled=(video_chat_scheduled : Tourmaline::VideoChatScheduled | Nil) #

Optional. Service message: video chat scheduled


[View source]
def video_chat_started : Tourmaline::VideoChatStarted | Nil #

Optional. Service message: video chat started


[View source]
def video_chat_started=(video_chat_started : Tourmaline::VideoChatStarted | Nil) #

Optional. Service message: video chat started


[View source]
def video_note : Tourmaline::VideoNote | Nil #

Optional. Message is a video note, information about the video message


[View source]
def video_note=(video_note : Tourmaline::VideoNote | Nil) #

Optional. Message is a video note, information about the video message


[View source]
def voice : Tourmaline::Voice | Nil #

Optional. Message is a voice message, information about the file


[View source]
def voice=(voice : Tourmaline::Voice | Nil) #

Optional. Message is a voice message, information about the file


[View source]
def web_app_data : Tourmaline::WebAppData | Nil #

Optional. Service message: data sent by a Web App


[View source]
def web_app_data=(web_app_data : Tourmaline::WebAppData | Nil) #

Optional. Service message: data sent by a Web App


[View source]
def write_access_allowed : Tourmaline::WriteAccessAllowed | Nil #

Optional. Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess


[View source]
def write_access_allowed=(write_access_allowed : Tourmaline::WriteAccessAllowed | Nil) #

Optional. Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess


[View source]