The DataObject class can allow or deny access to specific Data Objects for a particular user session.
A DataObject object has the following property:
A DataObject object has no available methods.
This collection should not be instantiated; there is a single DataObjectCollection object that is accessed through the DataObjects property of the Security object.
The DataObjectCollection has the following property:
The DataObjects property of a Security object has the following method:
GetDataObject(string dataObjectName)
Description |
Returns the DataObject object or null if not found. |
NewDataObject()
Description |
Returns a new DataObject object and adds it to the collection. |
Remarks |
The returned DataObject object needs to have all of its properties filled or an error will occur. |
The DataObjectRow class can set Row Level filters to Data Objects for a particular user session.
A DataObjectRow object has the following properties:
A DataObjectRow object has no available methods.
This collection should not be instantiated; there is a single DataObjectRowCollection object that is accessed through the DataObjectRoles property of the Security object.
The DataObjectRoles property of a Security object has the following method
GetDataObject(string dataObjectRowName)
Description |
Returns the DataObjectRow object or null if not found. |
NewDataObjectRow()
Description |
Returns a new DataObjectRow object and adds it to the collection. |
Remarks |
The returned DataObjectRow object needs to have all of its properties filled or an error will occur. |
The Folder class is used to allow or deny access to folders or sets folders as execute-only for a particular user session.
A Folder object has the following properties:
A Folder object has no available methods.
This collection should not be instantiated; there is a single FolderCollection object that is accessed through the Folders property of the Security object.
A FolderCollection object has the following property:
The Folders property of a Security object has the following method:
GetFolder(string folderName)
Description |
Returns the Folder object or null if not found. |
NewFolder()
Description |
Returns a new Folder object and adds it to the collection. |
Remarks |
The returned Folder object needs to have all of its properties filled or an error will occur. |
The General class is utilized to overwrite the General Settings of the Administration Console. This collection should not be instantiated; there is a single General object that is accessed through the General property of the Role object.
The General property of the Role object has the following properties:
The General property of the Role object does not have any available methods.
The Parameter class is used to create and modify Parameters.
A Parameter object has the following properties:
Note: Parameter names are case sensitive.
A Parameter object has the following available methods:
Constructor(string paramId, string paramValue)
Description |
Instantiates a Parameter object with the specified Id and Value. |
This collection should not be instantiated; there is a single ParameterCollection object that is accessed through the Parameters property of the Api object.
The Parameter property of an Api object has the following method:
GetParameter(string parameterId)
Description |
Returns the Parameter object or null if not found. |
The Role class contains all of the information concerning General and Security parameters. A Role can be created at runtime and used for a single session or loaded from the roles that have been created through the Admin Console. For more information see Roles.
This collection should not be instantiated; there is a single RoleCollection object that is accessed through the Role property of the Api object.
A Role object may have the following properties:
A Role object has the following methods available:
Activate()
Description |
pre-v2019.1: Sets the Role to active. v2019.1+: Sets the Active Role Id value equal to the Role. Setting the optional parameter to True will activate the Role. Note: For more information regarding changes made to Roles for version v2019.1+, please see the Roles article. |
This collection should not be instantiated; there is a single RoleCollection object that is accessed through the Roles property of the Api object.
A RoleCollection object may have the following properties:
A RoleCollection object has the following methods available:
GetRole(string roleId)
Description |
Returns the Role object or null if not found. |
NewRole()
Description |
Returns a new Role object and adds it to the collection. |
Remarks |
The returned Role object needs to have all of its properties filled or an error will occur. |
FindActive()
Description |
Returns the Role marked as active from the loaded configuration. Should be used with older, non-static configuration architectures only. |
The Security class contains all of the security parameters for a user session.
This collection should not be instantiated; there is a single Security object that is accessed through the Security property of the Role object.
The Security object has the following properties:
There are no available methods for a Security object.