<PackageReference Include="Relativity.Server.Services.Interfaces.SDK" Version="5000.0.2" />

Relativity.Services.Interfaces.UserInfo.IUserInfoManager

public interface IUserInfoManager : IDisposable
Exposes the methods for retrieving information about Relativity users.
Task<UserResponse> CreateAsync(UserRequest userRequest)

Adds a single user to Relativity.

Task DeleteAsync(int userID)

Deletes a user.

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

Deletes a user.

Task DeleteAsync(int userID, CancellationToken cancel)

Deletes a user.

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

Deletes a user.

Task<List<DisplayableObjectIdentifier>> GetAvailableTypesAsync()

Gets all possible types for the User

Task<UserResponse> ReadAsync(int userID)

Retrieves all metadata for a user, including its Relativity access, name, email, and other properties.

Task<UserResponse> ReadAsync(int userID, bool includeMetadata, bool includeActions)

Retrieves advanced metadata for a user, including their Relativity access, name, email, and other properties.

Task<UserSettingResponse> ReadSettingsAsync()

Retrieves settings for the current user, including their name, email, and other properties.

Task<UserSettingResponse> ReadSettingsAsync(bool includeMetadata, bool includeActions)

Retrieves settings for the current user, including their name, email, and other properties.

Task<List<UserInfo>> RetrieveAll(int workspaceID)

Gets a list of all users and their information for a given workspace.

Task<UserInfoQueryResultSet> RetrieveUsersBy(int workspaceID, QueryRequest query, int start, int length)

Gets a list of users and their information, and supports filtering, ordering, and paging these results.

Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest)

Modifies the properties of a user.

Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest, IProgress<ProgressReport> progress)

Modifies the properties of a user.

Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest, CancellationToken cancel)

Modifies the properties of a user.

Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest, CancellationToken cancel, IProgress<ProgressReport> progress)

Modifies the properties of a user.

Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest, DateTime lastModifiedOn)

Modifies the properties of a user.

Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest, DateTime lastModifiedOn, IProgress<ProgressReport> progress)

Modifies the properties of a user.

Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest, DateTime lastModifiedOn, CancellationToken cancel)

Modifies the properties of a user.

Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest, DateTime lastModifiedOn, CancellationToken cancel, IProgress<ProgressReport> progress)

Modifies the properties of a user.

Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest)

Modifies the user setting properties of the current user.

Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest, IProgress<ProgressReport> progress)

Modifies the user setting properties of the current user.

Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest, CancellationToken cancel)

Modifies the user setting properties of the current user.

Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest, CancellationToken cancel, IProgress<ProgressReport> progress)

Modifies the user setting properties of the current user.

Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest, DateTime lastModifiedOn)

Modifies the user setting properties of the current user.

Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest, DateTime lastModifiedOn, IProgress<ProgressReport> progress)

Modifies the user setting properties of the current user.

Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest, DateTime lastModifiedOn, CancellationToken cancel)

Modifies the user setting properties of the current user.

Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest, DateTime lastModifiedOn, CancellationToken cancel, IProgress<ProgressReport> progress)

Modifies the user setting properties of the current user.