UserInfo

Overview

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

Location

 

constructor Create  reintroduce overload virtual    (declared in TROComplexType)

Creates a new instance.

constructor Create

constructor Create (TCollection)  overload override    (declared in TROComplexType)

Creates a new instance with given parameter.

constructor Create(aCollection: TCollection)

Parameters:

  • aCollection: collection

Assign  override

Copies data from a given source.

procedure Assign(aSource: TPersistent)

Parameters:

  • aSource: Instance whose properties will be copied

AssignTo  override    (declared in TROComplexType)

Copies the properties of an object to a destination object.

procedure AssignTo(iDest: TPersistent)

Parameters:

  • iDest: destination object.

Attributes

Gets or sets an array of custom user attributes.

property Attributes: VariantArray read write

Clone    (declared in TROComplexType)

Creates and returns a second copy of the struct.

The new instance will be a deep copy of the original struct, all nested members that are arrays, structs or binaries will be duplicated as part of the cloning process, so that the new instance and its members will be completely independent from the original class.

function Clone: TROComplexType

ContentAsString    (declared in TROComplexType)

Returns the structure of the type in a string format.

property ContentAsString: string read write

ContentAsXml    (declared in TROComplexType)

Returns the XML structure of the type in a string format.

property ContentAsXml: ROUTF8String read write

FieldCount    (declared in TROComplexType)

property FieldCount: integer read write

FieldInfo    (declared in TROComplexType)

property FieldInfo[Index: integer]: PTypeInfo read write

FieldName    (declared in TROComplexType)

property FieldName[Index: integer]: string read write

FreeInternalProperties  protected override

procedure FreeInternalProperties

GetAttributeCount  virtual    (declared in TROComplexType)

Returns the number of custom attributes defined for the class.

class function GetAttributeCount: Integer

GetAttributeName  virtual    (declared in TROComplexType)

Returns the name of custom attribute defined for the class, with the specified index.

class function GetAttributeName(aIndex: Integer): string

Parameters:

  • aIndex: The index of attribute.

GetAttributeValue  virtual    (declared in TROComplexType)

Returns the value of custom attribute defined for the class, with the specified index.

class function GetAttributeValue(aIndex: Integer): string

Parameters:

  • aIndex: The index of attribute.

GetContentAsXml  protected    (declared in TROComplexType)

Returns the xml structure of the struct in a string format.

function GetContentAsXml: ROUTF8String

GetContentAsXml2  protected virtual    (declared in TROComplexType)

procedure GetContentAsXml2(const aXMLNode: IUnknown)

Parameters:

  • aXMLNode:

GetFieldNames    (declared in TROComplexType)

procedure GetFieldNames(aList: TStrings)

Parameters:

  • aList:

GetFieldValue    (declared in TROComplexType)

function GetFieldValue(const aFieldName: string): Variant

Parameters:

  • aFieldName:

int_Attributes  protected

Returns Attributes.

property int_Attributes: VariantArray read write

int_Privileges  protected

Returns Privileges.

property int_Privileges: StringArray read write

int_UserData  protected

Returns UserData.

property int_UserData: Binary read write

Privileges

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 Privileges: StringArray read write

ReadComplex  override

Deserializes current class instance using provided serializer.

procedure ReadComplex(aSerializer: TObject)

Parameters:


SessionID

Gets or sets the user's session Id.

property SessionID: ROUTF8String read write

SetFieldValue    (declared in TROComplexType)

procedure SetFieldValue(const aFieldName: string; const aValue: Variant)

Parameters:

  • aFieldName:
  • aValue:

SmartAssign    (declared in TROComplexType)

Copies specific data from a given source.

procedure SmartAssign(Source: TPersistent; TypeKinds: TTypeKinds)

Parameters:

  • Source: Instance whose properties will be copied
  • TypeKinds: Specifies which properties should be copied

TryGetAttribute    (declared in TROComplexType)

class function TryGetAttribute(aName: string; out aValue: string): Boolean

Parameters:

  • aName:
  • aValue:

UserData

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

property UserData: Binary read write

UserID

Gets or sets user Id, for example full user name.

property UserID: ROUTF8String read write

WriteComplex  override

Serializes current class instance using provided serializer.

procedure WriteComplex(aSerializer: TObject)

Parameters:

 

Attributes

Gets or sets an array of custom user attributes.

property Attributes: VariantArray read write

ContentAsString    (declared in TROComplexType)

Returns the structure of the type in a string format.

property ContentAsString: string read write

ContentAsXml    (declared in TROComplexType)

Returns the XML structure of the type in a string format.

property ContentAsXml: ROUTF8String read write

FieldCount    (declared in TROComplexType)

property FieldCount: integer read write

FieldInfo    (declared in TROComplexType)

property FieldInfo[Index: integer]: PTypeInfo read write

FieldName    (declared in TROComplexType)

property FieldName[Index: integer]: string read write

int_Attributes  protected

Returns Attributes.

property int_Attributes: VariantArray read write

int_Privileges  protected

Returns Privileges.

property int_Privileges: StringArray read write

int_UserData  protected

Returns UserData.

property int_UserData: Binary read write

Privileges

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 Privileges: StringArray read write

SessionID

Gets or sets the user's session Id.

property SessionID: ROUTF8String read write

UserData

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

property UserData: Binary read write

UserID

Gets or sets user Id, for example full user name.

property UserID: ROUTF8String read write

 

GetAttributeCount  virtual    (declared in TROComplexType)

Returns the number of custom attributes defined for the class.

class function GetAttributeCount: Integer

GetAttributeName  virtual    (declared in TROComplexType)

Returns the name of custom attribute defined for the class, with the specified index.

class function GetAttributeName(aIndex: Integer): string

Parameters:

  • aIndex: The index of attribute.

GetAttributeValue  virtual    (declared in TROComplexType)

Returns the value of custom attribute defined for the class, with the specified index.

class function GetAttributeValue(aIndex: Integer): string

Parameters:

  • aIndex: The index of attribute.

TryGetAttribute    (declared in TROComplexType)

class function TryGetAttribute(aName: string; out aValue: string): Boolean

Parameters:

  • aName:
  • aValue:

 

constructor Create  reintroduce overload virtual    (declared in TROComplexType)

Creates a new instance.

constructor Create

constructor Create (TCollection)  overload override    (declared in TROComplexType)

Creates a new instance with given parameter.

constructor Create(aCollection: TCollection)

Parameters:

  • aCollection: collection

Assign  override

Copies data from a given source.

procedure Assign(aSource: TPersistent)

Parameters:

  • aSource: Instance whose properties will be copied

AssignTo  override    (declared in TROComplexType)

Copies the properties of an object to a destination object.

procedure AssignTo(iDest: TPersistent)

Parameters:

  • iDest: destination object.

Clone    (declared in TROComplexType)

Creates and returns a second copy of the struct.

The new instance will be a deep copy of the original struct, all nested members that are arrays, structs or binaries will be duplicated as part of the cloning process, so that the new instance and its members will be completely independent from the original class.

function Clone: TROComplexType

FreeInternalProperties  protected override

procedure FreeInternalProperties

GetContentAsXml  protected    (declared in TROComplexType)

Returns the xml structure of the struct in a string format.

function GetContentAsXml: ROUTF8String

GetContentAsXml2  protected virtual    (declared in TROComplexType)

procedure GetContentAsXml2(const aXMLNode: IUnknown)

Parameters:

  • aXMLNode:

GetFieldNames    (declared in TROComplexType)

procedure GetFieldNames(aList: TStrings)

Parameters:

  • aList:

GetFieldValue    (declared in TROComplexType)

function GetFieldValue(const aFieldName: string): Variant

Parameters:

  • aFieldName:

ReadComplex  override

Deserializes current class instance using provided serializer.

procedure ReadComplex(aSerializer: TObject)

Parameters:


SetFieldValue    (declared in TROComplexType)

procedure SetFieldValue(const aFieldName: string; const aValue: Variant)

Parameters:

  • aFieldName:
  • aValue:

SmartAssign    (declared in TROComplexType)

Copies specific data from a given source.

procedure SmartAssign(Source: TPersistent; TypeKinds: TTypeKinds)

Parameters:

  • Source: Instance whose properties will be copied
  • TypeKinds: Specifies which properties should be copied

WriteComplex  override

Serializes current class instance using provided serializer.

procedure WriteComplex(aSerializer: TObject)

Parameters:

See Also