Class: Line::Bot::V2::Webhook::ImageSet

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, index: nil, total: nil, **dynamic_attributes) ⇒ ImageSet

Returns a new instance of ImageSet.

Parameters:

  • id (String) —

    Image set ID. Only included when multiple images are sent simultaneously.

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

    An index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won’t be included if the sender is using LINE 11.15 or earlier for Android.

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

    The total number of images sent simultaneously.



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

def initialize(
  id:,
  index: nil,
  total: nil,
  **dynamic_attributes
)
  
  @id = id
  @index = index
  @total = total

  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

#id ⇒ String

Returns Image set ID. Only included when multiple images are sent simultaneously.

Returns:

  • (String) —

    Image set ID. Only included when multiple images are sent simultaneously.



17
18
19
 
# File 'lib/line/bot/v2/webhook/model/image_set.rb', line 17

def id
  @id
end

#index ⇒ Integer?

Returns An index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won’t be included if the sender is using LINE 11.15 or earlier for Android.

Returns:

  • (Integer, nil) —

    An index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won’t be included if the sender is using LINE 11.15 or earlier for Android.



20
21
22
 
# File 'lib/line/bot/v2/webhook/model/image_set.rb', line 20

def index
  @index
end

#total ⇒ Integer?

Returns The total number of images sent simultaneously.

Returns:

  • (Integer, nil) —

    The total number of images sent simultaneously.



23
24
25
 
# File 'lib/line/bot/v2/webhook/model/image_set.rb', line 23

def total
  @total
end

Class Method Details

.create(args) ⇒ Line::Bot::V2::Webhook::ImageSet

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



55
56
57
58
 
# File 'lib/line/bot/v2/webhook/model/image_set.rb', line 55

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



62
63
64
65
66
67
68
 
# File 'lib/line/bot/v2/webhook/model/image_set.rb', line 62

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



71
72
73
 
# File 'lib/line/bot/v2/webhook/model/image_set.rb', line 71

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