Class: AsposeSlidesCloud::AccessPermissions

Inherits:
BaseObject
  • Object
show all
Defined in:
lib/aspose_slides_cloud/models/access_permissions.rb

Overview

A set of properties specifying which access permissions should be granted when the document is opened with user access.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseObject

#_deserialize, #_to_hash, #build_from_hash, #to_body, #to_hash, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ AccessPermissions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/aspose_slides_cloud/models/access_permissions.rb', line 82

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?(:'PrintDocument')
    self.print_document = attributes[:'PrintDocument']
  end

  if attributes.has_key?(:'ModifyContent')
    self.modify_content = attributes[:'ModifyContent']
  end

  if attributes.has_key?(:'CopyTextAndGraphics')
    self.copy_text_and_graphics = attributes[:'CopyTextAndGraphics']
  end

  if attributes.has_key?(:'AddOrModifyFields')
    self.add_or_modify_fields = attributes[:'AddOrModifyFields']
  end

  if attributes.has_key?(:'FillExistingFields')
    self.fill_existing_fields = attributes[:'FillExistingFields']
  end

  if attributes.has_key?(:'ExtractTextAndGraphics')
    self.extract_text_and_graphics = attributes[:'ExtractTextAndGraphics']
  end

  if attributes.has_key?(:'AssembleDocument')
    self.assemble_document = attributes[:'AssembleDocument']
  end

  if attributes.has_key?(:'HighQualityPrint')
    self.high_quality_print = attributes[:'HighQualityPrint']
  end
end

Instance Attribute Details

#add_or_modify_fields ⇒ Object

The user may add or modify text annotations, fill in interactive form fields, and, if bit ModifyContent is also set, create or modify interactive form fields (including signature fields).



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

def add_or_modify_fields
  @add_or_modify_fields
end

#assemble_document ⇒ Object

The user may assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if bit ModifyContent is clear.



47
48
49
 
# File 'lib/aspose_slides_cloud/models/access_permissions.rb', line 47

def assemble_document
  @assemble_document
end

#copy_text_and_graphics ⇒ Object

The user may copy or otherwise extract text and graphics from the document by operations other than that controlled by bit ExtractTextAndGraphics.



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

def copy_text_and_graphics
  @copy_text_and_graphics
end

#extract_text_and_graphics ⇒ Object

The user may extract text and graphics in support of accessibility to users with disabilities or for other purposes.



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

def extract_text_and_graphics
  @extract_text_and_graphics
end

#fill_existing_fields ⇒ Object

The user may fill in existing interactive form fields (including signature fields), even if bit AddOrModifyFields is clear.



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

def fill_existing_fields
  @fill_existing_fields
end

#high_quality_print ⇒ Object

The user may print the document to a representation from which a faithful digital copy of the PDF content could be generated. When this bit is clear (and bit PrintDocument is set), printing is limited to a low-level representation of the appearance, possibly of degraded quality.



50
51
52
 
# File 'lib/aspose_slides_cloud/models/access_permissions.rb', line 50

def high_quality_print
  @high_quality_print
end

#modify_content ⇒ Object

The user may modify the contents of the document by operations other than those controlled by bits AddOrModifyFields, FillExistingFields, AssembleDocument.



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

def modify_content
  @modify_content
end

#print_document ⇒ Object

The user may print the document (possibly not at the highest quality level, depending on whether bit HighQualityPrint is also set).



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

def print_document
  @print_document
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/aspose_slides_cloud/models/access_permissions.rb', line 53

def self.attribute_map
  {
    :'print_document' => :'PrintDocument',
    :'modify_content' => :'ModifyContent',
    :'copy_text_and_graphics' => :'CopyTextAndGraphics',
    :'add_or_modify_fields' => :'AddOrModifyFields',
    :'fill_existing_fields' => :'FillExistingFields',
    :'extract_text_and_graphics' => :'ExtractTextAndGraphics',
    :'assemble_document' => :'AssembleDocument',
    :'high_quality_print' => :'HighQualityPrint',
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/aspose_slides_cloud/models/access_permissions.rb', line 67

def self.swagger_types
  {
    :'print_document' => :'BOOLEAN',
    :'modify_content' => :'BOOLEAN',
    :'copy_text_and_graphics' => :'BOOLEAN',
    :'add_or_modify_fields' => :'BOOLEAN',
    :'fill_existing_fields' => :'BOOLEAN',
    :'extract_text_and_graphics' => :'BOOLEAN',
    :'assemble_document' => :'BOOLEAN',
    :'high_quality_print' => :'BOOLEAN',
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/aspose_slides_cloud/models/access_permissions.rb', line 176

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      print_document == o.print_document &&
      modify_content == o.modify_content &&
      copy_text_and_graphics == o.copy_text_and_graphics &&
      add_or_modify_fields == o.add_or_modify_fields &&
      fill_existing_fields == o.fill_existing_fields &&
      extract_text_and_graphics == o.extract_text_and_graphics &&
      assemble_document == o.assemble_document &&
      high_quality_print == o.high_quality_print
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


191
192
193
 
# File 'lib/aspose_slides_cloud/models/access_permissions.rb', line 191

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



197
198
199
 
# File 'lib/aspose_slides_cloud/models/access_permissions.rb', line 197

def hash
  [print_document, modify_content, copy_text_and_graphics, add_or_modify_fields, fill_existing_fields, extract_text_and_graphics, assemble_document, high_quality_print].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



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
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/aspose_slides_cloud/models/access_permissions.rb', line 123

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

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

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

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

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

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

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

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

  invalid_properties
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/aspose_slides_cloud/models/access_permissions.rb', line 162

def valid?
  return false if @print_document.nil?
  return false if @modify_content.nil?
  return false if @copy_text_and_graphics.nil?
  return false if @add_or_modify_fields.nil?
  return false if @fill_existing_fields.nil?
  return false if @extract_text_and_graphics.nil?
  return false if @assemble_document.nil?
  return false if @high_quality_print.nil?
  true
end