Class: GroupDocsAnnotationCloud::AnnotateOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_annotation_cloud/models/annotate_options.rb

Overview

Defines options for annotating documents

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnnotateOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 83

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.key?(:'FileInfo')
    self.file_info = attributes[:'FileInfo']
  end

  if attributes.key?(:'Annotations')
    if (value = attributes[:'Annotations']).is_a?(Array)
      self.annotations = value
    end
  end

  if attributes.key?(:'FirstPage')
    self.first_page = attributes[:'FirstPage']
  end

  if attributes.key?(:'LastPage')
    self.last_page = attributes[:'LastPage']
  end

  if attributes.key?(:'OnlyAnnotatedPages')
    self.only_annotated_pages = attributes[:'OnlyAnnotatedPages']
  end

  if attributes.key?(:'OutputPath')
    self.output_path = attributes[:'OutputPath']
  end

  if attributes.key?(:'FontsPath')
    self.fonts_path = attributes[:'FontsPath']
  end

end

Instance Attribute Details

#annotations ⇒ Object

List of annotations to add to the document



38
39
40
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 38

def annotations
  @annotations
end

#file_info ⇒ Object

Input document description



35
36
37
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 35

def file_info
  @file_info
end

#first_page ⇒ Object

First page number when saving page range



41
42
43
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 41

def first_page
  @first_page
end

#fonts_path ⇒ Object

The path to directory containing custom fonts in storage



53
54
55
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 53

def fonts_path
  @fonts_path
end

#last_page ⇒ Object

Last page number when saving page range



44
45
46
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 44

def last_page
  @last_page
end

#only_annotated_pages ⇒ Object

Indicates whether to save only annotated pages



47
48
49
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 47

def only_annotated_pages
  @only_annotated_pages
end

#output_path ⇒ Object

Path to output document in the cloud storage. Required for Add method. Not required if Annotate (with file result) method used.



50
51
52
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 50

def output_path
  @output_path
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 56

def self.attribute_map
  {
    :'file_info' => :'FileInfo',
    :'annotations' => :'Annotations',
    :'first_page' => :'FirstPage',
    :'last_page' => :'LastPage',
    :'only_annotated_pages' => :'OnlyAnnotatedPages',
    :'output_path' => :'OutputPath',
    :'fonts_path' => :'FontsPath'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 69

def self.swagger_types
  {
    :'file_info' => :'FileInfo',
    :'annotations' => :'Array<AnnotationInfo>',
    :'first_page' => :'Integer',
    :'last_page' => :'Integer',
    :'only_annotated_pages' => :'BOOLEAN',
    :'output_path' => :'String',
    :'fonts_path' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 151

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      file_info == other.file_info &&
      annotations == other.annotations &&
      first_page == other.first_page &&
      last_page == other.last_page &&
      only_annotated_pages == other.only_annotated_pages &&
      output_path == other.output_path &&
      fonts_path == other.fonts_path
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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 208

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.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 = GroupDocsAnnotationCloud.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



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 275

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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 184

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    pname = uncap(self.class.attribute_map[key]).intern
    value = attributes[pname]
    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 value.is_a?(Array)
        self.send("#{key}=", value.map { |v| _deserialize($1, v) })
      end
    elsif !value.nil?
      self.send("#{key}=", _deserialize(type, value))
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


165
166
167
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 165

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



171
172
173
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 171

def hash
  [file_info, annotations, first_page, last_page, only_annotated_pages, output_path, fonts_path].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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 123

def list_invalid_properties
  invalid_properties = []
  if @first_page.nil?
    invalid_properties.push("invalid value for 'first_page', first_page cannot be nil.")
  end

  if @last_page.nil?
    invalid_properties.push("invalid value for 'last_page', last_page cannot be nil.")
  end

  if @only_annotated_pages.nil?
    invalid_properties.push("invalid value for 'only_annotated_pages', only_annotated_pages 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



255
256
257
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 255

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



261
262
263
264
265
266
267
268
269
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 261

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



249
250
251
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 249

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



177
178
179
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 177

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



142
143
144
145
146
147
 
# File 'lib/groupdocs_annotation_cloud/models/annotate_options.rb', line 142

def valid?
  return false if @first_page.nil?
  return false if @last_page.nil?
  return false if @only_annotated_pages.nil?
  return true
end