Class: TD::Types::Background

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

Overview

Describes a chat background.

Instance Attribute Summary collapse

Method Summary

Methods inherited from Base

#to_hash, #to_json

Instance Attribute Details

#document ⇒ TD::Types::Document?

Document with the background; may be null. Null only for filled backgrounds.

Returns:



11
12
13
 
# File 'lib/tdlib/types/background.rb', line 11

def document
  @document
end

#id ⇒ Integer

Unique background identifier.

Returns:

  • (Integer) —

    the current value of id



11
12
13
 
# File 'lib/tdlib/types/background.rb', line 11

def id
  @id
end

#is_dark ⇒ Boolean

True, if the background is dark and is recommended to be used with dark theme.

Returns:

  • (Boolean) —

    the current value of is_dark



11
12
13
 
# File 'lib/tdlib/types/background.rb', line 11

def is_dark
  @is_dark
end

#is_default ⇒ Boolean

True, if this is one of default backgrounds.

Returns:

  • (Boolean) —

    the current value of is_default



11
12
13
 
# File 'lib/tdlib/types/background.rb', line 11

def is_default
  @is_default
end

#name ⇒ TD::Types::String

Unique background name.

Returns:

  • (TD::Types::String) —

    the current value of name



11
12
13
 
# File 'lib/tdlib/types/background.rb', line 11

def name
  @name
end

#type ⇒ TD::Types::BackgroundType

Type of the background.

Returns:



11
12
13
 
# File 'lib/tdlib/types/background.rb', line 11

def type
  @type
end