UserInfo

Overview

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

Location


 

assignFrom: assignFrom:(ROComplexType *)

Configures instance of the UserInfo class according to given source

- (void) assignFrom:(ROComplexType *)aValue

Parameters:

  • aValue:

assignFrom: assignFrom:(nonnull ROComplexType *)     (declared in ROComplexType)

- (void) assignFrom:(nonnull ROComplexType *)source

Parameters:

  • source:

Attributes  nonatomic

Gets or sets an array of custom user attributes.

@property (nonatomic) VariantArray *Attributes

deepCopyWithZone:  deprecated    (declared in ROComplexType)

- (nullable id) deepCopyWithZone:(nullable NSZone *)zone

Parameters:

  • zone:

getAttributeValue:    (declared in ROComplexType)

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

Parameters:

  • aName:

Privileges  nonatomic

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 (nonatomic) StringArray *Privileges

readFromMessage:withName: readFromMessage:(nonnull ROMessage *) withName:(nullable NSString *)     (declared in ROComplexType)

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

Parameters:

  • aMessage:
  • aName:

readFromMessage:withName: readFromMessage:(ROMessage *) withName:(NSString *)

Metod deserializes UserInfo with given name from given message

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

Parameters:

  • aMessage:
  • aName:

SessionID  nonatomic

Gets or sets the user's session Id.

@property (nonatomic) NSString *SessionID

UserData  nonatomic

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

@property (nonatomic) NSData *UserData

UserID  nonatomic

Gets or sets user identifier.

@property (nonatomic) NSString *UserID

writeToMessage:withName: writeToMessage:(nonnull ROMessage *) withName:(nullable NSString *)     (declared in ROComplexType)

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

Parameters:

  • aMessage:
  • aName:

writeToMessage:withName: writeToMessage:(ROMessage *) withName:(NSString *)

Metod serializes UserInfo with given name into given message.

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

Parameters:

  • aMessage:
  • aName:

 

Attributes  nonatomic

Gets or sets an array of custom user attributes.

@property (nonatomic) VariantArray *Attributes

Privileges  nonatomic

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 (nonatomic) StringArray *Privileges

SessionID  nonatomic

Gets or sets the user's session Id.

@property (nonatomic) NSString *SessionID

UserData  nonatomic

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

@property (nonatomic) NSData *UserData

UserID  nonatomic

Gets or sets user identifier.

@property (nonatomic) NSString *UserID

 

getAttributeValue:    (declared in ROComplexType)

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

Parameters:

  • aName:

 

assignFrom: assignFrom:(ROComplexType *)

Configures instance of the UserInfo class according to given source

- (void) assignFrom:(ROComplexType *)aValue

Parameters:

  • aValue:

assignFrom: assignFrom:(nonnull ROComplexType *)     (declared in ROComplexType)

- (void) assignFrom:(nonnull ROComplexType *)source

Parameters:

  • source:

deepCopyWithZone:  deprecated    (declared in ROComplexType)

- (nullable id) deepCopyWithZone:(nullable NSZone *)zone

Parameters:

  • zone:

readFromMessage:withName: readFromMessage:(nonnull ROMessage *) withName:(nullable NSString *)     (declared in ROComplexType)

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

Parameters:

  • aMessage:
  • aName:

readFromMessage:withName: readFromMessage:(ROMessage *) withName:(NSString *)

Metod deserializes UserInfo with given name from given message

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

Parameters:

  • aMessage:
  • aName:

writeToMessage:withName: writeToMessage:(nonnull ROMessage *) withName:(nullable NSString *)     (declared in ROComplexType)

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

Parameters:

  • aMessage:
  • aName:

writeToMessage:withName: writeToMessage:(ROMessage *) withName:(NSString *)

Metod serializes UserInfo with given name into given message.

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

Parameters:

  • aMessage:
  • aName: