Class: Line::Bot::V2::MessagingApi::BroadcastRequest

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

Overview

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of BroadcastRequest.

Parameters:

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



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/line/bot/v2/messaging_api/model/broadcast_request.rb', line 25

def initialize(
  messages:,
  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
  @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 List of Message objects.

Returns:

  • (Array[Message]) —

    List of Message objects.



18
19
20
 
# File 'lib/line/bot/v2/messaging_api/model/broadcast_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.



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

def notification_disabled
  @notification_disabled
end

Class Method Details

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

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



56
57
58
59
 
# File 'lib/line/bot/v2/messaging_api/model/broadcast_request.rb', line 56

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



63
64
65
66
67
68
69
 
# File 'lib/line/bot/v2/messaging_api/model/broadcast_request.rb', line 63

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



72
73
74
 
# File 'lib/line/bot/v2/messaging_api/model/broadcast_request.rb', line 72

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