Class: Line::Bot::V2::MessagingApi::ButtonsTemplate

Inherits:
Template
  • Object
show all
Defined in:
lib/line/bot/v2/messaging_api/model/buttons_template.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(thumbnail_image_url: nil, image_aspect_ratio: nil, image_size: nil, image_background_color: nil, title: nil, text:, default_action: nil, actions:, **dynamic_attributes) ⇒ ButtonsTemplate

Returns a new instance of ButtonsTemplate.

Parameters:

  • thumbnail_image_url (String, nil) (defaults to: nil)
  • image_aspect_ratio (String, nil) (defaults to: nil)
  • image_size (String, nil) (defaults to: nil)
  • image_background_color (String, nil) (defaults to: nil)
  • title (String, nil) (defaults to: nil)
  • text (String)
  • default_action (Action, Hash[Symbol, untyped], nil) (defaults to: nil)
  • actions (Array[Action, Hash[Symbol, untyped]]) 


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/line/bot/v2/messaging_api/model/buttons_template.rb', line 53

def initialize(
  thumbnail_image_url: nil,
  image_aspect_ratio: nil,
  image_size: nil,
  image_background_color: nil,
  title: nil,
  text:,
  default_action: nil,
  actions:,
  **dynamic_attributes
)
  @type = "buttons"
  
  @thumbnail_image_url = thumbnail_image_url
  @image_aspect_ratio = image_aspect_ratio
  @image_size = image_size
  @image_background_color = image_background_color
  @title = title
  @text = text
  @default_action = default_action.is_a?(Line::Bot::V2::MessagingApi::Action) || default_action.nil? ? default_action : Line::Bot::V2::MessagingApi::Action.create(**default_action) # steep:ignore
  @actions = actions.map do |item|
    if item.is_a?(Hash)
      Line::Bot::V2::MessagingApi::Action.create(**item) # steep:ignore InsufficientKeywordArguments
    else
      item
    end
  end

  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

#actions ⇒ Array[Action]

Returns:



43
44
45
 
# File 'lib/line/bot/v2/messaging_api/model/buttons_template.rb', line 43

def actions
  @actions
end

#default_action ⇒ Action?

Returns:



40
41
42
 
# File 'lib/line/bot/v2/messaging_api/model/buttons_template.rb', line 40

def default_action
  @default_action
end

#image_aspect_ratio ⇒ String?

Returns:

  • (String, nil) 


25
26
27
 
# File 'lib/line/bot/v2/messaging_api/model/buttons_template.rb', line 25

def image_aspect_ratio
  @image_aspect_ratio
end

#image_background_color ⇒ String?

Returns:

  • (String, nil) 


31
32
33
 
# File 'lib/line/bot/v2/messaging_api/model/buttons_template.rb', line 31

def image_background_color
  @image_background_color
end

#image_size ⇒ String?

Returns:

  • (String, nil) 


28
29
30
 
# File 'lib/line/bot/v2/messaging_api/model/buttons_template.rb', line 28

def image_size
  @image_size
end

#text ⇒ String

Returns:

  • (String) 


37
38
39
 
# File 'lib/line/bot/v2/messaging_api/model/buttons_template.rb', line 37

def text
  @text
end

#thumbnail_image_url ⇒ String?

Returns:

  • (String, nil) 


22
23
24
 
# File 'lib/line/bot/v2/messaging_api/model/buttons_template.rb', line 22

def thumbnail_image_url
  @thumbnail_image_url
end

#title ⇒ String?

Returns:

  • (String, nil) 


34
35
36
 
# File 'lib/line/bot/v2/messaging_api/model/buttons_template.rb', line 34

def title
  @title
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



19
20
21
 
# File 'lib/line/bot/v2/messaging_api/model/buttons_template.rb', line 19

def type
  @type
end

Class Method Details

.create(args) ⇒ Line::Bot::V2::MessagingApi::ButtonsTemplate

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



97
98
99
100
 
# File 'lib/line/bot/v2/messaging_api/model/buttons_template.rb', line 97

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



104
105
106
107
108
109
110
 
# File 'lib/line/bot/v2/messaging_api/model/buttons_template.rb', line 104

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



113
114
115
 
# File 'lib/line/bot/v2/messaging_api/model/buttons_template.rb', line 113

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