Relativity.Services.Interfaces.Group.IGroupManager

IGroupManager

public interface IGroupManager : IDisposable

Documentation

Task AddMembersAsync(int groupID, List<ObjectIdentifier> users)

Adds a list of users to a given group.

Task AddMembersAsync(int groupID, List<ObjectIdentifier> users, IProgress<ProgressReport> progress)

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

Task AddMembersAsync(int groupID, List<ObjectIdentifier> users, CancellationToken cancel, IProgress<ProgressReport> progress)

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

Task AddMembersAsync(int groupID, ObjectIdentifier user)

Adds a user to a given group.

Task<GroupResponse> CreateAsync(GroupRequest groupRequest)

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<List<Action>> GetMassActionsAsync()

Retrieves a list of actions that are allowed for the mass operations.

Task<List<MassOperationResult>> MassAddUsersToGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups)

Task<List<MassOperationResult>> MassAddUsersToGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups, IProgress<ProgressReport> progress)

Task<List<MassOperationResult>> MassAddUsersToGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups, CancellationToken cancel, IProgress<ProgressReport> progress)

Task<List<MassOperationResult>> MassRemoveUsersFromGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups)

Task<List<MassOperationResult>> MassRemoveUsersFromGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups, IProgress<ProgressReport> progress)

Task<List<MassOperationResult>> MassRemoveUsersFromGroupsAsync(List<ObjectIdentifier> users, List<ObjectIdentifier> groups, CancellationToken cancel, IProgress<ProgressReport> progress)

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

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

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

Task<QueryResultSlim> QueryEligibleGroupsToAddUsersToAsync(QueryRequest request, int start, int length, ICollection<ObjectIdentifier> users)

Query for Groups that are eligible for adding at least one of specified users.

Task<QueryResultSlim> QueryEligibleGroupsToAddUsersToAsync(QueryRequest request, int start, int length, ICollection<ObjectIdentifier> users, IProgress<ProgressReport> progress)

Query for Groups that are eligible for adding at least one of specified users.

Task<QueryResultSlim> QueryEligibleGroupsToAddUsersToAsync(QueryRequest request, int start, int length, ICollection<ObjectIdentifier> users, CancellationToken cancel, IProgress<ProgressReport> progress)

Query for Groups that are eligible for adding at least one of specified users.

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> QueryGroupsByUserAsync(QueryRequest request, int start, int length, int userID)

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

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

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)

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

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

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

Task RemoveMembersAsync(int groupID, List<ObjectIdentifier> users)

Removes a list of users from a given group.

Task RemoveMembersAsync(int groupID, List<ObjectIdentifier> users, IProgress<ProgressReport> progress)

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

Task RemoveMembersAsync(int groupID, List<ObjectIdentifier> users, CancellationToken cancel, IProgress<ProgressReport> progress)

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

Task RemoveMembersAsync(int groupID, ObjectIdentifier user)

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.