Diffusion .NET Client Library  6.1.5
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
PushTechnology.ClientInterface.Client.Features.Control.Clients.SecurityControl.IRole Interface Reference

Encapsulates the defined details for an individual role. More...

Inherited by PushTechnology.ClientInterface.Client.Features.Impl.Role.

Properties

string Name [get]
 Returns the role name. More...
 
IReadOnlyCollection
< GlobalPermission
GlobalPermissions [get]
 Returns the set of global permissions assigned to the role. This may be empty indicating that the role has no global permissions assigned. More...
 
IReadOnlyCollection
< TopicPermission
DefaultTopicPermissions [get]
 Returns the set of default topic permissions assigned to the role. This may be empty indicating that the role has no default topic permissions assigned. More...
 
IReadOnlyDictionary< string,
List< TopicPermission > > 
TopicPermissions [get]
 Returns a dictionary of topic path to topic permissions assignments for the role. The returned map may be empty if there are no specific topic assignments for the role. Any individual set of permissions may also be empty if the role has explicitly had no permissions specified for the topic. More...
 
IReadOnlyCollection< string > IncludedRoles [get]
 Returns a set of roles included within the role. This may be empty if the role includes no other roles. More...
 

Detailed Description

Encapsulates the defined details for an individual role.

Property Documentation

IReadOnlyCollection<TopicPermission> PushTechnology.ClientInterface.Client.Features.Control.Clients.SecurityControl.IRole.DefaultTopicPermissions
get

Returns the set of default topic permissions assigned to the role. This may be empty indicating that the role has no default topic permissions assigned.

IReadOnlyCollection<GlobalPermission> PushTechnology.ClientInterface.Client.Features.Control.Clients.SecurityControl.IRole.GlobalPermissions
get

Returns the set of global permissions assigned to the role. This may be empty indicating that the role has no global permissions assigned.

IReadOnlyCollection<string> PushTechnology.ClientInterface.Client.Features.Control.Clients.SecurityControl.IRole.IncludedRoles
get

Returns a set of roles included within the role. This may be empty if the role includes no other roles.

string PushTechnology.ClientInterface.Client.Features.Control.Clients.SecurityControl.IRole.Name
get

Returns the role name.

IReadOnlyDictionary<string, List<TopicPermission> > PushTechnology.ClientInterface.Client.Features.Control.Clients.SecurityControl.IRole.TopicPermissions
get

Returns a dictionary of topic path to topic permissions assignments for the role. The returned map may be empty if there are no specific topic assignments for the role. Any individual set of permissions may also be empty if the role has explicitly had no permissions specified for the topic.


The documentation for this interface was generated from the following file: