Class: GroupDocs::User

Inherits:
Api::Entity show all
Defined in:
lib/groupdocs/user.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Api::Entity

#initialize, #inspect, #to_hash

Constructor Details

This class inherits a constructor from GroupDocs::Api::Entity

Instance Attribute Details

#active ⇒ Object 



52
53
54
 
# File 'lib/groupdocs/user.rb', line 52

def active
  @active
end

#claimed_id ⇒ Object 



44
45
46
 
# File 'lib/groupdocs/user.rb', line 44

def claimed_id
  @claimed_id
end

#firstname ⇒ Object Also known as: first_name 



34
35
36
 
# File 'lib/groupdocs/user.rb', line 34

def firstname
  @firstname
end

#guid ⇒ Object 



30
31
32
 
# File 'lib/groupdocs/user.rb', line 30

def guid
  @guid
end

#id ⇒ Object 



28
29
30
 
# File 'lib/groupdocs/user.rb', line 28

def id
  @id
end

#lastname ⇒ Object Also known as: last_name 



36
37
38
 
# File 'lib/groupdocs/user.rb', line 36

def lastname
  @lastname
end

#news_enabled ⇒ Object 



54
55
56
 
# File 'lib/groupdocs/user.rb', line 54

def news_enabled
  @news_enabled
end

#nickname ⇒ Object 



32
33
34
 
# File 'lib/groupdocs/user.rb', line 32

def nickname
  @nickname
end

#password_salt ⇒ Object 



42
43
44
 
# File 'lib/groupdocs/user.rb', line 42

def password_salt
  @password_salt
end

#photo ⇒ Object 



50
51
52
 
# File 'lib/groupdocs/user.rb', line 50

def photo
  @photo
end

#primary_email ⇒ Object 



38
39
40
 
# File 'lib/groupdocs/user.rb', line 38

def primary_email
  @primary_email
end

#private_key ⇒ Object 



40
41
42
 
# File 'lib/groupdocs/user.rb', line 40

def private_key
  @private_key
end

#signed_up_on ⇒ Time

Converts timestamp which is return by API server to Time object.

Returns:

  • (Time) 


56
57
58
 
# File 'lib/groupdocs/user.rb', line 56

def signed_up_on
  @signed_up_on
end

#storage ⇒ Object 



48
49
50
 
# File 'lib/groupdocs/user.rb', line 48

def storage
  @storage
end

#token ⇒ Object 



46
47
48
 
# File 'lib/groupdocs/user.rb', line 46

def token
  @token
end

Class Method Details

.get!(access = {}) ⇒ GroupDocs::User

Returns current user profile.

Examples:

Get fill

user = GroupDocs::User.get!
user.first_name
#=> "John"

Parameters:

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

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:



17
18
19
20
21
22
23
24
25
 
# File 'lib/groupdocs/user.rb', line 17

def self.get!(access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = '/mgmt/{{client_id}}/profile'
  end.execute!

  new(json[:user])
end

Instance Method Details

#update!(access = {}) ⇒ Object

Updates user profile.

Examples:

user = GroupDocs::User.get!
user.first_name = 'John'
user.last_name = 'Smith'
user.update!

Parameters:

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

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String) 


91
92
93
94
95
96
97
98
 
# File 'lib/groupdocs/user.rb', line 91

def update!(access = {})
  Api::Request.new do |request|
    request[:access] = access
    request[:method] = :PUT
    request[:path] = '/mgmt/{{client_id}}/profile'
    request[:request_body] = to_hash
  end.execute!
end