Interface IRole

The defined details for an individual role.

Namespace: PushTechnology.ClientInterface.Client.Features.Control.Clients.SecurityControl

Assembly: Diffusion.Client.dll

Syntax

public interface IRole

Properties

DefaultPathPermissions

Gets the read-only collection of default path permissions assigned to the role.

Declaration

IReadOnlyCollection<PathPermission> DefaultPathPermissions { get; }

Property Value

Type	Description
IReadOnlyCollection<PathPermission>	The set of default path permissions. This may be empty indicating that the role has no default path permissions assigned.

Remarks

Added in 6.5.

GlobalPermissions

Gets the read-only collection of global permissions assigned to the role.

Declaration

IReadOnlyCollection<GlobalPermission> GlobalPermissions { get; }

Property Value

Type	Description
IReadOnlyCollection<GlobalPermission>	The read-only collection of global permissions.

IncludedRoles

Gets a read-only collection of roles included within the role.

Declaration

IReadOnlyCollection<string> IncludedRoles { get; }

Property Value

Type	Description
IReadOnlyCollection<System.String>	The read-only collection of roles.

LockingPrincipal

Gets the name of the principal that has locked the current role and is able to update it.

Declaration

string LockingPrincipal { get; }

Property Value

Type	Description
System.String	The name of the principal that has locked the current role. null if the current role is not locked.

Name

Gets the role name.

Declaration

string Name { get; }

Property Value

Type	Description
System.String	The role name.

PathPermissions

Returns a read-only dictionary of topic path to topic permission assignments for the role.

Declaration

IReadOnlyDictionary<string, IReadOnlyCollection<PathPermission>> PathPermissions { get; }

Property Value

Type	Description
IReadOnlyDictionary<System.String, IReadOnlyCollection<PathPermission>>	The read-only dictionary of path permissions.

Remarks

Added in 6.5.