Class: Line::Bot::V2::MessagingApi::PostbackAction

Inherits:
Action
  • Object
show all
Defined in:
lib/line/bot/v2/messaging_api/model/postback_action.rb,
sig/line/bot/v2/messaging_api/model/postback_action.rbs

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Action

detect_class

Constructor Details

#initialize(label: nil, data: nil, display_text: nil, text: nil, input_option: nil, fill_in_text: nil, **dynamic_attributes) ⇒ Object

Parameters:

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

    Label for the action.

  • data (String, nil) (defaults to: nil)
  • display_text (String, nil) (defaults to: nil)
  • text (String, nil) (defaults to: nil)
  • input_option (String, nil) (defaults to: nil) —

    ('closeRichMenu'|'openRichMenu'|'openKeyboard'|'openVoice')

  • fill_in_text (String, nil) (defaults to: nil) 


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/messaging_api/model/postback_action.rb', line 45

def initialize(
  label: nil,
  data: nil,
  display_text: nil,
  text: nil,
  input_option: nil,
  fill_in_text: nil,
  **dynamic_attributes
)
  @type = "postback"
  
  @label = label
  @data = data
  @display_text = display_text
  @text = text
  @input_option = input_option
  @fill_in_text = fill_in_text

  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

#data ⇒ String?

Returns:

  • (String, nil) 


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

def data
  @data
end

#display_text ⇒ String?

Returns:

  • (String, nil) 


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

def display_text
  @display_text
end

#fill_in_text ⇒ String?

Returns:

  • (String, nil) 


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

def fill_in_text
  @fill_in_text
end

#input_option ⇒ String?

Returns ('closeRichMenu'|'openRichMenu'|'openKeyboard'|'openVoice').

Returns:

  • (String, nil) —

    ('closeRichMenu'|'openRichMenu'|'openKeyboard'|'openVoice')



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

def input_option
  @input_option
end

#label ⇒ String?

Returns Label for the action.

Returns:

  • (String, nil) —

    Label for the action.



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

def label
  @label
end

#text ⇒ String?

Returns:

  • (String, nil) 


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

def text
  @text
end

#type ⇒ String? (readonly)

Returns the value of attribute type.

Returns:

  • (String, nil) 


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

def type
  @type
end

Class Method Details

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

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

  • (Hash[Symbol, untyped])

Returns:



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

def self.create(args)
  symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
  return new(**symbolized_args)
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/messaging_api/model/postback_action.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/messaging_api/model/postback_action.rb', line 95

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