Interface IPermissionService

Represents the permission API service.

Namespace: Relativity.Testing.Framework.Api.Services

Assembly: Relativity.Testing.Framework.Api.dll

Syntax

public interface IPermissionService

Examples

IPermissionService _permissionService = relativityFacade.Resolve<IPermissionService>();

Properties

| Improve this Doc View Source

AdminPermissionService

Gets the admin permission API service.

Declaration

IAdminPermissionService AdminPermissionService { get; }

Property Value

Type	Description
IAdminPermissionService

| Improve this Doc View Source

ItemPermissionService

Gets the item permission API service.

Declaration

IItemPermissionService ItemPermissionService { get; }

Property Value

Type	Description
IItemPermissionService

| Improve this Doc View Source

WorkspacePermissionService

Gets the workspace permission API service.

Declaration

IWorkspacePermissionService WorkspacePermissionService { get; }

Property Value

Type	Description
IWorkspacePermissionService

Methods

| Improve this Doc View Source

GetAdminGroupUsers(Int32)

Gets the users from a group at the admin case level.

Declaration

List<NamedArtifact> GetAdminGroupUsers(int groupId)

Parameters

Type	Name	Description
System.Int32	groupId	The group id.

Returns

Type	Description
System.Collections.Generic.List<NamedArtifact>	A list of NamedArtifacts.

Examples

int groupID = 654321;

List<NamedArtifact> adminUsers = _permissionService.GetAdminGroupUsers(groupID);

| Improve this Doc View Source

GetAdminGroupUsers(String)

Gets the users from a group at the admin case level.

Declaration

List<NamedArtifact> GetAdminGroupUsers(string groupName)

Parameters

Type	Name	Description
System.String	groupName	The group Name.

Returns

Type	Description
System.Collections.Generic.List<NamedArtifact>	A list of NamedArtifacts.

Examples

string groupName = "Group name;

List<NamedArtifact> adminUsers = _permissionService.GetAdminGroupUsers(groupName);

| Improve this Doc View Source

GetWorkspaceGroupUsers(Int32, Int32)

Gets the users from the group with workspace permissions.

Declaration

List<NamedArtifact> GetWorkspaceGroupUsers(int workspaceId, int groupId)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	groupId	The group id.

Returns

Type	Description
System.Collections.Generic.List<NamedArtifact>	A list of NamedArtifacts.

Examples

int workspaceID = 123456;
int groupID = 654321;

List<NamedArtifact> workspaceUsers = _permissionService.GetWorkspaceGroupUsers(workspaceID, groupID);

| Improve this Doc View Source

GetWorkspaceGroupUsers(Int32, String)

Gets the users from the group with workspace permissions.

Declaration

List<NamedArtifact> GetWorkspaceGroupUsers(int workspaceId, string groupName)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.String	groupName	The group Name.

Returns

Type	Description
System.Collections.Generic.List<NamedArtifact>	A list of NamedArtifacts.

Examples

int workspaceID = 123456;
string groupName = "Group name;

List<NamedArtifact> workspaceUsers = _permissionService.GetWorkspaceGroupUsers(workspaceID, groupName);