<PackageReference Include="Relativity.Identity.SDK" Version="2.6.2" />

IGroupManager

public interface IGroupManager : IDisposable
Provides methods to interact with groups at the admin level

Adds a list of users to a given group.

Adds a list of users to a given group and returns progress information.

Adds a list of users to a given group, provides a token used for canceling the operation, and returns progress information.

Adds a user to a given group.

Adds a user group to Relativity.

Task DeleteAsync(int groupID)

Deletes a user group.

Task DeleteAsync(int groupID, IProgress<ProgressReport> progress)

Deletes a user group and returns progress information.

Task DeleteAsync(int groupID, CancellationToken cancel, IProgress<ProgressReport> progress)

Deletes a user group, provides a token used for canceling the operation, and returns progress information.

Task<QueryResultSlim> QueryEligibleClients(QueryRequest request, int start, int length)

Query for Clients that are valid for the client property on group

Task<QueryResultSlim> QueryEligibleClients(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)

Query for Clients that are valid for the client property on group

Query for Clients that are valid for the client property on group

Task<QueryResultSlim> QueryEligibleUsersToAdd(QueryRequest request, int start, int length, int groupID)

Query for Users that are eligible to be members of a group.

Task<QueryResultSlim> QueryEligibleUsersToAdd(QueryRequest request, int start, int length, int groupID, IProgress<ProgressReport> progress)

Query for Users that are eligible to be members of a group.

Task<QueryResultSlim> QueryEligibleUsersToAdd(QueryRequest request, int start, int length, int groupID, CancellationToken cancel, IProgress<ProgressReport> progress)

Query for Users that are eligible to be members of a group.

Task<QueryResultSlim> QueryMembersAsync(QueryRequest request, int start, int length, int groupID)

Retrieves the list of users in a given group.

Task<QueryResultSlim> QueryMembersAsync(QueryRequest request, int start, int length, int groupID, IProgress<ProgressReport> progress)

Retrieves the list of users in a given group.

Task<QueryResultSlim> QueryMembersAsync(QueryRequest request, int start, int length, int groupID, CancellationToken cancel, IProgress<ProgressReport> progress)

Retrieves the list of users in a given group.

Task<GroupResponse> ReadAsync(int groupID, bool includeMetadata = false, bool includeActions = false)

Retrieves advanced metadata for a user group, including its name, associated client, and other properties.

Removes a list of users from a given group.

Removes a list of users from a given group and returns progress information.

Removes a list of users from a given group, provides a token used for canceling the operation, and returns progress information.

Removes a list of users from a given group.

Task<GroupResponse> UpdateAsync(int groupID, GroupRequest groupRequest)

Modifies the properties of a user group.

Task<GroupResponse> UpdateAsync(int groupID, GroupRequest groupRequest, IProgress<ProgressReport> progress)

Modifies the properties of a user group and returns progress information.

Task<GroupResponse> UpdateAsync(int groupID, GroupRequest groupRequest, CancellationToken cancel, IProgress<ProgressReport> progress)

Modifies the properties of a user group, provides a token used for canceling the operation, and returns progress information.

Task<GroupResponse> UpdateAsync(int groupID, GroupRequest groupRequest, DateTime lastModifiedOn)

Modifies the properties of a user group.

Task<GroupResponse> UpdateAsync(int groupID, GroupRequest groupRequest, DateTime lastModifiedOn, IProgress<ProgressReport> progress)

Modifies the properties of a user group and returns progress information.

Task<GroupResponse> UpdateAsync(int groupID, GroupRequest groupRequest, DateTime lastModifiedOn, CancellationToken cancel, IProgress<ProgressReport> progress)

Modifies the properties of a user group, provides a token used for canceling the operation, and returns progress information.