Class: Line::Bot::V2::Liff::LiffView

Inherits:
Object
  • Object
show all
Defined in:
lib/line/bot/v2/liff/model/liff_view.rb

Overview

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type:, url:, module_mode: nil, **dynamic_attributes) ⇒ LiffView

Returns a new instance of LiffView.

Parameters:

  • type (String) —

    (‘compact’|‘tall’|‘full’) Size of the LIFF app view. Specify one of these values: - compact - tall - full

  • url (String) —

    Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can’t be specified.

  • module_mode (Boolean, nil) (defaults to: nil) —

    ‘true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/line/bot/v2/liff/model/liff_view.rb', line 29

def initialize(
  type:,
  url:,
  module_mode: nil,
  **dynamic_attributes
)
  
  @type = type
  @url = url
  @module_mode = module_mode

  dynamic_attributes.each do |key, value|
    self.class.attr_accessor key

    if value.is_a?(Hash)
      struct_klass = Struct.new(*value.keys.map(&:to_sym))
      struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
      instance_variable_set("@#{key}", struct_klass.new(*struct_values))
    else
      instance_variable_set("@#{key}", value)
    end
  end
end

Instance Attribute Details

#module_mode ⇒ Boolean?

Returns ‘true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed.

Returns:

  • (Boolean, nil) —

    ‘true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed.



24
25
26
 
# File 'lib/line/bot/v2/liff/model/liff_view.rb', line 24

def module_mode
  @module_mode
end

#type ⇒ String

Returns (‘compact’|‘tall’|‘full’) Size of the LIFF app view. Specify one of these values: - compact - tall - full.

Returns:

  • (String) —

    (‘compact’|‘tall’|‘full’) Size of the LIFF app view. Specify one of these values: - compact - tall - full



18
19
20
 
# File 'lib/line/bot/v2/liff/model/liff_view.rb', line 18

def type
  @type
end

#url ⇒ String

Returns Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can’t be specified.

Returns:

  • (String) —

    Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can’t be specified.



21
22
23
 
# File 'lib/line/bot/v2/liff/model/liff_view.rb', line 21

def url
  @url
end

Class Method Details

.create(args) ⇒ Line::Bot::V2::Liff::LiffView

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



56
57
58
59
 
# File 'lib/line/bot/v2/liff/model/liff_view.rb', line 56

def self.create(args) # steep:ignore
  symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
  return new(**symbolized_args) # steep:ignore
end

Instance Method Details

#==(other) ⇒ Boolean

Returns true if the objects are equal, false otherwise.

Parameters:

  • other (Object) —

    Object to compare

Returns:

  • (Boolean) —

    true if the objects are equal, false otherwise



63
64
65
66
67
68
69
 
# File 'lib/line/bot/v2/liff/model/liff_view.rb', line 63

def ==(other)
  return false unless self.class == other.class

  instance_variables.all? do |var|
      instance_variable_get(var) == other.instance_variable_get(var)
  end
end

#hash ⇒ Integer

Returns Hash code of the object.

Returns:

  • (Integer) —

    Hash code of the object



72
73
74
 
# File 'lib/line/bot/v2/liff/model/liff_view.rb', line 72

def hash
  [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
end