Class: AsposePdfCloud::HighlightAnnotationsResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_pdf_cloud/models/highlight_annotations_response.rb

Overview

Represents response containing multiple highlight annotation objects

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HighlightAnnotationsResponse

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/aspose_pdf_cloud/models/highlight_annotations_response.rb', line 58

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'Code')
    self.code = attributes[:'Code']
  end

  if attributes.has_key?(:'Status')
    self.status = attributes[:'Status']
  end

  if attributes.has_key?(:'Annotations')
    self.annotations = attributes[:'Annotations']
  end

end

Instance Attribute Details

#annotations ⇒ Object

Highlight annotations object



35
36
37
 
# File 'lib/aspose_pdf_cloud/models/highlight_annotations_response.rb', line 35

def annotations
  @annotations
end

#code ⇒ Object

Response status code.



29
30
31
 
# File 'lib/aspose_pdf_cloud/models/highlight_annotations_response.rb', line 29

def code
  @code
end

#status ⇒ Object

Response status.



32
33
34
 
# File 'lib/aspose_pdf_cloud/models/highlight_annotations_response.rb', line 32

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



39
40
41
42
43
44
45
 
# File 'lib/aspose_pdf_cloud/models/highlight_annotations_response.rb', line 39

def self.attribute_map
  {
    :'code' => :'Code',
    :'status' => :'Status',
    :'annotations' => :'Annotations'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
 
# File 'lib/aspose_pdf_cloud/models/highlight_annotations_response.rb', line 48

def self.swagger_types
  {
    :'code' => :'Integer',
    :'status' => :'String',
    :'annotations' => :'HighlightAnnotations'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



98
99
100
101
102
103
104
 
# File 'lib/aspose_pdf_cloud/models/highlight_annotations_response.rb', line 98

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      code == o.code &&
      status == o.status &&
      annotations == o.annotations
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/aspose_pdf_cloud/models/highlight_annotations_response.rb', line 142

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = AsposePdfCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/aspose_pdf_cloud/models/highlight_annotations_response.rb', line 208

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/aspose_pdf_cloud/models/highlight_annotations_response.rb', line 121

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


108
109
110
 
# File 'lib/aspose_pdf_cloud/models/highlight_annotations_response.rb', line 108

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



114
115
116
 
# File 'lib/aspose_pdf_cloud/models/highlight_annotations_response.rb', line 114

def hash
  [code, status, annotations].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



80
81
82
83
84
85
86
87
 
# File 'lib/aspose_pdf_cloud/models/highlight_annotations_response.rb', line 80

def list_invalid_properties
  invalid_properties = Array.new
  if @code.nil?
    invalid_properties.push("invalid value for 'code', code cannot be nil.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



188
189
190
 
# File 'lib/aspose_pdf_cloud/models/highlight_annotations_response.rb', line 188

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



194
195
196
197
198
199
200
201
202
 
# File 'lib/aspose_pdf_cloud/models/highlight_annotations_response.rb', line 194

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



182
183
184
 
# File 'lib/aspose_pdf_cloud/models/highlight_annotations_response.rb', line 182

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



91
92
93
94
 
# File 'lib/aspose_pdf_cloud/models/highlight_annotations_response.rb', line 91

def valid?
  return false if @code.nil?
  return true
end