class Tourmaline::Chat

Overview

This object represents a chat.

Included Modules

Defined in:

tourmaline/types/api.cr
tourmaline/types/custom/chat.cr

Constructors

Instance Method Summary

Constructor Detail

def self.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, available_reactions : Array(Tourmaline::ReactionType) = [] of Tourmaline::ReactionType, accent_color_id : Int32 | Int64 | Nil = nil, background_custom_emoji_id : String | Nil = nil, profile_accent_color_id : Int32 | Int64 | Nil = nil, profile_background_custom_emoji_id : String | Nil = nil, emoji_status_custom_emoji_id : String | Nil = nil, emoji_status_expiration_date : Int32 | Int64 | 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, has_visible_history : 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) #

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

[View source]

Instance Method Detail

def accent_color_id : Int32 | Int64 | Nil #

Optional. Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details. Returned only in getChat. Always returned in getChat.


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

Optional. Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details. Returned only in getChat. Always returned in getChat.


[View source]
def 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.


[View source]
def 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.


[View source]
def available_reactions : Array(Tourmaline::ReactionType) #

Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed. Returned only in getChat.


[View source]
def available_reactions=(available_reactions : Array(Tourmaline::ReactionType)) #

Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed. Returned only in getChat.


[View source]
def background_custom_emoji_id : String | Nil #

Optional. Custom emoji identifier of emoji chosen by the chat for the reply header and link preview background. Returned only in getChat.


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

Optional. Custom emoji identifier of emoji chosen by the chat for the reply header and link preview background. Returned only in getChat.


[View source]
def bio : String | Nil #

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


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

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


[View source]
def 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.


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

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


[View source]
def channel? #

[View source]
def description : String | Nil #

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


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

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


[View source]
def emoji_status_custom_emoji_id : String | Nil #

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


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

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


[View source]
def emoji_status_expiration_date : Time | Nil #

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

[View source]
def first_name : String | Nil #

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


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

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


[View source]
def group? #

[View source]
def 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.


[View source]
def 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.


[View source]
def 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.


[View source]
def 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.


[View source]
def 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.


[View source]
def 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.


[View source]
def 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.


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

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


[View source]
def 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.


[View source]
def 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.


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

Optional. True, if new chat members will have access to old messages; available only to chat administrators. Returned only in getChat.


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

Optional. True, if new chat members will have access to old messages; available only to chat administrators. Returned only in getChat.


[View source]
def 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.


[View source]
def 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.


[View source]
def invite_link : String | Nil #

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


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

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


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

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


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

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


[View source]
def 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.


[View source]
def 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.


[View source]
def 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.


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

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


[View source]
def last_name : String | Nil #

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


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

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


[View source]
def 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.


[View source]
def 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.


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

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


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

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


[View source]
def message_auto_delete_time : Time | Nil #

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

[View source]
def name #

[View source]
def permissions : Tourmaline::ChatPermissions | Nil #

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


[View source]
def permissions=(permissions : Tourmaline::ChatPermissions | Nil) #

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


[View source]
def photo : Tourmaline::ChatPhoto | Nil #

Optional. Chat photo. Returned only in getChat.


[View source]
def photo=(photo : Tourmaline::ChatPhoto | Nil) #

Optional. Chat photo. Returned only in getChat.


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

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


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

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


[View source]
def private? #

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

Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details. Returned only in getChat.


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

Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details. Returned only in getChat.


[View source]
def profile_background_custom_emoji_id : String | Nil #

Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background. Returned only in getChat.


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

Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background. Returned only in getChat.


[View source]
def 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.


[View source]
def 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.


[View source]
def sticker_set_name : String | Nil #

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


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

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


[View source]
def supergroup? #

[View source]
def title : String | Nil #

Optional. Title, for supergroups, channels and group chats


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

Optional. Title, for supergroups, channels and group chats


[View source]
def type : String #

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


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

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


[View source]
def username : String | Nil #

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


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

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


[View source]