Class: Line::Bot::V2::Liff::LiffApp

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(liff_id: nil, view: nil, description: nil, features: nil, permanent_link_pattern: nil, scope: nil, bot_prompt: nil, **dynamic_attributes) ⇒ LiffApp

Returns a new instance of LiffApp.

Parameters:

  • liff_id (String, nil) (defaults to: nil) —

    LIFF app ID

  • view (LiffView, Hash[Symbol, untyped], nil) (defaults to: nil)
  • description (String, nil) (defaults to: nil) —

    Name of the LIFF app

  • features (LiffFeatures, Hash[Symbol, untyped], nil) (defaults to: nil)
  • permanent_link_pattern (String, nil) (defaults to: nil) —

    How additional information in LIFF URLs is handled. concat is returned.

  • scope (Array['openid','email','profile','chat_message.write'], nil) (defaults to: nil)
  • bot_prompt (String, nil) (defaults to: nil) —

    (‘normal’|‘aggressive’|‘none’)



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/line/bot/v2/liff/model/liff_app.rb', line 44

def initialize(
  liff_id: nil,
  view: nil,
  description: nil,
  features: nil,
  permanent_link_pattern: nil,
  scope: nil,
  bot_prompt: nil,
  **dynamic_attributes
)
  
  @liff_id = liff_id
  @view = view.is_a?(Line::Bot::V2::Liff::LiffView) || view.nil? ? view : Line::Bot::V2::Liff::LiffView.create(**view) # steep:ignore
  @description = description
  @features = features.is_a?(Line::Bot::V2::Liff::LiffFeatures) || features.nil? ? features : Line::Bot::V2::Liff::LiffFeatures.create(**features) # steep:ignore
  @permanent_link_pattern = permanent_link_pattern
  @scope = scope
  @bot_prompt = bot_prompt

  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

#bot_prompt ⇒ String?

Returns (‘normal’|‘aggressive’|‘none’).

Returns:

  • (String, nil) —

    (‘normal’|‘aggressive’|‘none’)



35
36
37
 
# File 'lib/line/bot/v2/liff/model/liff_app.rb', line 35

def bot_prompt
  @bot_prompt
end

#description ⇒ String?

Returns Name of the LIFF app.

Returns:

  • (String, nil) —

    Name of the LIFF app



23
24
25
 
# File 'lib/line/bot/v2/liff/model/liff_app.rb', line 23

def description
  @description
end

#features ⇒ LiffFeatures?

Returns:



26
27
28
 
# File 'lib/line/bot/v2/liff/model/liff_app.rb', line 26

def features
  @features
end

#liff_id ⇒ String?

Returns LIFF app ID.

Returns:

  • (String, nil) —

    LIFF app ID



17
18
19
 
# File 'lib/line/bot/v2/liff/model/liff_app.rb', line 17

def liff_id
  @liff_id
end

#permanent_link_pattern ⇒ String?

Returns How additional information in LIFF URLs is handled. concat is returned.

Returns:

  • (String, nil) —

    How additional information in LIFF URLs is handled. concat is returned.



29
30
31
 
# File 'lib/line/bot/v2/liff/model/liff_app.rb', line 29

def permanent_link_pattern
  @permanent_link_pattern
end

#scope ⇒ Array['openid','email','profile','chat_message.write']

Returns:

  • (Array['openid','email','profile','chat_message.write']) 


32
33
34
 
# File 'lib/line/bot/v2/liff/model/liff_app.rb', line 32

def scope
  @scope
end

#view ⇒ LiffView?

Returns:



20
21
22
 
# File 'lib/line/bot/v2/liff/model/liff_app.rb', line 20

def view
  @view
end

Class Method Details

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

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



79
80
81
82
 
# File 'lib/line/bot/v2/liff/model/liff_app.rb', line 79

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



86
87
88
89
90
91
92
 
# File 'lib/line/bot/v2/liff/model/liff_app.rb', line 86

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



95
96
97
 
# File 'lib/line/bot/v2/liff/model/liff_app.rb', line 95

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