Android Client SDK
com.verivo.akula.AKUser Interface Reference

The AKUser class represents an authenticated user. More...

Public Member Functions

AKCredentialsManager getCredentialsManager ()
 Get the AKCredentialsManager for this user. More...
 
String getId ()
 Get the ID of this user. More...
 
String getInfo (String key)
 Get an attribute of this user based on a key. More...
 
AKPermissions getPermissions ()
 Get the AKPermissions object for this user. More...
 
String getRealm ()
 Get the authentication realm this user belongs to. More...
 

Detailed Description

The AKUser class represents an authenticated user.

An object of type AKUser is automatically create on a successful log in through a call to AKSession.login().

The AKUser object always contains the user's id and the name of the authentication realm. Any other information may be provided by the realm and is stored in the AKUser object as key/value pairs.

See Also
AKSession
User Authentication

Member Function Documentation

AKCredentialsManager com.verivo.akula.AKUser.getCredentialsManager ( )

Get the AKCredentialsManager for this user.

Returns
The AKCredentialsManager object. The AKCredentialsManager is initially empty. Use AKCredentialsManager.refreshAll() to initialize it.
Version
1.0
String com.verivo.akula.AKUser.getId ( )

Get the ID of this user.

Returns
The ID as a String.
Version
1.0
String com.verivo.akula.AKUser.getInfo ( String  key)

Get an attribute of this user based on a key.

Parameters
keyThe name of the attribute as returned by the realm.
Returns
An attribute of the user as a String, or null if it is not available.
Version
1.0
AKPermissions com.verivo.akula.AKUser.getPermissions ( )

Get the AKPermissions object for this user.

Returns
The AKPermsisions object.
Version
1.0
String com.verivo.akula.AKUser.getRealm ( )

Get the authentication realm this user belongs to.

Returns
The authentication realm as a String.
Version
1.0