Class: AsposeSlidesCloud::ProtectionProperties

Inherits:
ResourceBase
  • Object
show all
Defined in:
lib/aspose_slides_cloud/models/protection_properties.rb

Overview

Protection properties.

Instance Attribute Summary collapse

Attributes inherited from ResourceBase

#alternate_links, #self_uri

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProtectionProperties

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/protection_properties.rb', line 72

def initialize(attributes = {})
  super

  if attributes.has_key?(:'EncryptDocumentProperties')
    self.encrypt_document_properties = attributes[:'EncryptDocumentProperties']
  end

  if attributes.has_key?(:'ReadOnlyRecommended')
    self.read_only_recommended = attributes[:'ReadOnlyRecommended']
  end

  if attributes.has_key?(:'ReadPassword')
    self.read_password = attributes[:'ReadPassword']
  end

  if attributes.has_key?(:'WritePassword')
    self.write_password = attributes[:'WritePassword']
  end

  if attributes.has_key?(:'IsWriteProtected')
    self.is_write_protected = attributes[:'IsWriteProtected']
  end

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

Instance Attribute Details

#encrypt_document_properties ⇒ Object

True if document properties are encrypted. Has effect only for password protected presentations.



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

def encrypt_document_properties
  @encrypt_document_properties
end

#is_encrypted ⇒ Object

Returns true if the presentation protected for reading.



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

def is_encrypted
  @is_encrypted
end

#is_write_protected ⇒ Object

Returns true if the presentation protected for editing.



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

def is_write_protected
  @is_write_protected
end

#read_only_recommended ⇒ Object

True if the document should be opened as read-only.



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

def read_only_recommended
  @read_only_recommended
end

#read_password ⇒ Object

Password for read protection.



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

def read_password
  @read_password
end

#write_password ⇒ Object

Password for write protection.



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

def write_password
  @write_password
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/protection_properties.rb', line 47

def self.attribute_map
  super.merge({
    :'encrypt_document_properties' => :'EncryptDocumentProperties',
    :'read_only_recommended' => :'ReadOnlyRecommended',
    :'read_password' => :'ReadPassword',
    :'write_password' => :'WritePassword',
    :'is_write_protected' => :'IsWriteProtected',
    :'is_encrypted' => :'IsEncrypted',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  super.merge({
    :'encrypt_document_properties' => :'BOOLEAN',
    :'read_only_recommended' => :'BOOLEAN',
    :'read_password' => :'String',
    :'write_password' => :'String',
    :'is_write_protected' => :'BOOLEAN',
    :'is_encrypted' => :'BOOLEAN',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/aspose_slides_cloud/models/protection_properties.rb', line 126

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      self_uri == o.self_uri &&
      alternate_links == o.alternate_links &&
      encrypt_document_properties == o.encrypt_document_properties &&
      read_only_recommended == o.read_only_recommended &&
      read_password == o.read_password &&
      write_password == o.write_password &&
      is_write_protected == o.is_write_protected &&
      is_encrypted == o.is_encrypted
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



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/aspose_slides_cloud/models/protection_properties.rb', line 187

def _deserialize(type, value)
  if value.nil?
    nil
  else
    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
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



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/aspose_slides_cloud/models/protection_properties.rb', line 261

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



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
 
# File 'lib/aspose_slides_cloud/models/protection_properties.rb', line 154

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


141
142
143
 
# File 'lib/aspose_slides_cloud/models/protection_properties.rb', line 141

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



147
148
149
 
# File 'lib/aspose_slides_cloud/models/protection_properties.rb', line 147

def hash
  [self_uri, alternate_links, encrypt_document_properties, read_only_recommended, read_password, write_password, is_write_protected, is_encrypted].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
106
107
108
109
110
111
112
113
 
# File 'lib/aspose_slides_cloud/models/protection_properties.rb', line 102

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

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

  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



241
242
243
 
# File 'lib/aspose_slides_cloud/models/protection_properties.rb', line 241

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



247
248
249
250
251
252
253
254
255
 
# File 'lib/aspose_slides_cloud/models/protection_properties.rb', line 247

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



235
236
237
 
# File 'lib/aspose_slides_cloud/models/protection_properties.rb', line 235

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



117
118
119
120
121
122
 
# File 'lib/aspose_slides_cloud/models/protection_properties.rb', line 117

def valid?
  return false if !super
  return false if @is_write_protected.nil?
  return false if @is_encrypted.nil?
  true
end