UserRepository Class

Relativity Services API

Note: This API is now obsolete.

The UserRepository contains methods which apply to Users.
Inheritance Hierarchy

SystemObject
  kCura.Relativity.Client.RepositoriesGenericRepositoryUser
    kCura.Relativity.Client.RepositoriesUserRepository

Namespace:  kCura.Relativity.Client.Repositories
Assembly:  kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 17.0.1.1 588f15fd7550dbf54835f3417a0142d4ea37dbb5
Syntax

[ObsoleteAttribute("Use IUserManager instead. See https://platform.relativity.com/RelativityOne/Content/What_s_new/RSAPI_deprecation_process.htm for more details.")]
public class UserRepository : GenericRepository<User>

The UserRepository type exposes the following members.

Methods

  NameDescription
Public methodCreate(ListT)
Creates the specified Artifacts.
(Inherited from GenericRepositoryT.)
Public methodCreate(T)
Creates the specified Artifacts.
(Inherited from GenericRepositoryT.)
Public methodCreateSingle
Creates a single Artifact of the supplied DTO type.
(Inherited from GenericRepositoryT.)
Public methodDelete(ListInt32)
Deletes the specified Artifacts.
(Inherited from GenericRepositoryT.)
Public methodDelete(Int32)
Deletes the specified Artifacts.
(Inherited from GenericRepositoryT.)
Public methodDelete(T)
Deletes the specified Artifacts.
(Inherited from GenericRepositoryT.)
Public methodDeleteSingle(Guid)
Deletes the specified Artifact.
(Inherited from GenericRepositoryT.)
Public methodDeleteSingle(Int32)
Deletes the specified Artifact.
(Inherited from GenericRepositoryT.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodMassCreate
Creates RDO instances for each ArtifactRequest in artifacts based on the Field values provided by a 'template' ArtifactRequest.
(Inherited from GenericRepositoryT.)
Public methodMassEdit
Applies the Field values from the 'template' artifact to each of the Artifacts identified by the array of ArtifactIDs.
(Inherited from GenericRepositoryT.)
Public methodQuery
Queries Relativity to find Artifacts matching the selection criteria.
(Inherited from GenericRepositoryT.)
Public methodQuerySubset
Fetches additional search results after a call to Query.
(Inherited from GenericRepositoryT.)
Public methodRead(ListInt32)
Reads the specified Artifacts. For each Artifact, all fields will be returned.
(Inherited from GenericRepositoryT.)
Public methodRead(Int32)
Reads the specified Artifacts. For each Artifact, all fields will be returned.
(Inherited from GenericRepositoryT.)
Public methodRead(T)
Reads the specified Artifacts.
(Inherited from GenericRepositoryT.)
Public methodReadSingle(Guid)
Returns the Artifact matching the specified artifact GUID.
(Inherited from GenericRepositoryT.)
Public methodReadSingle(Int32)
Returns the Artifact matching the specified artifact ID.
(Inherited from GenericRepositoryT.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdate(ListT)
Updates the specified Artifacts.
(Inherited from GenericRepositoryT.)
Public methodUpdate(T)
Updates the specified Artifacts.
(Inherited from GenericRepositoryT.)
Public methodUpdateSingle
Updates the specified Artifact.
(Inherited from GenericRepositoryT.)
Top
Extension Methods

  NameDescription
Public Extension MethodCreateItemUser
Creates the specified Artifact object and adds it to the current Repository.
(Defined by GenericRepositoryExtensions.)
Public Extension MethodDeleteItemUser
Deletes the specified Artifact.
(Defined by GenericRepositoryExtensions.)
Public Extension MethodReadItemUser
Reads the specified Artifact.
(Defined by GenericRepositoryExtensions.)
Public Extension MethodUpdateItemUser
Updates the specified Artifact.
(Defined by GenericRepositoryExtensions.)
Top
Remarks

System administrators can retrieve data about all users in Relativity when they perform read or query operations.

When users who are not system administrators query for all users without specifying a condition, the read and query operations only return their individual information. The properties returned on the individual’s User object is only a subset of the available settings, which includes those available to non-administrative users in the Relativity web UI, as well as a list of groups that include the user as a member. The group objects will only contain the group Artifact IDs, which a user can then use to query for group names. If the query includes a condition, information about any other users is filtered out, and only their individual information is returned as previously described.

See Also

Reference