Exago .NET API Documentation
Role Class Members
Properties  Methods 

WebReports.Api.Roles Namespace : Role Class

The following tables list the members exposed by Role.

Public Constructors
Public ConstructorCreate a new Role that is a copy of the Role object passed as an argument.  
Public Properties
Public PropertyReturns the WebReports.Api.Roles.General object, that holds all of the Role's General Settings values. Use those values to make specific changes to the environment that should be Role specific.  
Public PropertyThe ID, or name of the Role.  
Public Property

Returns True if this Role is the currently active role, or False if not.

If setting to True, this Role will be set as the active Role and all of its General Settings will be applied to the environment, by calling WebReports.Api.Common.General SetActiveRole()

If setting to False, this Role will be unset as the active Role, but the General Settings applied by the role remain active.

Public PropertyReturns the WebReports.Api.Roles.Security object, that holds all of the Role's Security Settings (Folder, Data Object, Data Object Rows).  
Public Methods
Public MethodOverloaded. 

Make this Role the active one. If applicable (see overload list below) the General Settings in the role will be applied.

Once a role is activated, the changes made by activating it cannot be undone with the API, even if calling the Deactivate Method. The only way to completely undo the role's changes is to discard the API object and create a new one.

See Also


Role Class
WebReports.Api.Roles Namespace