Relativity.ObjectManager 9.7.137.2 - API Reference

<PackageReference Include="Relativity.ObjectManager" Version="9.7.137.2" />

API Differences between 9.7.137.2 and 9.6.235.5

102 Additions 18 Removals

Relativity.Services.DataContracts.DTOs.Results

public class ExportInitializationResults
- public List<FieldMetadata> FieldData { get; set; }
- public long RecordCount { get; set; }
- public Guid RunID { get; set; }
- public ExportInitializationResults()

Relativity.Services.DataContracts.ImportExport

public class RetrieveResultsBlockSettings
- public int MaximumNumberOfCharactersForLongText { get; set; }
- public int NumberOfRecordsToRetrieve { get; set; }
- public RetrieveResultsBlockSettings()

Relativity.Services.Objects

public interface IObjectManager : IDisposable
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeletePerObjectsRequest massRequestPerObjects)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeletePerObjectsRequest massRequestPerObjects, IProgress<DeleteProcessStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeletePerObjectsRequest massRequestPerObjects, CancellationToken cancel)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeletePerObjectsRequest massRequestPerObjects, CancellationToken cancel, IProgress<DeleteProcessStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByObjectIdentifiersRequest massRequestByObjectIdentifiers)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByObjectIdentifiersRequest massRequestByObjectIdentifiers, IProgress<MassOperationsStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByObjectIdentifiersRequest massRequestByObjectIdentifiers, CancellationToken cancel)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByObjectIdentifiersRequest massRequestByObjectIdentifiers, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByCriteriaRequest massRequestByCriteria, IProgress<DeleteProcessStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByCriteriaRequest massRequestByCriteria, CancellationToken cancel, IProgress<DeleteProcessStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByCriteriaRequest massRequestByCriteria, IProgress<MassOperationsStateProgress> progress)
- Task<MassDeleteResult> DeleteAsync(int workspaceID, MassDeleteByCriteriaRequest massRequestByCriteria, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<ExportInitializationResults> InitializeExportAsync(int workspaceID, QueryRequest queryRequest, int start)
- Task<ExportInitializationResults> InitializeExportAsync(int workspaceID, QueryRequest queryRequest, Guid requestKey, int start)
- Task<RelativityObjectSlim[]> RetrieveNextResultsBlockFromExportAsync(int workspaceID, Guid runID, int batchSize)
- Task<IKeplerStream> StreamLongTextAsync(int workspaceID, RelativityObjectRef exportObject, FieldRef longTextField)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByObjectIdentifiersRequest massRequestByObjectIdentifiers, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdateByCriteriaRequest massRequestByCriteria, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, MassUpdateOptions options)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, MassUpdateOptions options, CancellationToken cancel)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, MassUpdateOptions options, IProgress<MassOperationsStateProgress> progress)
- Task<MassUpdateResult> UpdateAsync(int workspaceID, MassUpdatePerObjectsRequest massRequestPerObjects, MassUpdateOptions options, CancellationToken cancel, IProgress<MassOperationsStateProgress> progress)

Relativity.Services.Objects.DataContracts

public interface IHasArtifactTypeID : IHasIdentifyingInformation
- int ArtifactTypeID { get; set; }
public interface IHasIdentifyingInformation
public interface IHasObjectIdentificationCriteria
- ObjectIdentificationCriteria ObjectIdentificationCriteria { get; set; }
public interface IHasViewFieldID : IHasIdentifyingInformation
- int ViewFieldID { get; set; }
public interface IObjectType : IHasArtifactID, IHasIdentifyingInformation, IHasName, IHasArtifactTypeID
public class MassCreateRequest
- public IEnumerable<FieldRef> Fields { get; set; }
- public IReadOnlyList<FieldRef> Fields { get; set; }
public class MassDeletePerObjectsRequest
public class MassDeleteByObjectIdentifiersRequest
- public IReadOnlyList<RelativityObjectRef> Objects { get; set; }
- public MassDeleteByObjectIdentifiersRequest()
public class MassDeleteResult
- public string Message { get; set; }
- public bool Success { get; set; }
public class MassOperationsStateProgress
- public int OperationsCompleted { get; set; }
- public int TotalOperations { get; set; }
- public double PercentageComplete { get; set; }
- public MassOperationsStateProgress(int totalOperations, int operationsCompleted)
public class ObjectRefValuesPair
- public IEnumerable<object> Values { get; set; }
- public IReadOnlyList<object> Values { get; set; }

Relativity.Services.Objects.Exceptions

public class ArtifactNotFoundException : ValidationException
- public ArtifactNotFoundException()
- public ArtifactNotFoundException(string message)
- public ArtifactNotFoundException(string message, Exception innerException)
- public ArtifactNotFoundException(SerializationInfo info, StreamingContext context)
public class DuplicateArtifactException : ValidationException
- public DuplicateArtifactException()
- public DuplicateArtifactException(string message)
- public DuplicateArtifactException(string message, Exception innerException)
- public DuplicateArtifactException(SerializationInfo info, StreamingContext context)
public class InsufficientArgumentException : ValidationException
- public InsufficientArgumentException()
- public InsufficientArgumentException(string message)
- public InsufficientArgumentException(string message, Exception innerException)
- public InsufficientArgumentException(SerializationInfo info, StreamingContext context)
public class InvalidObjectTypeException : ValidationException
- public InvalidObjectTypeException()
- public InvalidObjectTypeException(string message)
- public InvalidObjectTypeException(string message, Exception innerException)
- public InvalidObjectTypeException(SerializationInfo info, StreamingContext context)
public class InvalidValueTypeException : ValidationException
- public InvalidValueTypeException()
- public InvalidValueTypeException(string message)
- public InvalidValueTypeException(string message, Exception innerException)
- public InvalidValueTypeException(SerializationInfo info, StreamingContext context)
public class MissingArgumentException : ValidationException
- public MissingArgumentException()
- public MissingArgumentException(string message)
- public MissingArgumentException(string message, Exception innerException)
- public MissingArgumentException(SerializationInfo info, StreamingContext context)
public class PermissionDeniedException : ValidationException
- public PermissionDeniedException()
- public PermissionDeniedException(string message)
- public PermissionDeniedException(string message, Exception innerException)
- public PermissionDeniedException(SerializationInfo info, StreamingContext context)
public class UnsupportedFieldTypeException : ValidationException
- public UnsupportedFieldTypeException()
- public UnsupportedFieldTypeException(string message)
- public UnsupportedFieldTypeException(string message, Exception innerException)
- public UnsupportedFieldTypeException(SerializationInfo info, StreamingContext context)
public class UnsupportedObjectTypeException : ValidationException
- public UnsupportedObjectTypeException()
- public UnsupportedObjectTypeException(string message)
- public UnsupportedObjectTypeException(string message, Exception innerException)
- public UnsupportedObjectTypeException(SerializationInfo info, StreamingContext context)

Relativity.Services.Objects.Extensions

public static class GuidListExtensions
- public static Guid? GetOptionalGuid(this IEnumerable<Guid> guids)
public static class IObjectTypeExtensions
- public static Guid GetGuid(this IObjectType objectType)
- public static bool IsIdentifiedByGuid(this IObjectType objectType)

Relativity.Services.Objects.Helpers

public class ChoiceRefHelper : IChoiceRefHelper
public class RelativityObjectRefHelper : IRelativityObjectRefHelper
public class UserRefHelper : IUserRefHelper

Relativity.Services.Review.DynamicReviewQueue

public class DynamicReviewQueuesView
- public string DocumentIdColumnName { get; set; }
- public string Name { get; set; }
- public string Schema { get; set; }
- public DynamicReviewQueuesView()

Relativity.Services.Serialization.Foundation

public interface IChoiceRefHelper
public interface IRelativityObjectRefHelper
public interface IUserRefHelper