Class: Line::Bot::V2::MessagingApi::TextMessageV2

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

Overview

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(quick_reply: nil, sender: nil, text:, substitution: nil, quote_token: nil, **dynamic_attributes) ⇒ TextMessageV2

Returns a new instance of TextMessageV2.

Parameters:

  • quick_reply (QuickReply, Hash[Symbol, untyped], nil) (defaults to: nil)
  • sender (Sender, Hash[Symbol, untyped], nil) (defaults to: nil)
  • text (String)
  • substitution (Object, nil) (defaults to: nil) —

    A mapping that specifies substitutions for parts enclosed in {} within the ‘text` field.

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

    Quote token of the message you want to quote.



42
43
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
 
# File 'lib/line/bot/v2/messaging_api/model/text_message_v2.rb', line 42

def initialize(
  quick_reply: nil,
  sender: nil,
  text:,
  substitution: nil,
  quote_token: nil,
  **dynamic_attributes
)
  @type = "textV2"
  
  @quick_reply = quick_reply.is_a?(Line::Bot::V2::MessagingApi::QuickReply) || quick_reply.nil? ? quick_reply : Line::Bot::V2::MessagingApi::QuickReply.create(**quick_reply) # steep:ignore
  @sender = sender.is_a?(Line::Bot::V2::MessagingApi::Sender) || sender.nil? ? sender : Line::Bot::V2::MessagingApi::Sender.create(**sender) # steep:ignore
  @text = text
  @substitution = substitution
  @quote_token = quote_token

  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

#quick_reply ⇒ QuickReply?

Returns:



23
24
25
 
# File 'lib/line/bot/v2/messaging_api/model/text_message_v2.rb', line 23

def quick_reply
  @quick_reply
end

#quote_token ⇒ String?

Returns Quote token of the message you want to quote.

Returns:

  • (String, nil) —

    Quote token of the message you want to quote.



35
36
37
 
# File 'lib/line/bot/v2/messaging_api/model/text_message_v2.rb', line 35

def quote_token
  @quote_token
end

#sender ⇒ Sender?

Returns:



26
27
28
 
# File 'lib/line/bot/v2/messaging_api/model/text_message_v2.rb', line 26

def sender
  @sender
end

#substitution ⇒ Object?

Returns A mapping that specifies substitutions for parts enclosed in {} within the ‘text` field.

Returns:

  • (Object, nil) —

    A mapping that specifies substitutions for parts enclosed in {} within the ‘text` field.



32
33
34
 
# File 'lib/line/bot/v2/messaging_api/model/text_message_v2.rb', line 32

def substitution
  @substitution
end

#text ⇒ String

Returns:

  • (String) 


29
30
31
 
# File 'lib/line/bot/v2/messaging_api/model/text_message_v2.rb', line 29

def text
  @text
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



20
21
22
 
# File 'lib/line/bot/v2/messaging_api/model/text_message_v2.rb', line 20

def type
  @type
end

Class Method Details

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

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



74
75
76
77
 
# File 'lib/line/bot/v2/messaging_api/model/text_message_v2.rb', line 74

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



81
82
83
84
85
86
87
 
# File 'lib/line/bot/v2/messaging_api/model/text_message_v2.rb', line 81

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



90
91
92
 
# File 'lib/line/bot/v2/messaging_api/model/text_message_v2.rb', line 90

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