class AlfrescoAPI::SharedLink

Attributes

allowable_operations[RW]

The allowable operations for the Quickshare link itself. See allowableOperationsOnTarget for the allowable operations pertaining to the linked content node.

allowable_operations_on_target[RW]

The allowable operations for the content node being shared.

content[RW]
description[RW]
expires_at[RW]
id[RW]
modified_at[RW]
modified_by_user[RW]
name[RW]

The name must not contain spaces or the following special characters: * " < > \ / ? : and |. The character . must not be used at the end of the name.

node_id[RW]
shared_by_user[RW]
title[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/alfresco_api/models/shared_link.rb, line 47
def self.attribute_map
  {
    :'id' => :'id',
    :'expires_at' => :'expiresAt',
    :'node_id' => :'nodeId',
    :'name' => :'name',
    :'title' => :'title',
    :'description' => :'description',
    :'modified_at' => :'modifiedAt',
    :'modified_by_user' => :'modifiedByUser',
    :'shared_by_user' => :'sharedByUser',
    :'content' => :'content',
    :'allowable_operations' => :'allowableOperations',
    :'allowable_operations_on_target' => :'allowableOperationsOnTarget'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/alfresco_api/models/shared_link.rb, line 84
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?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'expiresAt')
    self.expires_at = attributes[:'expiresAt']
  end

  if attributes.has_key?(:'nodeId')
    self.node_id = attributes[:'nodeId']
  end

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

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

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

  if attributes.has_key?(:'modifiedAt')
    self.modified_at = attributes[:'modifiedAt']
  end

  if attributes.has_key?(:'modifiedByUser')
    self.modified_by_user = attributes[:'modifiedByUser']
  end

  if attributes.has_key?(:'sharedByUser')
    self.shared_by_user = attributes[:'sharedByUser']
  end

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

  if attributes.has_key?(:'allowableOperations')
    if (value = attributes[:'allowableOperations']).is_a?(Array)
      self.allowable_operations = value
    end
  end

  if attributes.has_key?(:'allowableOperationsOnTarget')
    if (value = attributes[:'allowableOperationsOnTarget']).is_a?(Array)
      self.allowable_operations_on_target = value
    end
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/alfresco_api/models/shared_link.rb, line 65
def self.swagger_types
  {
    :'id' => :'String',
    :'expires_at' => :'DateTime',
    :'node_id' => :'String',
    :'name' => :'String',
    :'title' => :'String',
    :'description' => :'String',
    :'modified_at' => :'DateTime',
    :'modified_by_user' => :'UserInfo',
    :'shared_by_user' => :'UserInfo',
    :'content' => :'ContentInfo',
    :'allowable_operations' => :'Array<String>',
    :'allowable_operations_on_target' => :'Array<String>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/alfresco_api/models/shared_link.rb, line 175
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      expires_at == o.expires_at &&
      node_id == o.node_id &&
      name == o.name &&
      title == o.title &&
      description == o.description &&
      modified_at == o.modified_at &&
      modified_by_user == o.modified_by_user &&
      shared_by_user == o.shared_by_user &&
      content == o.content &&
      allowable_operations == o.allowable_operations &&
      allowable_operations_on_target == o.allowable_operations_on_target
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/alfresco_api/models/shared_link.rb, line 228
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 = AlfrescoAPI.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/alfresco_api/models/shared_link.rb, line 294
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/alfresco_api/models/shared_link.rb, line 207
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/alfresco_api/models/shared_link.rb, line 194
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/alfresco_api/models/shared_link.rb, line 200
def hash
  [id, expires_at, node_id, name, title, description, modified_at, modified_by_user, shared_by_user, content, allowable_operations, allowable_operations_on_target].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/alfresco_api/models/shared_link.rb, line 146
def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name !~ Regexp.new(/^(?!(.*[\\\"\\*\\\\\\>\\<\\?\/\\:\\|]+.*)|(.*[\\.]?.*[\\.]+$)|(.*[ ]+$))/)
    invalid_properties.push("invalid value for 'name', must conform to the pattern /^(?!(.*[\\\"\\*\\\\\\>\\<\\?\/\\:\\|]+.*)|(.*[\\.]?.*[\\.]+$)|(.*[ ]+$))/.")
  end

  return invalid_properties
end
name=(name) click to toggle source

Custom attribute writer method with validation @param [Object] name Value to be assigned

# File lib/alfresco_api/models/shared_link.rb, line 164
def name=(name)

  if !name.nil? && name !~ Regexp.new(/^(?!(.*[\\\"\\*\\\\\\>\\<\\?\/\\:\\|]+.*)|(.*[\\.]?.*[\\.]+$)|(.*[ ]+$))/)
    fail ArgumentError, "invalid value for 'name', must conform to the pattern /^(?!(.*[\\\"\\*\\\\\\>\\<\\?\/\\:\\|]+.*)|(.*[\\.]?.*[\\.]+$)|(.*[ ]+$))/."
  end

  @name = name
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/alfresco_api/models/shared_link.rb, line 274
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/alfresco_api/models/shared_link.rb, line 280
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/alfresco_api/models/shared_link.rb, line 268
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/alfresco_api/models/shared_link.rb, line 157
def valid?
  return false if !@name.nil? && @name !~ Regexp.new(/^(?!(.*[\\\"\\*\\\\\\>\\<\\?\/\\:\\|]+.*)|(.*[\\.]?.*[\\.]+$)|(.*[ ]+$))/)
  return true
end