Class: AsposeSlidesCloud::Document

Inherits:
ResourceBase show all
Defined in:
lib/aspose_slides_cloud/models/document.rb

Overview

Represents document DTO.

Direct Known Subclasses

DocumentReplaceResult

Instance Attribute Summary collapse

Attributes inherited from ResourceBase

#alternate_links, #self_uri

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 72

def initialize(attributes = {})
  super

  if attributes.has_key?(:'DocumentProperties')
    self.document_properties = attributes[:'DocumentProperties']
  end

  if attributes.has_key?(:'ViewProperties')
    self.view_properties = attributes[:'ViewProperties']
  end

  if attributes.has_key?(:'Slides')
    self.slides = attributes[:'Slides']
  end

  if attributes.has_key?(:'Images')
    self.images = attributes[:'Images']
  end

  if attributes.has_key?(:'LayoutSlides')
    self.layout_slides = attributes[:'LayoutSlides']
  end

  if attributes.has_key?(:'MasterSlides')
    self.master_slides = attributes[:'MasterSlides']
  end
end

Instance Attribute Details

#document_properties ⇒ Object

Link to Document properties.



29
30
31
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 29

def document_properties
  @document_properties
end

#images ⇒ Object

Link to images collection.



38
39
40
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 38

def images
  @images
end

#layout_slides ⇒ Object

Link to layout slides collection.



41
42
43
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 41

def layout_slides
  @layout_slides
end

#master_slides ⇒ Object

Link to master slides collection.



44
45
46
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 44

def master_slides
  @master_slides
end

#slides ⇒ Object

Link to slides collection.



35
36
37
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 35

def slides
  @slides
end

#view_properties ⇒ Object

Link to Document properties.



32
33
34
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 32

def view_properties
  @view_properties
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 47

def self.attribute_map
  super.merge({
    :'document_properties' => :'DocumentProperties',
    :'view_properties' => :'ViewProperties',
    :'slides' => :'Slides',
    :'images' => :'Images',
    :'layout_slides' => :'LayoutSlides',
    :'master_slides' => :'MasterSlides',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 59

def self.swagger_types
  super.merge({
    :'document_properties' => :'ResourceUri',
    :'view_properties' => :'ResourceUri',
    :'slides' => :'ResourceUri',
    :'images' => :'ResourceUri',
    :'layout_slides' => :'ResourceUri',
    :'master_slides' => :'ResourceUri',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 116

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      self_uri == o.self_uri &&
      alternate_links == o.alternate_links &&
      document_properties == o.document_properties &&
      view_properties == o.view_properties &&
      slides == o.slides &&
      images == o.images &&
      layout_slides == o.layout_slides &&
      master_slides == o.master_slides
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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 177

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    registry_type = AsposeSlidesCloud::TypeRegistry.get_type(type.to_s, value)
    if registry_type
      type = registry_type
    end
    temp_model = AsposeSlidesCloud.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



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 247

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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 144

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    mapKey = self.class.attribute_map[key]
    if !mapKey.nil?
      val = attributes[mapKey]
      if val.nil?
        mapKeyString = mapKey.to_s
        mapKeyString[0] = mapKeyString[0].downcase
        mapKey = mapKeyString.to_sym
        val = attributes[mapKey]
      end
      if !val.nil?
        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 val.is_a?(Array)
            self.send("#{key}=", val.map { |v| _deserialize($1, v) })
          end
        else
          self.send("#{key}=", _deserialize(type, val))
        end
      end
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


131
132
133
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 131

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



137
138
139
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 137

def hash
  [self_uri, alternate_links, document_properties, view_properties, slides, images, layout_slides, master_slides].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



102
103
104
105
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 102

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



227
228
229
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 227

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



233
234
235
236
237
238
239
240
241
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 233

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



221
222
223
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 221

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



109
110
111
112
 
# File 'lib/aspose_slides_cloud/models/document.rb', line 109

def valid?
  return false if !super
  true
end