Class: TD::Types::ChatFolder

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

Overview

Represents a folder for user chats.

Instance Attribute Summary collapse

Method Summary

Methods inherited from Base

#to_hash, #to_json

Instance Attribute Details

#color_id ⇒ Integer

The identifier of the chosen color for the chat folder icon; from -1 to 6. If -1, then color is disabled. Can’t be changed if folder tags are disabled or the current user doesn’t have Telegram Premium subscription.

Returns:

  • (Integer) —

    the current value of color_id



28
29
30
 
# File 'lib/tdlib/types/chat_folder.rb', line 28

def color_id
  @color_id
end

#exclude_archived ⇒ Boolean

True, if archived chats need to be excluded.

Returns:

  • (Boolean) —

    the current value of exclude_archived



28
29
30
 
# File 'lib/tdlib/types/chat_folder.rb', line 28

def exclude_archived
  @exclude_archived
end

#exclude_muted ⇒ Boolean

True, if muted chats need to be excluded.

Returns:

  • (Boolean) —

    the current value of exclude_muted



28
29
30
 
# File 'lib/tdlib/types/chat_folder.rb', line 28

def exclude_muted
  @exclude_muted
end

#exclude_read ⇒ Boolean

True, if read chats need to be excluded.

Returns:

  • (Boolean) —

    the current value of exclude_read



28
29
30
 
# File 'lib/tdlib/types/chat_folder.rb', line 28

def exclude_read
  @exclude_read
end

#excluded_chat_ids ⇒ Array<Integer>

The chat identifiers of always excluded chats in the folder. There can be up to getOption(“chat_folder_chosen_chat_count_max”) always excluded non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium.

Returns:

  • (Array<Integer>) —

    the current value of excluded_chat_ids



28
29
30
 
# File 'lib/tdlib/types/chat_folder.rb', line 28

def excluded_chat_ids
  @excluded_chat_ids
end

#icon ⇒ TD::Types::ChatFolderIcon?

The chosen icon for the chat folder; may be null. If null, use getChatFolderDefaultIconName to get default icon name for the folder.

Returns:



28
29
30
 
# File 'lib/tdlib/types/chat_folder.rb', line 28

def icon
  @icon
end

#include_bots ⇒ Boolean

True, if bots need to be included.

Returns:

  • (Boolean) —

    the current value of include_bots



28
29
30
 
# File 'lib/tdlib/types/chat_folder.rb', line 28

def include_bots
  @include_bots
end

#include_channels ⇒ Boolean

True, if channels need to be included.

Returns:

  • (Boolean) —

    the current value of include_channels



28
29
30
 
# File 'lib/tdlib/types/chat_folder.rb', line 28

def include_channels
  @include_channels
end

#include_contacts ⇒ Boolean

True, if contacts need to be included.

Returns:

  • (Boolean) —

    the current value of include_contacts



28
29
30
 
# File 'lib/tdlib/types/chat_folder.rb', line 28

def include_contacts
  @include_contacts
end

#include_groups ⇒ Boolean

True, if basic groups and supergroups need to be included.

Returns:

  • (Boolean) —

    the current value of include_groups



28
29
30
 
# File 'lib/tdlib/types/chat_folder.rb', line 28

def include_groups
  @include_groups
end

#include_non_contacts ⇒ Boolean

True, if non-contact users need to be included.

Returns:

  • (Boolean) —

    the current value of include_non_contacts



28
29
30
 
# File 'lib/tdlib/types/chat_folder.rb', line 28

def include_non_contacts
  @include_non_contacts
end

#included_chat_ids ⇒ Array<Integer>

The chat identifiers of always included chats in the folder. There can be up to getOption(“chat_folder_chosen_chat_count_max”) pinned and always included non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium.

Returns:

  • (Array<Integer>) —

    the current value of included_chat_ids



28
29
30
 
# File 'lib/tdlib/types/chat_folder.rb', line 28

def included_chat_ids
  @included_chat_ids
end

#is_shareable ⇒ Boolean

True, if at least one link has been created for the folder.

Returns:

  • (Boolean) —

    the current value of is_shareable



28
29
30
 
# File 'lib/tdlib/types/chat_folder.rb', line 28

def is_shareable
  @is_shareable
end

#pinned_chat_ids ⇒ Array<Integer>

The chat identifiers of pinned chats in the folder. There can be up to getOption(“chat_folder_chosen_chat_count_max”) pinned and always included non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium.

Returns:

  • (Array<Integer>) —

    the current value of pinned_chat_ids



28
29
30
 
# File 'lib/tdlib/types/chat_folder.rb', line 28

def pinned_chat_ids
  @pinned_chat_ids
end

#title ⇒ TD::Types::String

The title of the folder; 1-12 characters without line feeds.

Returns:

  • (TD::Types::String) —

    the current value of title



28
29
30
 
# File 'lib/tdlib/types/chat_folder.rb', line 28

def title
  @title
end