class AsposeWordsCloud::Document
Represents Words document DTO.
Attributes
Gets or sets the document properties.
Gets or sets the name of the file.
Gets or sets a value indicating whether the document is encrypted and requires a password to open.
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.
Gets or sets the list of links that originate from this document.
Gets or sets the original format of the document.
Public Class Methods
Source
# File lib/aspose_words_cloud/models/document.rb, line 73 def self.attribute_map { :'links' => :'Links', :'document_properties' => :'DocumentProperties', :'file_name' => :'FileName', :'is_encrypted' => :'IsEncrypted', :'is_signed' => :'IsSigned', :'source_format' => :'SourceFormat' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# 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?(:'Links') if (value = attributes[:'Links']).is_a?(Array) self.links = value end end 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?(:'SourceFormat') self.source_format = attributes[:'SourceFormat'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/aspose_words_cloud/models/document.rb, line 85 def self.swagger_types { :'links' => :'Array<Link>', :'document_properties' => :'DocumentProperties', :'file_name' => :'String', :'is_encrypted' => :'BOOLEAN', :'is_signed' => :'BOOLEAN', :'source_format' => :'String' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/aspose_words_cloud/models/document.rb, line 157 def ==(other) return true if self.equal?(other) self.class == other.class && links == other.links && document_properties == other.document_properties && file_name == other.file_name && is_encrypted == other.is_encrypted && is_signed == other.is_signed && source_format == other.source_format end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/aspose_words_cloud/models/document.rb, line 205 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 if value[:'$type'] type = value[:'$type'][0..-4] end temp_model = AsposeWordsCloud.const_get(type).new temp_model.build_from_hash(value) end end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/aspose_words_cloud/models/document.rb, line 276 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
Source
# File lib/aspose_words_cloud/models/document.rb, line 183 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/aspose_words_cloud/models/document.rb, line 290 def collectFilesContent(resultFilesContent) end
Source
# File lib/aspose_words_cloud/models/document.rb, line 170 def eql?(other) self == other end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/aspose_words_cloud/models/document.rb, line 176 def hash [links, document_properties, file_name, is_encrypted, is_signed, source_format].hash end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
Source
# File lib/aspose_words_cloud/models/document.rb, line 142 def source_format=(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", "Azw3"]) if source_format.to_i == 0 unless validator.valid?(source_format) raise ArgumentError, "invalid value for 'source_format', must be one of #{validator.allowable_values}." end @source_format = source_format else @source_format = validator.allowable_values[source_format.to_i] end end
Custom attribute writer method checking allowed values (enum). @param [Object] source_format
Object to be assigned
Source
Source
# File lib/aspose_words_cloud/models/document.rb, line 262 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/aspose_words_cloud/models/document.rb, line 250 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/aspose_words_cloud/models/document.rb, line 133 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", "Azw3"]) return false unless source_format_validator.valid?(@source_format) return true end
Check to see if the all the properties in the model are valid @return true if the model is valid
Source
# File lib/aspose_words_cloud/models/document.rb, line 293 def validate() raise ArgumentError, 'Property is_encrypted in Document is required.' if self.is_encrypted.nil? raise ArgumentError, 'Property is_signed in Document is required.' if self.is_signed.nil? raise ArgumentError, 'Property source_format in Document is required.' if self.source_format.nil? unless self.links.nil? for elementLinks in self.links unless elementLinks.nil? elementLinks.validate end end end unless self.document_properties.nil? self.document_properties.validate end end