Interface IAdminPermissionService

Represents the admin permission API service.

Namespace: Relativity.Testing.Framework.Api.Services

Assembly: Relativity.Testing.Framework.Api.dll

Syntax

public interface IAdminPermissionService

Examples

_adminPermissionService = relativityFacade.Resolve<IAdminPermissionService>();

Methods

| Improve this Doc View Source

AddRemoveGroups(GroupSelector)

Sets the group seletor (added/removed groups) to and from admin permissions.

Declaration

void AddRemoveGroups(GroupSelector selector)

Parameters

Type	Name	Description
GroupSelector	selector	The group selector.

Examples

GroupSelector groupSelector = _adminPermissionService.GetAdminGroupSelector();
_adminPermissionService.AddRemoveGroups(groupSelector);

| Improve this Doc View Source

AddToGroups(Int32[])

Adds the group to admin permissions.

Declaration

void AddToGroups(params int[] groupIds)

Parameters

Type	Name	Description
System.Int32[]	groupIds	The collection of group IDs.

Examples

var groupIds = new int[] {123, 456, 789};
_adminPermissionService.AddToGroups(groupIds);

| Improve this Doc View Source

AddToGroups(String[])

Adds the group to admin permissions.

Declaration

void AddToGroups(params string[] groupNames)

Parameters

Type	Name	Description
System.String[]	groupNames	The collection of group Names.

Examples

var groupNames = new string[] {"group1"};
_adminPermissionService.AddToGroups(groupNames);

| Improve this Doc View Source

GetAdminGroupPermissions(Int32)

Gets the admin permissions for a group.

Declaration

GroupPermissions GetAdminGroupPermissions(int groupId)

Parameters

Type	Name	Description
System.Int32	groupId	The group ID.

Returns

Type	Description
GroupPermissions	An instance of GroupPermissions.

Examples

var groudId = 89743;
GroupPermissions groupPermissions = _adminPermissionService.GetAdminGroupPermissions(groudId);

| Improve this Doc View Source

GetAdminGroupPermissions(String)

Gets the admin permissions for a group.

Declaration

GroupPermissions GetAdminGroupPermissions(string groupName)

Parameters

Type	Name	Description
System.String	groupName	The group name.

Returns

Type	Description
GroupPermissions	An instance of GroupPermissions.

Examples

var groupName = "Group1";
GroupPermissions groupPermissions = _adminPermissionService.GetAdminGroupPermissions(groupName);

| Improve this Doc View Source

GetAdminGroupSelector()

Gets the admin group selector.

Declaration

GroupSelector GetAdminGroupSelector()

Returns

Type	Description
GroupSelector	The GroupSelector entity.

Examples

GroupSelector groupSelector = _adminPermissionService.GetAdminGroupSelector();

| Improve this Doc View Source

SetAdminGroupPermissions(GroupPermissions)

Sets the admin permissions for a group.

Declaration

void SetAdminGroupPermissions(GroupPermissions groupPermissions)

Parameters

Type	Name	Description
GroupPermissions	groupPermissions	The admin permissions for a group.

Examples

int workspaceId = 23123;
int groupId = 93452;
GroupPermissions groupPermissions = Facade.Resolve<IWorkspacePermissionService>().GetWorkspaceGroupPermissions(workspaceId, groupId);
_adminPermissionService.SetAdminGroupPermissions(groupPermissions);

| Improve this Doc View Source

SetAdminGroupPermissions(Int32, GroupPermissionsChangeset)

Sets the admin permissions for a group using changeset.

Declaration

void SetAdminGroupPermissions(int groupId, GroupPermissionsChangeset groupPermissionsChangeset)

Parameters

Type	Name	Description
System.Int32	groupId	The group ID.
GroupPermissionsChangeset	groupPermissionsChangeset	The group permissions changeset.

Examples

int groupId = 93452;
GroupPermissionsChangeset groupPermissionsChangeset = new GroupPermissionsChangeset();
_adminPermissionService.SetAdminGroupPermissions(groupId, groupPermissionsChangeset);

| Improve this Doc View Source

SetAdminGroupPermissions(Int32, Action<GroupPermissionsChangeset>)

Sets the admin permissions for a group using changeset setter.

Declaration

void SetAdminGroupPermissions(int groupId, Action<GroupPermissionsChangeset> groupPermissionsChangesetSetter)

Parameters

Type	Name	Description
System.Int32	groupId	The group ID.
System.Action<GroupPermissionsChangeset>	groupPermissionsChangesetSetter	An action to perform the changes to the group permissions.

Examples

const string permissionName = "Object Rule";
int groupId = 93452;
_adminPermissionService.SetAdminGroupPermissions(groupId, x => x.ObjectPermissions[permissionName].Set(ObjectPermissionKinds.ViewEdit));

| Improve this Doc View Source

SetAdminGroupPermissions(String, GroupPermissionsChangeset)

Sets the admin permissions for a group using changeset.

Declaration

void SetAdminGroupPermissions(string groupName, GroupPermissionsChangeset groupPermissionsChangeset)

Parameters

Type	Name	Description
System.String	groupName	The group name.
GroupPermissionsChangeset	groupPermissionsChangeset	The group permissions changeset.

Examples

string groupName = "Group1";
GroupPermissionsChangeset groupPermissionsChangeset = new GroupPermissionsChangeset();
_adminPermissionService.SetAdminGroupPermissions(groupName, groupPermissionsChangeset);

| Improve this Doc View Source

SetAdminGroupPermissions(String, Action<GroupPermissionsChangeset>)

Sets the admin permissions for a group using changeset setter.

Declaration

void SetAdminGroupPermissions(string groupName, Action<GroupPermissionsChangeset> groupPermissionsChangesetSetter)

Parameters

Type	Name	Description
System.String	groupName	The group name.
System.Action<GroupPermissionsChangeset>	groupPermissionsChangesetSetter	An action to perform the changes to the group permissions.

Examples

const string permissionName = "Object Rule";
string groupName = "Group1";
_adminPermissionService.SetAdminGroupPermissions(groupName, x => x.ObjectPermissions[permissionName].Set(ObjectPermissionKinds.ViewEdit));