class AsposeCellsCloud::PdfSecurityOptions

Attributes

annotations_permission[RW]
assemble_document_permission[RW]
extract_content_permission[RW]
fill_forms_permission[RW]
full_quality_print_permission[RW]
modify_document_permission[RW]
owner_password[RW]
print_permission[RW]
user_password[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aspose_cells_cloud/models/pdf_security_options.rb, line 54
def self.attribute_map
  {
    :'annotations_permission' => :'AnnotationsPermission',
    :'assemble_document_permission' => :'AssembleDocumentPermission',
    :'extract_content_permission' => :'ExtractContentPermission',
    :'fill_forms_permission' => :'FillFormsPermission',
    :'full_quality_print_permission' => :'FullQualityPrintPermission',
    :'modify_document_permission' => :'ModifyDocumentPermission',
    :'owner_password' => :'OwnerPassword',
    :'print_permission' => :'PrintPermission',
    :'user_password' => :'UserPassword'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/aspose_cells_cloud/models/pdf_security_options.rb, line 85
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?(:'AnnotationsPermission')
      self.annotations_permission = attributes[:'AnnotationsPermission']
  end
  if attributes.has_key?(:'AssembleDocumentPermission')
      self.assemble_document_permission = attributes[:'AssembleDocumentPermission']
  end
  if attributes.has_key?(:'ExtractContentPermission')
      self.extract_content_permission = attributes[:'ExtractContentPermission']
  end
  if attributes.has_key?(:'FillFormsPermission')
      self.fill_forms_permission = attributes[:'FillFormsPermission']
  end
  if attributes.has_key?(:'FullQualityPrintPermission')
      self.full_quality_print_permission = attributes[:'FullQualityPrintPermission']
  end
  if attributes.has_key?(:'ModifyDocumentPermission')
      self.modify_document_permission = attributes[:'ModifyDocumentPermission']
  end
  if attributes.has_key?(:'OwnerPassword')
      self.owner_password = attributes[:'OwnerPassword']
  end
  if attributes.has_key?(:'PrintPermission')
      self.print_permission = attributes[:'PrintPermission']
  end
  if attributes.has_key?(:'UserPassword')
      self.user_password = attributes[:'UserPassword']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_cells_cloud/models/pdf_security_options.rb, line 69
def self.swagger_types
  {
    :'annotations_permission' => :'BOOLEAN',
    :'assemble_document_permission' => :'BOOLEAN',
    :'extract_content_permission' => :'BOOLEAN',
    :'fill_forms_permission' => :'BOOLEAN',
    :'full_quality_print_permission' => :'BOOLEAN',
    :'modify_document_permission' => :'BOOLEAN',
    :'owner_password' => :'String',
    :'print_permission' => :'BOOLEAN',
    :'user_password' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/aspose_cells_cloud/models/pdf_security_options.rb, line 173
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      annotations_permission == o.annotations_permission &&
      assemble_document_permission == o.assemble_document_permission &&
      extract_content_permission == o.extract_content_permission &&
      fill_forms_permission == o.fill_forms_permission &&
      full_quality_print_permission == o.full_quality_print_permission &&
      modify_document_permission == o.modify_document_permission &&
      owner_password == o.owner_password &&
      print_permission == o.print_permission &&
      user_password == o.user_password 
      std_dev == o.std_dev
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/aspose_cells_cloud/models/pdf_security_options.rb, line 224
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 = AsposeCellsCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/aspose_cells_cloud/models/pdf_security_options.rb, line 290
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/aspose_cells_cloud/models/pdf_security_options.rb, line 203
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) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/aspose_cells_cloud/models/pdf_security_options.rb, line 190
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/aspose_cells_cloud/models/pdf_security_options.rb, line 196
def hash
  [ annotations_permission , assemble_document_permission , extract_content_permission , fill_forms_permission , full_quality_print_permission , modify_document_permission , owner_password , print_permission , user_password ].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/aspose_cells_cloud/models/pdf_security_options.rb, line 123
def list_invalid_properties
  invalid_properties = Array.new
  if @annotations_permission.nil?
      invalid_properties.push("invalid value for 'annotations_permission', annotations_permission cannot be nil.")
  end
  if @assemble_document_permission.nil?
      invalid_properties.push("invalid value for 'assemble_document_permission', assemble_document_permission cannot be nil.")
  end
  if @extract_content_permission.nil?
      invalid_properties.push("invalid value for 'extract_content_permission', extract_content_permission cannot be nil.")
  end
  if @fill_forms_permission.nil?
      invalid_properties.push("invalid value for 'fill_forms_permission', fill_forms_permission cannot be nil.")
  end
  if @full_quality_print_permission.nil?
      invalid_properties.push("invalid value for 'full_quality_print_permission', full_quality_print_permission cannot be nil.")
  end
  if @modify_document_permission.nil?
      invalid_properties.push("invalid value for 'modify_document_permission', modify_document_permission cannot be nil.")
  end
  if @owner_password.nil?
      invalid_properties.push("invalid value for 'owner_password', owner_password cannot be nil.")
  end
  if @print_permission.nil?
      invalid_properties.push("invalid value for 'print_permission', print_permission cannot be nil.")
  end
  if @user_password.nil?
      invalid_properties.push("invalid value for 'user_password', user_password cannot be nil.")
  end

  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/aspose_cells_cloud/models/pdf_security_options.rb, line 270
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/aspose_cells_cloud/models/pdf_security_options.rb, line 276
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/aspose_cells_cloud/models/pdf_security_options.rb, line 264
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/aspose_cells_cloud/models/pdf_security_options.rb, line 158
def valid?
  return false if @annotations_permission.nil?
  return false if @assemble_document_permission.nil?
  return false if @extract_content_permission.nil?
  return false if @fill_forms_permission.nil?
  return false if @full_quality_print_permission.nil?
  return false if @modify_document_permission.nil?
  return false if @owner_password.nil?
  return false if @print_permission.nil?
  return false if @user_password.nil?
  return true
end