Class: AsposeWordsCloud::Document

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/document.rb

Overview

Represents Words document DTO.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Document

Initializes the object

Parameters:

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

    Model attributes in the form of hash



98
99
100
101
102
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
 
# File 'lib/aspose_words_cloud/models/document.rb', line 98

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

  if attributes.key?(:'FileName')
    self.file_name = attributes[:'FileName']
  end

  if attributes.key?(:'IsEncrypted')
    self.is_encrypted = attributes[:'IsEncrypted']
  end

  if attributes.key?(:'IsSigned')
    self.is_signed = attributes[:'IsSigned']
  end

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

  if attributes.key?(:'SourceFormat')
    self.source_format = attributes[:'SourceFormat']
  end
end

Instance Attribute Details

#document_properties ⇒ Object

Gets or sets the document properties.



33
34
35
 
# File 'lib/aspose_words_cloud/models/document.rb', line 33

def document_properties
  @document_properties
end

#file_name ⇒ Object

Gets or sets the name of the file.



36
37
38
 
# File 'lib/aspose_words_cloud/models/document.rb', line 36

def file_name
  @file_name
end

#is_encrypted ⇒ Object

Gets or sets a value indicating whether the document is encrypted and requires a password to open.



39
40
41
 
# File 'lib/aspose_words_cloud/models/document.rb', line 39

def is_encrypted
  @is_encrypted
end

#is_signed ⇒ Object

Gets or sets a value indicating whether the document contains a digital signature. This property merely informs that a digital signature is present on a document, but it does not specify whether the signature is valid or not.



42
43
44
 
# File 'lib/aspose_words_cloud/models/document.rb', line 42

def is_signed
  @is_signed
end

#links ⇒ Object

Gets or sets the list of links that originate from this document.



45
46
47
 
# File 'lib/aspose_words_cloud/models/document.rb', line 45

def links
  @links
end

#source_format ⇒ Object

Gets or sets the original format of the document.



48
49
50
 
# File 'lib/aspose_words_cloud/models/document.rb', line 48

def source_format
  @source_format
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/aspose_words_cloud/models/document.rb', line 73

def self.attribute_map
  {
    :'document_properties' => :'DocumentProperties',
    :'file_name' => :'FileName',
    :'is_encrypted' => :'IsEncrypted',
    :'is_signed' => :'IsSigned',
    :'links' => :'Links',
    :'source_format' => :'SourceFormat'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
 
# File 'lib/aspose_words_cloud/models/document.rb', line 85

def self.swagger_types
  {
    :'document_properties' => :'DocumentProperties',
    :'file_name' => :'String',
    :'is_encrypted' => :'BOOLEAN',
    :'is_signed' => :'BOOLEAN',
    :'links' => :'Array<Link>',
    :'source_format' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/aspose_words_cloud/models/document.rb', line 164

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      document_properties == other.document_properties &&
      file_name == other.file_name &&
      is_encrypted == other.is_encrypted &&
      is_signed == other.is_signed &&
      links == other.links &&
      source_format == other.source_format
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



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
246
247
248
249
 
# File 'lib/aspose_words_cloud/models/document.rb', line 212

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Time.at(/\d/.match(value)[0].to_f).to_datetime
  when :Date
    Time.at(/\d/.match(value)[0].to_f).to_date
  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 = AsposeWordsCloud.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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/aspose_words_cloud/models/document.rb', line 279

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/aspose_words_cloud/models/document.rb', line 190

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?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


177
178
179
 
# File 'lib/aspose_words_cloud/models/document.rb', line 177

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



183
184
185
 
# File 'lib/aspose_words_cloud/models/document.rb', line 183

def hash
  [document_properties, file_name, is_encrypted, is_signed, links, source_format].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



133
134
135
136
 
# File 'lib/aspose_words_cloud/models/document.rb', line 133

def list_invalid_properties
  invalid_properties = []
  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



259
260
261
 
# File 'lib/aspose_words_cloud/models/document.rb', line 259

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



265
266
267
268
269
270
271
272
273
 
# File 'lib/aspose_words_cloud/models/document.rb', line 265

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



253
254
255
 
# File 'lib/aspose_words_cloud/models/document.rb', line 253

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



140
141
142
143
144
145
 
# File 'lib/aspose_words_cloud/models/document.rb', line 140

def valid?
  source_format_validator = EnumAttributeValidator.new('String', ["Unknown", "Doc", "Dot", "DocPreWord60", "Docx", "Docm", "Dotx", "Dotm", "FlatOpc", "Rtf", "WordML", "Html", "Mhtml", "Epub", "Text", "Odt", "Ott", "Pdf", "Xps", "Tiff", "Svg"])
  return false unless source_format_validator.valid?(@source_format)

  return true
end