IOS Client SDK
AKUser Class Reference

The AKUser class contains information about an authentication user. More...

#import <AKUser.h>

Inheritance diagram for AKUser:
Inheritance graph

Instance Methods

(NSString *) - infoForKey:
 Returns the value associated with a given user info key. More...
 

Properties

AKCredentialsManagercredentials
 The AKCredentialsManager instance associated with the user. More...
 
NSString * ID
 The user's identifier. More...
 
AKPermissionspermissions
 The AKPermissions instance associated with the user. More...
 
NSString * realm
 The authenticating realm, if available, nil is returned otherwise. More...
 

Detailed Description

The AKUser class contains information about an authentication user.

An object of type AKUser is automatically create on a succesful log in through a call to one of the log in methods of the AKSession class.

The information about the user always includes the username and the name of the authentication realm. Other information, including first name, last name, and full name, is only available if that information is available in the authentication realm, such as Active Directory. Otherwise, that information is omitted. As part of configuring the authentication realm, you specify the location of this information in the realm.

See Also
AKSession
Authenticating Users
Version
1.0

Method Documentation

- (NSString *) infoForKey: (NSString *)  key

Returns the value associated with a given user info key.

Parameters
keyNSString used to retrieve the info field.
Returns
NSString containing the value for a given user info key.
Version
1.0

Property Documentation

- (AKCredentialsManager*) credentials
readnonatomicassign

The AKCredentialsManager instance associated with the user.

The AKCredentialsManager instance is empty on log in. Use the refreshAll: or refreshAllSync: methods on the AKCredentialsManager instance to initialize it.

Version
1.0
- (NSString*) ID
readnonatomicassign

The user's identifier.

Version
1.0
- (AKPermissions*) permissions
readnonatomicassign

The AKPermissions instance associated with the user.

Version
1.0
- (NSString*) realm
readnonatomicassign

The authenticating realm, if available, nil is returned otherwise.

Version
1.0