class

Tourmaline::Chat

Inherits JSON::Serializable / Reference / Object

This object represents a chat.

Constructors

new(id : Int32 | Int64, type : String, title : String | Nil = nil, username : String | Nil = nil, first_name : String | Nil = nil, last_name : String | Nil = nil, is_forum : Bool | Nil = nil, photo : Tourmaline::ChatPhoto | Nil = nil, active_usernames : Array(String) = [] of String, emoji_status_custom_emoji_id : String | Nil = nil, bio : String | Nil = nil, has_private_forwards : Bool | Nil = nil, has_restricted_voice_and_video_messages : Bool | Nil = nil, join_to_send_messages : Bool | Nil = nil, join_by_request : Bool | Nil = nil, description : String | Nil = nil, invite_link : String | Nil = nil, pinned_message : Tourmaline::Message | Nil = nil, permissions : Tourmaline::ChatPermissions | Nil = nil, slow_mode_delay : Int32 | Int64 | Nil = nil, message_auto_delete_time : Int32 | Int64 | Nil = nil, has_aggressive_anti_spam_enabled : Bool | Nil = nil, has_hidden_members : Bool | Nil = nil, has_protected_content : Bool | Nil = nil, sticker_set_name : String | Nil = nil, can_set_sticker_set : Bool | Nil = nil, linked_chat_id : Int32 | Int64 | Nil = nil, location : Tourmaline::ChatLocation | Nil = nil)

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance methods

active_usernames

Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels. Returned only in getChat.

active_usernames=(active_usernames : Array(String))

Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels. Returned only in getChat.

bio

Optional. Bio of the other party in a private chat. Returned only in getChat.

bio=(bio : String | Nil)

Optional. Bio of the other party in a private chat. Returned only in getChat.

can_set_sticker_set=(can_set_sticker_set : Bool | Nil)

Optional. True, if the bot can change the group sticker set. Returned only in getChat.

can_set_sticker_set?

Optional. True, if the bot can change the group sticker set. Returned only in getChat.

channel?

description

Optional. Description, for groups, supergroups and channel chats. Returned only in getChat.

description=(description : String | Nil)

Optional. Description, for groups, supergroups and channel chats. Returned only in getChat.

emoji_status_custom_emoji_id

Optional. Custom emoji identifier of emoji status of the other party in a private chat. Returned only in getChat.

emoji_status_custom_emoji_id=(emoji_status_custom_emoji_id : String | Nil)

Optional. Custom emoji identifier of emoji status of the other party in a private chat. Returned only in getChat.

first_name

Optional. First name of the other party in a private chat

first_name=(first_name : String | Nil)

Optional. First name of the other party in a private chat

group?

has_aggressive_anti_spam_enabled=(has_aggressive_anti_spam_enabled : Bool | Nil)

Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in getChat.

has_aggressive_anti_spam_enabled?

Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in getChat.

has_hidden_members=(has_hidden_members : Bool | Nil)

Optional. True, if non-administrators can only get the list of bots and administrators in the chat. Returned only in getChat.

has_hidden_members?

Optional. True, if non-administrators can only get the list of bots and administrators in the chat. Returned only in getChat.

has_private_forwards=(has_private_forwards : Bool | Nil)

Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user. Returned only in getChat.

has_private_forwards?

Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user. Returned only in getChat.

has_protected_content=(has_protected_content : Bool | Nil)

Optional. True, if messages from the chat can't be forwarded to other chats. Returned only in getChat.

has_protected_content?

Optional. True, if messages from the chat can't be forwarded to other chats. Returned only in getChat.

has_restricted_voice_and_video_messages=(has_restricted_voice_and_video_messages : Bool | Nil)

Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in getChat.

has_restricted_voice_and_video_messages?

Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in getChat.

id

Unique identifier for this chat. 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.

id=(id : Int32 | Int64)

Unique identifier for this chat. 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.

invite_link

Optional. Primary invite link, for groups, supergroups and channel chats. Returned only in getChat.

invite_link=(invite_link : String | Nil)

Optional. Primary invite link, for groups, supergroups and channel chats. Returned only in getChat.

is_forum=(is_forum : Bool | Nil)

Optional. True, if the supergroup chat is a forum (has topics enabled)

is_forum?

Optional. True, if the supergroup chat is a forum (has topics enabled)

join_by_request=(join_by_request : Bool | Nil)

Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat.

join_by_request?

Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat.

join_to_send_messages=(join_to_send_messages : Bool | Nil)

Optional. True, if users need to join the supergroup before they can send messages. Returned only in getChat.

join_to_send_messages?

Optional. True, if users need to join the supergroup before they can send messages. Returned only in getChat.

last_name

Optional. Last name of the other party in a private chat

last_name=(last_name : String | Nil)

Optional. Last name of the other party in a private chat

linked_chat_id

Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in getChat.

linked_chat_id=(linked_chat_id : Int32 | Int64 | Nil)

Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in getChat.

location

Optional. For supergroups, the location to which the supergroup is connected. Returned only in getChat.

location=(location : Tourmaline::ChatLocation | Nil)

Optional. For supergroups, the location to which the supergroup is connected. Returned only in getChat.

message_auto_delete_time

Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat.

message_auto_delete_time=(message_auto_delete_time : Time | Nil)

Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat.

name

permissions

Optional. Default chat member permissions, for groups and supergroups. Returned only in getChat.

permissions=(permissions : Tourmaline::ChatPermissions | Nil)

Optional. Default chat member permissions, for groups and supergroups. Returned only in getChat.

photo

Optional. Chat photo. Returned only in getChat.

photo=(photo : Tourmaline::ChatPhoto | Nil)

Optional. Chat photo. Returned only in getChat.

pinned_message

Optional. The most recent pinned message (by sending date). Returned only in getChat.

pinned_message=(pinned_message : Tourmaline::Message | Nil)

Optional. The most recent pinned message (by sending date). Returned only in getChat.

private?

slow_mode_delay

Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in getChat.

slow_mode_delay=(slow_mode_delay : Int32 | Int64 | Nil)

Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in getChat.

sticker_set_name

Optional. For supergroups, name of group sticker set. Returned only in getChat.

sticker_set_name=(sticker_set_name : String | Nil)

Optional. For supergroups, name of group sticker set. Returned only in getChat.

supergroup?

title

Optional. Title, for supergroups, channels and group chats

title=(title : String | Nil)

Optional. Title, for supergroups, channels and group chats

type

Type of chat, can be either "private", "group", "supergroup" or "channel"

type=(type : String)

Type of chat, can be either "private", "group", "supergroup" or "channel"

username

Optional. Username, for private chats, supergroups and channels if available

username=(username : String | Nil)

Optional. Username, for private chats, supergroups and channels if available

Nested types

Tourmaline::Chat::Type