Class: Line::Bot::V2::MessagingApi::PnpMessagesRequest

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

Overview

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(messages:, to:, notification_disabled: false, **dynamic_attributes) ⇒ PnpMessagesRequest

Returns a new instance of PnpMessagesRequest.

Parameters:

  • messages (Array[Message, Hash[Symbol, untyped]]) —

    Message to be sent.

  • to (String) —

    Message destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256.

  • notification_disabled (Boolean, nil) (defaults to: false) —

    ‘true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb', line 29

def initialize(
  messages:,
  to:,
  notification_disabled: false,
  **dynamic_attributes
)
  
  @messages = messages.map do |item|
    if item.is_a?(Hash)
      Line::Bot::V2::MessagingApi::Message.create(**item) # steep:ignore InsufficientKeywordArguments
    else
      item
    end
  end
  @to = to
  @notification_disabled = notification_disabled

  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

#messages ⇒ Array[Message]

Returns Message to be sent.

Returns:

  • (Array[Message]) —

    Message to be sent.



18
19
20
 
# File 'lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb', line 18

def messages
  @messages
end

#notification_disabled ⇒ Boolean?

Returns ‘true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false.

Returns:

  • (Boolean, nil) —

    ‘true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false.



24
25
26
 
# File 'lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb', line 24

def notification_disabled
  @notification_disabled
end

#to ⇒ String

Returns Message destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256.

Returns:

  • (String) —

    Message destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256.



21
22
23
 
# File 'lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb', line 21

def to
  @to
end

Class Method Details

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

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



62
63
64
65
 
# File 'lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb', line 62

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



69
70
71
72
73
74
75
 
# File 'lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb', line 69

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



78
79
80
 
# File 'lib/line/bot/v2/messaging_api/model/pnp_messages_request.rb', line 78

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