Interface IRole

Namespace

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

Assembly

Diffusion.Client.dll

The defined details for an individual role.

public interface IRole

Properties

DefaultPathPermissions

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

IReadOnlyCollection<PathPermission> DefaultPathPermissions { get; }

Property Value

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.

IReadOnlyCollection<GlobalPermission> GlobalPermissions { get; }

Property Value

IReadOnlyCollection<GlobalPermission>

The read-only collection of global permissions.

IncludedRoles

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

IReadOnlyCollection<string> IncludedRoles { get; }

Property Value

IReadOnlyCollection<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.

string LockingPrincipal { get; }

Property Value

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.

string Name { get; }

Property Value

string

The role name.

PathPermissions

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

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

Property Value

IReadOnlyDictionary<string, IReadOnlyCollection<PathPermission>>

The read-only dictionary of path permissions.

Remarks

Added in 6.5.