Class: AsposeWordsCloud::FileReference

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

Overview

Class to wrap file content inside another class models.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, reference, content, password) ⇒ FileReference

Returns a new instance of FileReference.



67
68
69
70
71
72
73
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 67

def initialize(source, reference, content, password)
  self.source = source
  self.reference = reference
  self.content = content
  self.password = password
  self.encryptedPassword = nil
end

Instance Attribute Details

#content ⇒ Object

Gets or sets the file data.



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

def content
  @content
end

#encryptedPassword ⇒ Object

Gets or sets the encrypted password.



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

def encryptedPassword
  @encryptedPassword
end

#password ⇒ Object

Gets or sets the password.



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

def password
  @password
end

#reference ⇒ Object

Gets or sets the reference.



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

def reference
  @reference
end

#source ⇒ Object

Gets or sets the file source.



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

def source
  @source
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 48

def self.attribute_map
  {
    :'source' => :'Source',
    :'reference' => :'Reference',
    :'password' => :'Password',
    :'encryptedPassword' => :'EncryptedPassword'
  }
end

.fromLocalFileContent(localFileContent) ⇒ Object 



83
84
85
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 83

def self.fromLocalFileContent(localFileContent)
  self.new('Request', SecureRandom.uuid, localFileContent, nil)
end

.fromLocalFileContentWithPassword(localFileContent, password) ⇒ Object 



87
88
89
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 87

def self.fromLocalFileContentWithPassword(localFileContent, password)
  self.new('Request', SecureRandom.uuid, localFileContent, password)
end

.fromRemoteFilePath(remoteFilePath) ⇒ Object 



75
76
77
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 75

def self.fromRemoteFilePath(remoteFilePath)
  self.new('Storage', remoteFilePath, nil, nil)
end

.fromRemoteFilePathWithPassword(remoteFilePath, password) ⇒ Object 



79
80
81
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 79

def self.fromRemoteFilePathWithPassword(remoteFilePath, password)
  self.new('Storage', remoteFilePath, nil, password)
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 58

def self.swagger_types
  {
    :'source' => :'Source',
    :'reference' => :'Reference',
    :'password' => :'Password',
    :'encryptedPassword' => :'EncryptedPassword'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



106
107
108
109
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 106

def ==(other)
  return true if self.equal?(other)
  self.class == other.class && source == other.source && reference == other.reference && password == other.password && encryptedPassword == other.encryptedPassword
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



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
179
180
181
182
183
184
185
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 148

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



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 215

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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 126

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

#collectFilesContent(resultFilesContent) ⇒ Object 



229
230
231
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 229

def collectFilesContent(resultFilesContent)
  resultFilesContent.push(self)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


113
114
115
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 113

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



119
120
121
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 119

def hash
  [source, reference, password, encryptedPassword].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



93
94
95
96
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 93

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



195
196
197
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 195

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



201
202
203
204
205
206
207
208
209
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 201

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



189
190
191
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 189

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



100
101
102
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 100

def valid?
  return true
end

#validate ⇒ Object 



233
234
235
 
# File 'lib/aspose_words_cloud/models/file_reference.rb', line 233

def validate()
  # Do nothing
end