Class: AsposePdfCloud::DocumentPrivilege

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_pdf_cloud/models/document_privilege.rb

Overview

Represents the privileges for accessing Pdf file.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentPrivilege

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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.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.has_key?(:'AllowPrint')
    self.allow_print = attributes[:'AllowPrint']
  end

  if attributes.has_key?(:'AllowDegradedPrinting')
    self.allow_degraded_printing = attributes[:'AllowDegradedPrinting']
  end

  if attributes.has_key?(:'AllowModifyContents')
    self.allow_modify_contents = attributes[:'AllowModifyContents']
  end

  if attributes.has_key?(:'AllowCopy')
    self.allow_copy = attributes[:'AllowCopy']
  end

  if attributes.has_key?(:'AllowModifyAnnotations')
    self.allow_modify_annotations = attributes[:'AllowModifyAnnotations']
  end

  if attributes.has_key?(:'AllowFillIn')
    self.allow_fill_in = attributes[:'AllowFillIn']
  end

  if attributes.has_key?(:'AllowScreenReaders')
    self.allow_screen_readers = attributes[:'AllowScreenReaders']
  end

  if attributes.has_key?(:'AllowAssembly')
    self.allow_assembly = attributes[:'AllowAssembly']
  end

  if attributes.has_key?(:'PrintAllowLevel')
    self.print_allow_level = attributes[:'PrintAllowLevel']
  end

  if attributes.has_key?(:'ChangeAllowLevel')
    self.change_allow_level = attributes[:'ChangeAllowLevel']
  end

  if attributes.has_key?(:'CopyAllowLevel')
    self.copy_allow_level = attributes[:'CopyAllowLevel']
  end

end

Instance Attribute Details

#allow_assembly ⇒ Object

Sets the permission which allow assembly or not. true is allow and false or not set is forbidden.



50
51
52
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 50

def allow_assembly
  @allow_assembly
end

#allow_copy ⇒ Object

Sets the permission which allow copy or not. true is allow and false or not set is forbidden.



38
39
40
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 38

def allow_copy
  @allow_copy
end

#allow_degraded_printing ⇒ Object

Sets the permission which allow degraded printing or not. true is allow and false or not set is forbidden.



32
33
34
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 32

def allow_degraded_printing
  @allow_degraded_printing
end

#allow_fill_in ⇒ Object

Sets the permission which allow fill in forms or not. true is allow and false or not set is forbidden.



44
45
46
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 44

def allow_fill_in
  @allow_fill_in
end

#allow_modify_annotations ⇒ Object

Sets the permission which allow modify annotations or not. true is allow and false or not set is forbidden.



41
42
43
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 41

def allow_modify_annotations
  @allow_modify_annotations
end

#allow_modify_contents ⇒ Object

Sets the permission which allow modify contents or not. true is allow and false or not set is forbidden.



35
36
37
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 35

def allow_modify_contents
  @allow_modify_contents
end

#allow_print ⇒ Object

Sets the permission which allow print or not. true is allow and false or not set is forbidden.



29
30
31
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 29

def allow_print
  @allow_print
end

#allow_screen_readers ⇒ Object

Sets the permission which allow screen readers or not. true is allow and false or not set is forbidden.



47
48
49
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 47

def allow_screen_readers
  @allow_screen_readers
end

#change_allow_level ⇒ Object

Sets the change level of document’s privilege. Just as the Adobe Professional’s Changes Allowed settings. 0: None. 1: Inserting, Deleting and Rotating pages. 2: Filling in form fields and signing existing signature fields. 3: Commenting, filling in form fields, and signing existing signature fields. 4: Any except extracting pages.



56
57
58
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 56

def change_allow_level
  @change_allow_level
end

#copy_allow_level ⇒ Object

Sets the copy level of document’s privilege. Just as the Adobe Professional’s permission settings. 0: None. 1: Enable text access for screen reader devices for the visually impaired. 2: Enable copying of text, images and other content.



59
60
61
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 59

def copy_allow_level
  @copy_allow_level
end

#print_allow_level ⇒ Object

Sets the print level of document’s privilege. Just as the Adobe Professional’s Printing Allowed settings. 0: None. 1: Low Resolution (150 dpi). 2: High Resolution.



53
54
55
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 53

def print_allow_level
  @print_allow_level
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 63

def self.attribute_map
  {
    :'allow_print' => :'AllowPrint',
    :'allow_degraded_printing' => :'AllowDegradedPrinting',
    :'allow_modify_contents' => :'AllowModifyContents',
    :'allow_copy' => :'AllowCopy',
    :'allow_modify_annotations' => :'AllowModifyAnnotations',
    :'allow_fill_in' => :'AllowFillIn',
    :'allow_screen_readers' => :'AllowScreenReaders',
    :'allow_assembly' => :'AllowAssembly',
    :'print_allow_level' => :'PrintAllowLevel',
    :'change_allow_level' => :'ChangeAllowLevel',
    :'copy_allow_level' => :'CopyAllowLevel'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 80

def self.swagger_types
  {
    :'allow_print' => :'BOOLEAN',
    :'allow_degraded_printing' => :'BOOLEAN',
    :'allow_modify_contents' => :'BOOLEAN',
    :'allow_copy' => :'BOOLEAN',
    :'allow_modify_annotations' => :'BOOLEAN',
    :'allow_fill_in' => :'BOOLEAN',
    :'allow_screen_readers' => :'BOOLEAN',
    :'allow_assembly' => :'BOOLEAN',
    :'print_allow_level' => :'Integer',
    :'change_allow_level' => :'Integer',
    :'copy_allow_level' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 165

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_print == o.allow_print &&
      allow_degraded_printing == o.allow_degraded_printing &&
      allow_modify_contents == o.allow_modify_contents &&
      allow_copy == o.allow_copy &&
      allow_modify_annotations == o.allow_modify_annotations &&
      allow_fill_in == o.allow_fill_in &&
      allow_screen_readers == o.allow_screen_readers &&
      allow_assembly == o.allow_assembly &&
      print_allow_level == o.print_allow_level &&
      change_allow_level == o.change_allow_level &&
      copy_allow_level == o.copy_allow_level
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



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
250
251
252
253
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 217

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
    temp_model = AsposePdfCloud.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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 283

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 196

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


183
184
185
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 183

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



189
190
191
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 189

def hash
  [allow_print, allow_degraded_printing, allow_modify_contents, allow_copy, allow_modify_annotations, allow_fill_in, allow_screen_readers, allow_assembly, print_allow_level, change_allow_level, copy_allow_level].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



152
153
154
155
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 152

def list_invalid_properties
  invalid_properties = Array.new
  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



263
264
265
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 263

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



269
270
271
272
273
274
275
276
277
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 269

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



257
258
259
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 257

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



159
160
161
 
# File 'lib/aspose_pdf_cloud/models/document_privilege.rb', line 159

def valid?
  return true
end