Class: AlfrescoAPI::SharedLink

Inherits:
Object
  • Object
show all
Defined in:
lib/alfresco_api/models/shared_link.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SharedLink

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# 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

Instance Attribute Details

#allowable_operations ⇒ Object

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



40
41
42
 
# File 'lib/alfresco_api/models/shared_link.rb', line 40

def allowable_operations
  @allowable_operations
end

#allowable_operations_on_target ⇒ Object

The allowable operations for the content node being shared.



43
44
45
 
# File 'lib/alfresco_api/models/shared_link.rb', line 43

def allowable_operations_on_target
  @allowable_operations_on_target
end

#content ⇒ Object

Returns the value of attribute content.



37
38
39
 
# File 'lib/alfresco_api/models/shared_link.rb', line 37

def content
  @content
end

#description ⇒ Object

Returns the value of attribute description.



29
30
31
 
# File 'lib/alfresco_api/models/shared_link.rb', line 29

def description
  @description
end

#expires_at ⇒ Object

Returns the value of attribute expires_at.



20
21
22
 
# File 'lib/alfresco_api/models/shared_link.rb', line 20

def expires_at
  @expires_at
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/alfresco_api/models/shared_link.rb', line 18

def id
  @id
end

#modified_at ⇒ Object

Returns the value of attribute modified_at.



31
32
33
 
# File 'lib/alfresco_api/models/shared_link.rb', line 31

def modified_at
  @modified_at
end

#modified_by_user ⇒ Object

Returns the value of attribute modified_by_user.



33
34
35
 
# File 'lib/alfresco_api/models/shared_link.rb', line 33

def modified_by_user
  @modified_by_user
end

#name ⇒ Object

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



25
26
27
 
# File 'lib/alfresco_api/models/shared_link.rb', line 25

def name
  @name
end

#node_id ⇒ Object

Returns the value of attribute node_id.



22
23
24
 
# File 'lib/alfresco_api/models/shared_link.rb', line 22

def node_id
  @node_id
end

#shared_by_user ⇒ Object

Returns the value of attribute shared_by_user.



35
36
37
 
# File 'lib/alfresco_api/models/shared_link.rb', line 35

def shared_by_user
  @shared_by_user
end

#title ⇒ Object

Returns the value of attribute title.



27
28
29
 
# File 'lib/alfresco_api/models/shared_link.rb', line 27

def title
  @title
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
57
58
59
60
61
62
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
254
255
256
257
258
259
260
261
262
263
264
 
# 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) ⇒ 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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


194
195
196
 
# File 'lib/alfresco_api/models/shared_link.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



200
201
202
 
# 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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



146
147
148
149
150
151
152
153
 
# 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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



274
275
276
 
# File 'lib/alfresco_api/models/shared_link.rb', line 274

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



280
281
282
283
284
285
286
287
288
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



268
269
270
 
# File 'lib/alfresco_api/models/shared_link.rb', line 268

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



157
158
159
160
 
# File 'lib/alfresco_api/models/shared_link.rb', line 157

def valid?
  return false if !@name.nil? && @name !~ Regexp.new(/^(?!(.*[\\\"\\*\\\\\\>\\<\\?\/\\:\\|]+.*)|(.*[\\.]?.*[\\.]+$)|(.*[ ]+$))/)
  return true
end