Class: Line::Bot::V2::MessagingApi::NarrowcastRequest

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

Overview

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(messages:, recipient: nil, filter: nil, limit: nil, notification_disabled: false, **dynamic_attributes) ⇒ NarrowcastRequest

Returns a new instance of NarrowcastRequest.

Parameters:

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

    List of Message objects.

  • recipient (Recipient, Hash[Symbol, untyped], nil) (defaults to: nil)
  • filter (Filter, Hash[Symbol, untyped], nil) (defaults to: nil)
  • limit (Limit, Hash[Symbol, untyped], nil) (defaults to: nil)
  • 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.



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
64
65
66
67
68
69
 
# File 'lib/line/bot/v2/messaging_api/model/narrowcast_request.rb', line 37

def initialize(
  messages:,
  recipient: nil,
  filter: nil,
  limit: nil,
  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
  @recipient = recipient.is_a?(Line::Bot::V2::MessagingApi::Recipient) || recipient.nil? ? recipient : Line::Bot::V2::MessagingApi::Recipient.create(**recipient) # steep:ignore
  @filter = filter.is_a?(Line::Bot::V2::MessagingApi::Filter) || filter.nil? ? filter : Line::Bot::V2::MessagingApi::Filter.create(**filter) # steep:ignore
  @limit = limit.is_a?(Line::Bot::V2::MessagingApi::Limit) || limit.nil? ? limit : Line::Bot::V2::MessagingApi::Limit.create(**limit) # steep:ignore
  @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

#filter ⇒ Filter?

Returns:



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

def filter
  @filter
end

#limit ⇒ Limit?

Returns:



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

def limit
  @limit
end

#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/narrowcast_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.



30
31
32
 
# File 'lib/line/bot/v2/messaging_api/model/narrowcast_request.rb', line 30

def notification_disabled
  @notification_disabled
end

#recipient ⇒ Recipient?

Returns:



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

def recipient
  @recipient
end

Class Method Details

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

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/narrowcast_request.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/narrowcast_request.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/narrowcast_request.rb', line 90

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