Class: Line::Bot::V2::MessagingApi::Limit

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

Overview

Limit of the Narrowcast

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(max: nil, up_to_remaining_quota: false, forbid_partial_delivery: false, **dynamic_attributes) ⇒ Limit

Returns a new instance of Limit.

Parameters:

  • max (Integer, nil) (defaults to: nil) —

    The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random.

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

    If true, the message will be sent within the maximum number of deliverable messages. The default value is ‘false`. Targets will be selected at random.

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

    This option prevents messages from being delivered to only a subset of the target audience. If true, the narrowcast request success but fails asynchronously. You can check whether message delivery was canceled by retrieving the narrowcast message progress. This property can be set to true only if upToRemainingQuota is set to true.



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

def initialize(
  max: nil,
  up_to_remaining_quota: false,
  forbid_partial_delivery: false,
  **dynamic_attributes
)
  
  @max = max
  @up_to_remaining_quota = up_to_remaining_quota
  @forbid_partial_delivery = forbid_partial_delivery

  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

#forbid_partial_delivery ⇒ Boolean?

Returns This option prevents messages from being delivered to only a subset of the target audience. If true, the narrowcast request success but fails asynchronously. You can check whether message delivery was canceled by retrieving the narrowcast message progress. This property can be set to true only if upToRemainingQuota is set to true.

Returns:

  • (Boolean, nil) —

    This option prevents messages from being delivered to only a subset of the target audience. If true, the narrowcast request success but fails asynchronously. You can check whether message delivery was canceled by retrieving the narrowcast message progress. This property can be set to true only if upToRemainingQuota is set to true.



25
26
27
 
# File 'lib/line/bot/v2/messaging_api/model/limit.rb', line 25

def forbid_partial_delivery
  @forbid_partial_delivery
end

#max ⇒ Integer?

Returns The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random.

Returns:

  • (Integer, nil) —

    The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random.



19
20
21
 
# File 'lib/line/bot/v2/messaging_api/model/limit.rb', line 19

def max
  @max
end

#up_to_remaining_quota ⇒ Boolean?

Returns If true, the message will be sent within the maximum number of deliverable messages. The default value is ‘false`. Targets will be selected at random.

Returns:

  • (Boolean, nil) —

    If true, the message will be sent within the maximum number of deliverable messages. The default value is ‘false`. Targets will be selected at random.



22
23
24
 
# File 'lib/line/bot/v2/messaging_api/model/limit.rb', line 22

def up_to_remaining_quota
  @up_to_remaining_quota
end

Class Method Details

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

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



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

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



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

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



73
74
75
 
# File 'lib/line/bot/v2/messaging_api/model/limit.rb', line 73

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