Class: GroupDocsConversionCloud::PdfLoadOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_conversion_cloud/models/pdf_load_options.rb

Overview

Pdf document load options

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PdfLoadOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 103

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

  if attributes.key?(:'ClearBuiltInDocumentProperties')
    self.clear_built_in_document_properties = attributes[:'ClearBuiltInDocumentProperties']
  end

  if attributes.key?(:'ClearCustomDocumentProperties')
    self.clear_custom_document_properties = attributes[:'ClearCustomDocumentProperties']
  end

  if attributes.key?(:'PageNumbering')
    self.page_numbering = attributes[:'PageNumbering']
  end

  if attributes.key?(:'FlattenAllFields')
    self.flatten_all_fields = attributes[:'FlattenAllFields']
  end

  if attributes.key?(:'HidePdfAnnotations')
    self.hide_pdf_annotations = attributes[:'HidePdfAnnotations']
  end

  if attributes.key?(:'DefaultFont')
    self.default_font = attributes[:'DefaultFont']
  end

  if attributes.key?(:'Password')
    self.password = attributes[:'Password']
  end

  if attributes.key?(:'RemoveJavascript')
    self.remove_javascript = attributes[:'RemoveJavascript']
  end

  if attributes.key?(:'RemoveEmbeddedFiles')
    self.remove_embedded_files = attributes[:'RemoveEmbeddedFiles']
  end

  if attributes.key?(:'FontSubstitutes')
    if (value = attributes[:'FontSubstitutes']).is_a?(Hash)
      self.font_substitutes = value
    end
  end

end

Instance Attribute Details

#clear_built_in_document_properties ⇒ Object

Clear built-in document properties



38
39
40
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 38

def clear_built_in_document_properties
  @clear_built_in_document_properties
end

#clear_custom_document_properties ⇒ Object

Clear custom document properties



41
42
43
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 41

def clear_custom_document_properties
  @clear_custom_document_properties
end

#default_font ⇒ Object

Default font for Pdf document. The following font will be used if a font is missing.



53
54
55
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 53

def default_font
  @default_font
end

#flatten_all_fields ⇒ Object

Flatten all the fields of the PDF form



47
48
49
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 47

def flatten_all_fields
  @flatten_all_fields
end

#font_substitutes ⇒ Object

Substitute specific fonts when converting Words document.



65
66
67
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 65

def font_substitutes
  @font_substitutes
end

#format ⇒ Object

The format of input file, ("docx", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.



35
36
37
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 35

def format
  @format
end

#hide_pdf_annotations ⇒ Object

Hide annotations in Pdf documents



50
51
52
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 50

def hide_pdf_annotations
  @hide_pdf_annotations
end

#page_numbering ⇒ Object

Enable or disable generation of page numbering in converted document. Default: false



44
45
46
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 44

def page_numbering
  @page_numbering
end

#password ⇒ Object

Set password to unprotect protected document



56
57
58
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 56

def password
  @password
end

#remove_embedded_files ⇒ Object

Remove embedded files



62
63
64
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 62

def remove_embedded_files
  @remove_embedded_files
end

#remove_javascript ⇒ Object

Remove javascript



59
60
61
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 59

def remove_javascript
  @remove_javascript
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 68

def self.attribute_map
  {
    :'format' => :'Format',
    :'clear_built_in_document_properties' => :'ClearBuiltInDocumentProperties',
    :'clear_custom_document_properties' => :'ClearCustomDocumentProperties',
    :'page_numbering' => :'PageNumbering',
    :'flatten_all_fields' => :'FlattenAllFields',
    :'hide_pdf_annotations' => :'HidePdfAnnotations',
    :'default_font' => :'DefaultFont',
    :'password' => :'Password',
    :'remove_javascript' => :'RemoveJavascript',
    :'remove_embedded_files' => :'RemoveEmbeddedFiles',
    :'font_substitutes' => :'FontSubstitutes'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 85

def self.swagger_types
  {
    :'format' => :'String',
    :'clear_built_in_document_properties' => :'BOOLEAN',
    :'clear_custom_document_properties' => :'BOOLEAN',
    :'page_numbering' => :'BOOLEAN',
    :'flatten_all_fields' => :'BOOLEAN',
    :'hide_pdf_annotations' => :'BOOLEAN',
    :'default_font' => :'String',
    :'password' => :'String',
    :'remove_javascript' => :'BOOLEAN',
    :'remove_embedded_files' => :'BOOLEAN',
    :'font_substitutes' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 207

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      format == other.format &&
      clear_built_in_document_properties == other.clear_built_in_document_properties &&
      clear_custom_document_properties == other.clear_custom_document_properties &&
      page_numbering == other.page_numbering &&
      flatten_all_fields == other.flatten_all_fields &&
      hide_pdf_annotations == other.hide_pdf_annotations &&
      default_font == other.default_font &&
      password == other.password &&
      remove_javascript == other.remove_javascript &&
      remove_embedded_files == other.remove_embedded_files &&
      font_substitutes == other.font_substitutes
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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 268

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 = GroupDocsConversionCloud.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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 335

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 244

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


225
226
227
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 225

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



231
232
233
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 231

def hash
  [format, clear_built_in_document_properties, clear_custom_document_properties, page_numbering, flatten_all_fields, hide_pdf_annotations, default_font, password, remove_javascript, remove_embedded_files, font_substitutes].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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 159

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

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

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

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

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

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

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



315
316
317
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 315

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



321
322
323
324
325
326
327
328
329
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 321

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



309
310
311
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 309

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



237
238
239
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 237

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



194
195
196
197
198
199
200
201
202
203
 
# File 'lib/groupdocs_conversion_cloud/models/pdf_load_options.rb', line 194

def valid?
  return false if @clear_built_in_document_properties.nil?
  return false if @clear_custom_document_properties.nil?
  return false if @page_numbering.nil?
  return false if @flatten_all_fields.nil?
  return false if @hide_pdf_annotations.nil?
  return false if @remove_javascript.nil?
  return false if @remove_embedded_files.nil?
  return true
end