Method: Colrapi.user

Defined in:
lib/colrapi.rb

.user(user_id: nil, q: nil, role: nil, offset: nil, limit: nil, token: nil, verbose: false) ⇒ Array, Boolean

Get user data

Parameters:

  • user_id (Integer, nil) (defaults to: nil) —

    The user id

  • q (String, nil) (defaults to: nil) —

    The search query

  • role (String, nil) (defaults to: nil) —

    The user role (admin, editor, or reviewer)

  • offset (Integer) (defaults to: nil) —

    Offset for pagination

  • limit (Integer) (defaults to: nil) —

    Limit for pagination

  • token (String, nil) (defaults to: nil) —

    The authentication token from retrieved with Colrapi.user_login(user, password)

  • verbose (Boolean) (defaults to: false) —

    Print headers to STDOUT

Returns:

  • (Array, Boolean) —

    An array of hashes



943
944
945
946
947
948
949
950
951
952
 
# File 'lib/colrapi.rb', line 943

def self.user(user_id: nil, q: nil, role: nil, offset: nil, limit: nil, token: nil, verbose: false)
  if user_id.nil?
    endpoint = "user"
    Request.new(endpoint: endpoint, q: q, role: role, offset: offset, limit: limit, token: token,
                verbose: verbose).perform
  else
    endpoint = "user/#{user_id}"
    Request.new(endpoint: endpoint, token: token, verbose: verbose).perform
  end
end