UserInfo

Overview

The UserInfo class can be used to provide additional information about user being authenticating back to the client application.

Location

 

assignFrom:

Configures instance of the UserInfo class according to given source

- (void) assignFrom:(ROComplexType *)aSource

Parameters:

  • aSource:

Attributes  retain

Gets or sets an array of custom user attributes.

@property (retain) VariantArray *Attributes

deepCopyWithZone:  deprecated    (declared in ROComplexType)

- (id) deepCopyWithZone:(NSZone *)zone

Parameters:

  • zone:

getAttributeValue:    (declared in ROComplexType)

+ (NSString *) getAttributeValue:(NSString *)aName

Parameters:

  • aName:

init

Initializes instance of the UserInfo

- (id) init

Privileges  retain

Gets or sets a list of user access privileges. It is up to the client application to interpret these rules and to use them.

@property (retain) StringArray *Privileges

readFromMessage:withName:

Metod deserializes UserInfo with given name from given message

- (void) readFromMessage:(ROMessage *)aMessage withName:(NSString *)aName

Parameters:

  • aMessage:
  • aName:

SessionID  retain

Gets or sets the user's session Id.

@property (retain) NSString *SessionID

UserData  retain

Gets or sets a blob containing user information. For example this field can store user's photo etc.

@property (retain) NSData *UserData

UserID  retain

Gets or sets user identifier.

@property (retain) NSString *UserID

writeToMessage:withName:

Metod serializes UserInfo with given name into given message.

- (void) writeToMessage:(ROMessage *)aMessage withName:(NSString *)aName

Parameters:

  • aMessage:
  • aName:

 

Attributes  retain

Gets or sets an array of custom user attributes.

@property (retain) VariantArray *Attributes

Privileges  retain

Gets or sets a list of user access privileges. It is up to the client application to interpret these rules and to use them.

@property (retain) StringArray *Privileges

SessionID  retain

Gets or sets the user's session Id.

@property (retain) NSString *SessionID

UserData  retain

Gets or sets a blob containing user information. For example this field can store user's photo etc.

@property (retain) NSData *UserData

UserID  retain

Gets or sets user identifier.

@property (retain) NSString *UserID

 

getAttributeValue:    (declared in ROComplexType)

+ (NSString *) getAttributeValue:(NSString *)aName

Parameters:

  • aName:

 

assignFrom:

Configures instance of the UserInfo class according to given source

- (void) assignFrom:(ROComplexType *)aSource

Parameters:

  • aSource:

deepCopyWithZone:  deprecated    (declared in ROComplexType)

- (id) deepCopyWithZone:(NSZone *)zone

Parameters:

  • zone:

init

Initializes instance of the UserInfo

- (id) init

readFromMessage:withName:

Metod deserializes UserInfo with given name from given message

- (void) readFromMessage:(ROMessage *)aMessage withName:(NSString *)aName

Parameters:

  • aMessage:
  • aName:

writeToMessage:withName:

Metod serializes UserInfo with given name into given message.

- (void) writeToMessage:(ROMessage *)aMessage withName:(NSString *)aName

Parameters:

  • aMessage:
  • aName:

See Also