IUserInfoManager Interface

Relativity Services API
Exposes the methods for retrieving information about Relativity users.

Namespace:  Relativity.Services.Interfaces.UserInfo
Assembly:  Relativity.Services.Interfaces (in Relativity.Services.Interfaces.dll) Version: 13.3.1.1 045207d562027f7bb0eaa843477ebb7cba5b9f0a
Syntax

public interface IUserInfoManager : IDisposable

The IUserInfoManager type exposes the following members.

Methods

  NameDescription
Public methodCreateAsync
Adds a single user to Relativity.
Public methodDeleteAsync(Int32)
Deletes a user.
Public methodDeleteAsync(Int32, IProgressProgressReport)
Deletes a user.
Public methodDeleteAsync(Int32, CancellationToken)
Deletes a user.
Public methodDeleteAsync(Int32, CancellationToken, IProgressProgressReport)
Deletes a user.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodGetAvailableTypesAsync
Gets all possible types for the User
Public methodReadAsync(Int32)
Retrieves all metadata for a user, including its Relativity access, name, email, and other properties.
Public methodReadAsync(Int32, Boolean, Boolean)
Retrieves advanced metadata for a user, including their Relativity access, name, email, and other properties.
Public methodReadSettingsAsync
Retrieves settings for the current user, including their name, email, and other properties.
Public methodReadSettingsAsync(Boolean, Boolean)
Retrieves settings for the current user, including their name, email, and other properties.
Public methodRetrieveAll
Gets a list of all users and their information for a given workspace.
Public methodRetrieveUsersBy
Gets a list of users and their information, and supports filtering, ordering, and paging these results.
Public methodUpdateAsync(Int32, UserRequest)
Modifies the properties of a user.
Public methodUpdateAsync(Int32, UserRequest, DateTime)
Modifies the properties of a user.
Public methodUpdateAsync(Int32, UserRequest, IProgressProgressReport)
Modifies the properties of a user.
Public methodUpdateAsync(Int32, UserRequest, CancellationToken)
Modifies the properties of a user.
Public methodUpdateAsync(Int32, UserRequest, DateTime, IProgressProgressReport)
Modifies the properties of a user.
Public methodUpdateAsync(Int32, UserRequest, DateTime, CancellationToken)
Modifies the properties of a user.
Public methodUpdateAsync(Int32, UserRequest, CancellationToken, IProgressProgressReport)
Modifies the properties of a user.
Public methodUpdateAsync(Int32, UserRequest, DateTime, CancellationToken, IProgressProgressReport)
Modifies the properties of a user.
Public methodUpdateSettingsAsync(UserSettingRequest)
Modifies the user setting properties of the current user.
Public methodUpdateSettingsAsync(UserSettingRequest, DateTime)
Modifies the user setting properties of the current user.
Public methodUpdateSettingsAsync(UserSettingRequest, IProgressProgressReport)
Modifies the user setting properties of the current user.
Public methodUpdateSettingsAsync(UserSettingRequest, CancellationToken)
Modifies the user setting properties of the current user.
Public methodUpdateSettingsAsync(UserSettingRequest, DateTime, IProgressProgressReport)
Modifies the user setting properties of the current user.
Public methodUpdateSettingsAsync(UserSettingRequest, DateTime, CancellationToken)
Modifies the user setting properties of the current user.
Public methodUpdateSettingsAsync(UserSettingRequest, CancellationToken, IProgressProgressReport)
Modifies the user setting properties of the current user.
Public methodUpdateSettingsAsync(UserSettingRequest, DateTime, CancellationToken, IProgressProgressReport)
Modifies the user setting properties of the current user.
Top
See Also

Reference