<PackageReference Include="Relativity.Api" Version="15.1.3" />

---

API Differences between 15.1.3 and 10.2.137.8

150 Additions 5 Removals

Relativity.API

• public interface IDBContext
  • Task BeginTransactionAsync(CancellationToken cancelToken)
  • Task ExecuteBulkCopyAsync(IDataReader source, ISqlBulkCopyParameters parameters, CancellationToken cancelToken)
  • Task<DataTable> ExecuteDataTableAsync(IQuery query)
  • Task<IEnumerable<T>> ExecuteEnumerableAsync<T>(IQuery query, Func<IDataRecord, CancellationToken, Task<T>> converter)
  • Task<int> ExecuteNonQueryAsync(IQuery query)
  • Task<T> ExecuteObjectAsync<T>(IQuery query, Func<IDataReader, CancellationToken, Task<T>> converter)
  • Task<IDataReader> ExecuteReaderAsync(IQuery query)
  • Task<T> ExecuteScalarAsync<T>(IQuery query)
  • IEnumerable<T> ExecuteSqlStatementAsEnumerable<T>(string sqlStatement, Func<SqlDataReader, T> converter, IEnumerable<SqlParameter> parameters)
  • T ExecuteSqlStatementAsObject<T>(string sqlStatement, Func<SqlDataReader, T> converter)
  • T ExecuteSqlStatementAsObject<T>(string sqlStatement, Func<SqlDataReader, T> convertor, int timeout = -1)
  • T ExecuteSqlStatementAsObject<T>(string sqlStatement, Func<SqlDataReader, T> converter, IEnumerable<SqlParameter> parameters)
  • T ExecuteSqlStatementAsObject<T>(string sqlStatement, Func<SqlDataReader, T> converter, IEnumerable<SqlParameter> parameters, int timeoutValue)
  • Task<IDbConnection> GetConnectionAsync(CancellationToken cancelToken)

Relativity.API.Context

• public class ContextQuery : IQuery
  • public CancellationToken CancellationToken { get; set; }
  • public bool ExecuteAsStoredProcedure { get; set; }
  • public int? ExecutionTimeout { get; set; }
  • public IEnumerable<IDataParameter> Parameters { get; set; }
  • public string SqlStatement { get; set; }
  • public ContextQuery()
• public interface IQuery
  • CancellationToken CancellationToken { get; }
  • bool ExecuteAsStoredProcedure { get; }
  • int? ExecutionTimeout { get; }
  • IEnumerable<IDataParameter> Parameters { get; }
  • string SqlStatement { get; }

Relativity.API.Foundation

• public class ContextOptions : IContextOptions
  • public string OnBehalfOfToken { get; set; }
  • public ContextOptions()
• public interface ICascadeDeleteAgentObjectTypeRef : IObjectTypeRef, IArtifactRef
  • bool ForceDelete { get; }
• public interface ICascadeDeleteDocumentObjectTypeRef : IObjectTypeRef, IArtifactRef
  • DocumentDeleteOptions DocumentDeleteOptions { get; }
  • bool ForceDelete { get; }
• public interface IContextOptions
  • string OnBehalfOfToken { get; set; }
• public interface IResourceFileEventHandlerRef
  • Guid EventHandlerGuid { get; }
• public interface ISearchProviderRef : IArtifactRef
  • bool HasRank { get; set; }

Relativity.API.Foundation.MassOperations

• public enum DocumentDeleteOptions
  • DeleteDocumentAndAllAssociatedFiles = 0
  • DeleteOnlyImages = 1
  • DeleteOnlyNatives = 2
  • DeleteOnlyNativesAndImages = 3
• public enum ExportToFileOptions
  • Csv = 0
  • Dat = 1
  • Xls = 2
• public interface ICascadeDeleteBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, ICascadeDeleteParameters>, IMassOperationBuilder, IContextualInformation
• public interface ICascadeDeleteParameters
  • int? BatchSize { get; }
  • IObjectTypeRef ObjectType { get; }
  • Guid? ProcessIdentifier { get; }
• public interface ICopyBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, ICopyParameters>, IMassOperationBuilder, IContextualInformation
• public interface ICopyParameters
  • int? BatchSize { get; set; }
  • IObjectTypeRef ObjectType { get; }
  • IArtifactRef ParentArtifact { get; }
  • Guid? ProcessIdentifier { get; }
• public interface ICustomBuilder : IMassOperationBuilderWithParameters<ICustomMassOperation, int, ICustomParameters>, IMassOperationBuilder, IContextualInformation
• public interface ICustomMassOperation : IMassOperation
  • IEnumerable<ICustomValidationResponse> ValidateLayout()
  • IEnumerable<ICustomValidationResponse> ValidateSelection()
• public interface ICustomParameters
  • int? BatchSize { get; }
  • IMassOperationRef CustomMassOperation { get; }
  • IEnumerable<IField> Fields { get; }
  • IObjectTypeRef ObjectType { get; }
  • Guid? ProcessIdentifier { get; }
• public interface ICustomValidationResponse
  • string Message { get; }
  • ValidationResponseSeverity Severity { get; }
• public interface IEditBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IEditParameters>, IMassOperationBuilder, IContextualInformation
• public interface IEditParameters
  • int? BatchSize { get; set; }
  • IEnumerable<IField> Fields { get; }
  • IObjectTypeRef ObjectType { get; }
  • Guid? ProcessIdentifier { get; }
• public interface IExportToFileBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IExportToFileParameters>, IMassOperationBuilder, IContextualInformation
• public interface IExportToFileParameters
  • Encoding Encoding { get; }
  • bool EscapeFormulas { get; }
  • Stream ExportResults { get; }
  • IEnumerable<IFieldRef> Fields { get; }
  • ExportToFileOptions FileOptions { get; }
  • IObjectTypeRef ObjectType { get; }
  • Guid? ProcessIdentifier { get; }
  • ISearchProviderRef SearchProvider { get; }
  • IArtifactRef View { get; }
• public interface IMassOperationRef
  • IArtifactRef MassOperationArtifact { get; }
  • IResourceFileEventHandlerRef ResourceFileMassOperation { get; }
• public interface IMoveBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IMoveParameters>, IMassOperationBuilder, IContextualInformation
• public interface IMoveParameters
  • int? BatchSize { get; }
  • IArtifactRef DestinationFolder { get; }
  • IObjectTypeRef ObjectType { get; }
  • Guid? ProcessIdentifier { get; }
• public interface IReplaceAction
  • IFieldRef FieldToReplaceWith { get; }
  • ReplaceWithOptions ReplaceWithOptions { get; }
  • string TextToReplaceWith { get; }
• public interface IReplaceBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IReplaceParameters>, IMassOperationBuilder, IContextualInformation
• public interface IReplaceFieldRef
  • IFieldRef FieldToReplace { get; }
  • IReplaceAction ReplaceAction { get; }
  • IReplaceOptions ReplaceOptions { get; }
• public interface IReplaceOptions
  • ReplaceActionOptions ReplaceActionOptions { get; }
  • string ReplaceActionValue { get; }
• public interface IReplaceParameters
  • int? BatchSize { get; }
  • IObjectTypeRef ObjectType { get; }
  • Guid? ProcessIdentifier { get; }
  • IEnumerable<IReplaceFieldRef> ReplaceFields { get; }
• public interface ISaveAsListBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, ISaveAsListBuilder>, IMassOperationBuilder, IContextualInformation
• public interface ISaveAsListOptions
  • IArtifactRef ExistingListArtifactId { get; }
  • string ListName { get; }
  • SaveAsListAction SaveAsListAction { get; }
• public interface ISaveAsListParameters
  • int? BatchSize { get; }
  • string Notes { get; }
  • IObjectTypeRef ObjectType { get; }
  • Guid? ProcessIdentifier { get; }
  • ISaveAsListOptions SaveAsListOptions { get; }
• public interface ITallySumAverageBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, ITallySumAverageParameters>, IMassOperationBuilder, IContextualInformation
• public interface ITallySumAverageParameters
  • IFieldRef Field { get; }
  • IObjectTypeRef ObjectType { get; }
  • TallySumAverageOptions Operation { get; }
  • Guid? ProcessIdentifier { get; }
  • DataTable ReportTable { get; }
• public enum ReplaceActionOptions
  • Append = 1
  • FindReplace = 3
  • Insert = 2
  • ReplaceWhole = 0
• public enum ReplaceWithOptions
  • Field = 1
  • Text = 0
• public enum SaveAsListAction
  • CreateNewList = 0
  • ReplaceExistingList = 1
• public enum TallySumAverageOptions
  • Average = 2
  • Sum = 1
  • Tally = 0
• public enum ValidationResponseSeverity
  • Error = 1
  • Warning = 0

Relativity.API.Foundation.Repositories

• public interface IAuditRepository : IRepository, IContextualInformation
  • Task CreateAuditRecords(IEnumerable<IAuditRecord> auditRecords)
• public interface IChoiceRepository : IRepository, IContextualInformation
  • IChoice Read(IArtifactRef choiceRef)