Class: TD::Types::Chat

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

Overview

A chat. (Can be a private chat, basic group, supergroup, or secret chat).

Instance Attribute Summary collapse

Method Summary

Methods inherited from Base

#to_hash, #to_json

Instance Attribute Details

#accent_color_id ⇒ Integer

Identifier of the accent color for message sender name, and backgrounds of chat photo, reply header, and link preview.

Returns:

  • (Integer) —

    the current value of accent_color_id



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def accent_color_id
  @accent_color_id
end

#action_bar ⇒ TD::Types::ChatActionBar?

Information about actions which must be possible to do through the chat action bar; may be null if none.

Returns:



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def action_bar
  @action_bar
end

#available_reactions ⇒ TD::Types::ChatAvailableReactions

Types of reaction, available in the chat.

Returns:



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def available_reactions
  @available_reactions
end

#background ⇒ TD::Types::ChatBackground?

Background set for the chat; may be null if none.

Returns:



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def background
  @background
end

#background_custom_emoji_id ⇒ Integer

Identifier of a custom emoji to be shown on the reply header and link preview background for messages sent by the chat; 0 if none.

Returns:

  • (Integer) —

    the current value of background_custom_emoji_id



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def background_custom_emoji_id
  @background_custom_emoji_id
end

#block_list ⇒ TD::Types::BlockList?

Block list to which the chat is added; may be null if none.

Returns:



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def block_list
  @block_list
end

#business_bot_manage_bar ⇒ TD::Types::BusinessBotManageBar?

Information about bar for managing a business bot in the chat; may be null if none.

Returns:



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def business_bot_manage_bar
  @business_bot_manage_bar
end

#can_be_deleted_for_all_users ⇒ Boolean

True, if the chat messages can be deleted for all users.

Returns:

  • (Boolean) —

    the current value of can_be_deleted_for_all_users



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def can_be_deleted_for_all_users
  @can_be_deleted_for_all_users
end

#can_be_deleted_only_for_self ⇒ Boolean

True, if the chat messages can be deleted only for the current user while other users will continue to see the messages.

Returns:

  • (Boolean) —

    the current value of can_be_deleted_only_for_self



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def can_be_deleted_only_for_self
  @can_be_deleted_only_for_self
end

#can_be_reported ⇒ Boolean

True, if the chat can be reported to Telegram moderators through reportChat or reportChatPhoto.

Returns:

  • (Boolean) —

    the current value of can_be_reported



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def can_be_reported
  @can_be_reported
end

#chat_lists ⇒ Array<TD::Types::ChatList>

Chat lists to which the chat belongs. A chat can have a non-zero position in a chat list even it doesn’t belong to the chat list and have no position in a chat list even it belongs to the chat list.

Returns:



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def chat_lists
  @chat_lists
end

#client_data ⇒ TD::Types::String

Application-specific data associated with the chat. (For example, the chat scroll position or local chat notification settings can be stored here.) Persistent if the message database is used.

Returns:

  • (TD::Types::String) —

    the current value of client_data



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def client_data
  @client_data
end

#default_disable_notification ⇒ Boolean

Default value of the disable_notification parameter, used when a message is sent to the chat.

Returns:

  • (Boolean) —

    the current value of default_disable_notification



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def default_disable_notification
  @default_disable_notification
end

#draft_message ⇒ TD::Types::DraftMessage?

A draft of a message in the chat; may be null if none.

Returns:



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def draft_message
  @draft_message
end

#emoji_status ⇒ TD::Types::EmojiStatus?

Emoji status to be shown along with chat title; may be null.

Returns:



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def emoji_status
  @emoji_status
end

#has_protected_content ⇒ Boolean

True, if chat content can’t be saved locally, forwarded, or copied.

Returns:

  • (Boolean) —

    the current value of has_protected_content



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def has_protected_content
  @has_protected_content
end

#has_scheduled_messages ⇒ Boolean

True, if the chat has scheduled messages.

Returns:

  • (Boolean) —

    the current value of has_scheduled_messages



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def has_scheduled_messages
  @has_scheduled_messages
end

#id ⇒ Integer

Chat unique identifier.

Returns:

  • (Integer) —

    the current value of id



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def id
  @id
end

#is_marked_as_unread ⇒ Boolean

True, if the chat is marked as unread.

Returns:

  • (Boolean) —

    the current value of is_marked_as_unread



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def is_marked_as_unread
  @is_marked_as_unread
end

#is_translatable ⇒ Boolean

True, if translation of all messages in the chat must be suggested to the user.

Returns:

  • (Boolean) —

    the current value of is_translatable



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def is_translatable
  @is_translatable
end

#last_message ⇒ TD::Types::Message?

Last message in the chat; may be null if none or unknown.

Returns:



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def last_message
  @last_message
end

#last_read_inbox_message_id ⇒ Integer

Identifier of the last read incoming message.

Returns:

  • (Integer) —

    the current value of last_read_inbox_message_id



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def last_read_inbox_message_id
  @last_read_inbox_message_id
end

#last_read_outbox_message_id ⇒ Integer

Identifier of the last read outgoing message.

Returns:

  • (Integer) —

    the current value of last_read_outbox_message_id



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def last_read_outbox_message_id
  @last_read_outbox_message_id
end

#message_auto_delete_time ⇒ Integer

Current message auto-delete or self-destruct timer setting for the chat, in seconds; 0 if disabled. Self-destruct timer in secret chats starts after the message or its content is viewed. Auto-delete timer in other chats starts from the send date.

Returns:

  • (Integer) —

    the current value of message_auto_delete_time



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def message_auto_delete_time
  @message_auto_delete_time
end

#message_sender_id ⇒ TD::Types::MessageSender?

Identifier of a user or chat that is selected to send messages in the chat; may be null if the user can’t change message sender.

Returns:



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def message_sender_id
  @message_sender_id
end

#notification_settings ⇒ TD::Types::ChatNotificationSettings

Notification settings for the chat.

Returns:



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def notification_settings
  @notification_settings
end

#pending_join_requests ⇒ TD::Types::ChatJoinRequestsInfo?

Information about pending join requests; may be null if none.

Returns:



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def pending_join_requests
  @pending_join_requests
end

#permissions ⇒ TD::Types::ChatPermissions

Actions that non-administrator chat members are allowed to take in the chat.

Returns:



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def permissions
  @permissions
end

#photo ⇒ TD::Types::ChatPhotoInfo?

Chat photo; may be null.

Returns:



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def photo
  @photo
end

#positions ⇒ Array<TD::Types::ChatPosition>

Positions of the chat in chat lists.

Returns:



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def positions
  @positions
end

#profile_accent_color_id ⇒ Integer

Identifier of the profile accent color for the chat’s profile; -1 if none.

Returns:

  • (Integer) —

    the current value of profile_accent_color_id



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def profile_accent_color_id
  @profile_accent_color_id
end

#profile_background_custom_emoji_id ⇒ Integer

Identifier of a custom emoji to be shown on the background of the chat’s profile; 0 if none.

Returns:

  • (Integer) —

    the current value of profile_background_custom_emoji_id



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def profile_background_custom_emoji_id
  @profile_background_custom_emoji_id
end

#reply_markup_message_id ⇒ Integer

Identifier of the message from which reply markup needs to be used; 0 if there is no default custom reply markup in the chat.

Returns:

  • (Integer) —

    the current value of reply_markup_message_id



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def reply_markup_message_id
  @reply_markup_message_id
end

#theme_name ⇒ TD::Types::String

If non-empty, name of a theme, set for the chat.

Returns:

  • (TD::Types::String) —

    the current value of theme_name



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def theme_name
  @theme_name
end

#title ⇒ TD::Types::String

Chat title.

Returns:

  • (TD::Types::String) —

    the current value of title



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def title
  @title
end

#type ⇒ TD::Types::ChatType

Type of the chat.

Returns:



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def type
  @type
end

#unread_count ⇒ Integer

Number of unread messages in the chat.

Returns:

  • (Integer) —

    the current value of unread_count



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def unread_count
  @unread_count
end

#unread_mention_count ⇒ Integer

Number of unread messages with a mention/reply in the chat.

Returns:

  • (Integer) —

    the current value of unread_mention_count



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def unread_mention_count
  @unread_mention_count
end

#unread_reaction_count ⇒ Integer

Number of messages with unread reactions in the chat.

Returns:

  • (Integer) —

    the current value of unread_reaction_count



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def unread_reaction_count
  @unread_reaction_count
end

#video_chat ⇒ TD::Types::VideoChat

Information about video chat of the chat.

Returns:



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def video_chat
  @video_chat
end

#view_as_topics ⇒ Boolean

True, if the chat is a forum supergroup that must be shown in the “View as topics” mode, or Saved Messages chat that must be shown in the “View as chats”.

Returns:

  • (Boolean) —

    the current value of view_as_topics



66
67
68
 
# File 'lib/tdlib/types/chat.rb', line 66

def view_as_topics
  @view_as_topics
end