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

#action_bar ⇒ TD::Types::ChatActionBar?

Describes actions which should be possible to do through a chat action bar; may be null.

Returns:



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def action_bar
  @action_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



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

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



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

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.

Returns:

  • (Boolean) —

    the current value of can_be_reported



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def can_be_reported
  @can_be_reported
end

#chat_list ⇒ TD::Types::ChatList?

A chat list to which the chat belongs; may be null.

Returns:



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def chat_list
  @chat_list
end

#client_data ⇒ String

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

Returns:

  • (String) —

    the current value of client_data



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

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



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def default_disable_notification
  @default_disable_notification
end

#draft_message ⇒ TD::Types::DraftMessage?

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

Returns:



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def draft_message
  @draft_message
end

#has_scheduled_messages ⇒ Boolean

True, if the chat has scheduled messages.

Returns:

  • (Boolean) —

    the current value of has_scheduled_messages



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def has_scheduled_messages
  @has_scheduled_messages
end

#id ⇒ Integer

Chat unique identifier.

Returns:

  • (Integer) —

    the current value of id



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

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



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def is_marked_as_unread
  @is_marked_as_unread
end

#is_pinned ⇒ Boolean

True, if the chat is pinned.

Returns:

  • (Boolean) —

    the current value of is_pinned



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def is_pinned
  @is_pinned
end

#is_sponsored ⇒ Boolean

True, if the chat is sponsored by the user's MTProxy server.

Returns:

  • (Boolean) —

    the current value of is_sponsored



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def is_sponsored
  @is_sponsored
end

#last_message ⇒ TD::Types::Message?

Last message in the chat; may be null.

Returns:



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

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



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

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



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def last_read_outbox_message_id
  @last_read_outbox_message_id
end

#notification_settings ⇒ TD::Types::ChatNotificationSettings

Notification settings for this chat.

Returns:



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def notification_settings
  @notification_settings
end

#order ⇒ Integer

Descending parameter by which chats are sorted in the main chat list. If the order number of two chats is the same, they must be sorted in descending order by ID. If 0, the position of the chat in the list is undetermined.

Returns:

  • (Integer) —

    the current value of order



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def order
  @order
end

#permissions ⇒ TD::Types::ChatPermissions

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

Returns:



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def permissions
  @permissions
end

#photo ⇒ TD::Types::ChatPhoto?

Chat photo; may be null.

Returns:



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def photo
  @photo
end

#pinned_message_id ⇒ Integer

Identifier of the pinned message in the chat; 0 if none.

Returns:

  • (Integer) —

    the current value of pinned_message_id



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def pinned_message_id
  @pinned_message_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



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def reply_markup_message_id
  @reply_markup_message_id
end

#title ⇒ String

Chat title.

Returns:

  • (String) —

    the current value of title



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def title
  @title
end

#type ⇒ TD::Types::ChatType

Type of the chat.

Returns:



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def type
  @type
end

#unread_count ⇒ Integer

Number of unread messages in the chat.

Returns:

  • (Integer) —

    the current value of unread_count



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

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



40
41
42
 
# File 'lib/tdlib/types/chat.rb', line 40

def unread_mention_count
  @unread_mention_count
end