JavaScript Client SDK
Class Index | File Index

Classes


Class User

The User class represents an authenticated user.

Access this object by calling:

var myProps = AK.Session.current.getUser();

Defined in: User.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
User(session)
Creates a new user object.
Method Summary
Method Attributes Method Name and Description
 
Gets the credentials manager for the user.
 
Gets the id of the user.
 
getInfo(key)
Gets information about the user stored under the specified key.
 
Gets the permissions manager object for the user.
 
Gets the realm name of the user.
Class Detail
User(session)
Creates a new user object.
Parameters:
{Session} session
The session the user belongs to.
Since:
1.0
Method Detail
{CredentialsManager} getCredentialsManager()
Gets the credentials manager for the user.
Since:
1.0
Returns:
{CredentialsManager} The user's credentials manager.
{String} getId()
Gets the id of the user.
Since:
1.0
Returns:
{String} The user's id.
{String} getInfo(key)
Gets information about the user stored under the specified key.
Parameters:
{String} key
The info key to retrieve the value for.
Since:
1.0
Returns:
{String} The info stored under the specified key.
{Permissions} getPermissions()
Gets the permissions manager object for the user.
Since:
1.0
Returns:
{Permissions} The user's Permissions object.
{String} getRealm()
Gets the realm name of the user.
Since:
1.0
Returns:
{String} The user's realm name.

©2013 Verivo Software, Inc. Documentation generated by JsDoc Toolkit 2.4.0 on Mon Apr 27 2015 15:06:21 GMT-0400 (EDT)