Class: Line::Bot::V2::MessagingApi::PushMessageRequest

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

Overview

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(to:, messages:, notification_disabled: false, custom_aggregation_units: nil, **dynamic_attributes) ⇒ PushMessageRequest

Returns a new instance of PushMessageRequest.

Parameters:

  • to (String) —

    ID of the receiver.

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

    List of Message objects.

  • 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.

  • custom_aggregation_units (Array[String], nil) (defaults to: nil) —

    List of aggregation unit name. Case-sensitive. This functions can only be used by corporate users who have submitted the required applications.



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
58
59
60
61
62
63
 
# File 'lib/line/bot/v2/messaging_api/model/push_message_request.rb', line 33

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

  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

#custom_aggregation_units ⇒ Array[String]?

Returns List of aggregation unit name. Case-sensitive. This functions can only be used by corporate users who have submitted the required applications.

Returns:

  • (Array[String], nil) —

    List of aggregation unit name. Case-sensitive. This functions can only be used by corporate users who have submitted the required applications.



27
28
29
 
# File 'lib/line/bot/v2/messaging_api/model/push_message_request.rb', line 27

def custom_aggregation_units
  @custom_aggregation_units
end

#messages ⇒ Array[Message]

Returns List of Message objects.

Returns:

  • (Array[Message]) —

    List of Message objects.



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

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/push_message_request.rb', line 24

def notification_disabled
  @notification_disabled
end

#to ⇒ String

Returns ID of the receiver.

Returns:

  • (String) —

    ID of the receiver.



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

def to
  @to
end

Class Method Details

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

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



68
69
70
71
 
# File 'lib/line/bot/v2/messaging_api/model/push_message_request.rb', line 68

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



75
76
77
78
79
80
81
 
# File 'lib/line/bot/v2/messaging_api/model/push_message_request.rb', line 75

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



84
85
86
 
# File 'lib/line/bot/v2/messaging_api/model/push_message_request.rb', line 84

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