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

---

API Differences between 12.0.1 and 9.7.99.15

192 Additions 3 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)
  • void ExecuteSqlBulkCopy(IDataReader dataReader, ISqlBulkCopyParameters bulkCopyParameters)
  • Task<IDbConnection> GetConnectionAsync(CancellationToken cancelToken)
• public interface IHelper : IDisposable
  • IStringSanitizer GetStringSanitizer(int workspaceID)
• public interface IStringSanitizer
  • bool SanitizeHtmlOutput { get; }
  • SanitizeHtmlContentResult SanitizeHtmlContent(string taintedHtml)
• public class SanitizeHtmlContentResult
  • public string CleanHtml { get; set; }
  • public ArrayList ErrorMessages { get; set; }
  • public SanitizeHtmlContentResult()

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; }
• public interface ISqlBulkCopyParameters
  • int? BatchSize { get; set; }
  • IList<SqlBulkCopyColumnMapping> ColumnMappings { get; }
  • string DestinationTableName { get; set; }
  • bool? EnableStreaming { get; set; }
  • SqlBulkCopyOptions? Options { get; set; }
  • int? Timeout { get; set; }
• public class SqlBulkCopyParameters : ISqlBulkCopyParameters
  • public int? BatchSize { get; set; }
  • public IList<SqlBulkCopyColumnMapping> ColumnMappings { get; }
  • public string DestinationTableName { get; set; }
  • public bool? EnableStreaming { get; set; }
  • public SqlBulkCopyOptions? Options { get; set; }
  • public int? Timeout { get; set; }
  • public SqlBulkCopyParameters()

Relativity.API.Foundation

• public enum AuditAction
  • Update_Mass_Revert = 59
  • Update_Revert = 58
• public class ContextOptions : IContextOptions
  • public string OnBehalfOfToken { get; set; }
  • public ContextOptions()
• public class ExportStatistics
  • public enum ImageFileExportType
  • public enum ImageLoadFileFormatType
  • public enum ImagesToExportType
  • public enum LoadFileFormat
  • public bool AppendOriginalFilenames { get; set; }
  • public int ArtifactTypeID { get; set; }
  • public char Bound { get; set; }
  • public bool CopyFilesFromRepository { get; set; }
  • public int DataSourceArtifactID { get; set; }
  • public char Delimiter { get; set; }
  • public string DestinationFilesystemFolder { get; set; }
  • public int DocumentExportCount { get; set; }
  • public int ErrorCount { get; set; }
  • public int ExportedTextFieldID { get; set; }
  • public int ExportedTextFileEncodingCodePage { get; set; }
  • public bool ExportImages { get; set; }
  • public bool ExportMultipleChoiceFieldsAsNested { get; set; }
  • public bool ExportNativeFiles { get; set; }
  • public bool ExportTextFieldAsFiles { get; set; }
  • public int[] Fields { get; set; }
  • public int FileExportCount { get; set; }
  • public string FilePathSettings { get; set; }
  • public ImageFileExportType ImageFileType { get; set; }
  • public ImageLoadFileFormatType ImageLoadFileFormat { get; set; }
  • public ImagesToExportType ImagesToExport { get; set; }
  • public int MetadataLoadFileEncodingCodePage { get; set; }
  • public LoadFileFormat MetadataLoadFileFormat { get; set; }
  • public char MultiValueDelimiter { get; set; }
  • public char NestedValueDelimiter { get; set; }
  • public char NewlineProxy { get; set; }
  • public bool OverwriteFiles { get; set; }
  • public int[] ProductionPrecedence { get; set; }
  • public int RunTimeInMilliseconds { get; set; }
  • public int SourceRootFolderID { get; set; }
  • public int StartExportAtDocumentNumber { get; set; }
  • public string SubdirectoryImagePrefix { get; set; }
  • public long SubdirectoryMaxFileCount { get; set; }
  • public string SubdirectoryNativePrefix { get; set; }
  • public long SubdirectoryStartNumber { get; set; }
  • public string SubdirectoryTextPrefix { get; set; }
  • public int TextAndNativeFilesNamedAfterFieldID { get; set; }
  • public long TotalFileBytesExported { get; set; }
  • public long TotalMetadataBytesExported { get; set; }
  • public string Type { get; set; }
  • public long VolumeMaxSize { get; set; }
  • public string VolumePrefix { get; set; }
  • public int VolumeStartNumber { get; set; }
  • public int WarningCount { get; set; }
  • public ExportStatistics()
• public interface IContextOptions
  • string OnBehalfOfToken { get; set; }
• public interface IFile
  • int FileID { get; }
  • string FileName { get; set; }
  • string Location { get; }
  • string Message { get; }
  • int ObjectArtifactID { get; }
  • long? Size { get; }
  • TextExtractionStatus Status { get; }
  • Stream ConstructStream()
• public interface IWorkspaceContext : IContextualInformation, IDBContext
  • IPermissionChecker GetPermissionChecker()
• public enum TextExtractionStatus
  • Error = 2
  • Pending = 0
  • Success = 1

Relativity.API.Foundation.Extension

• public static class FieldExtensions
  • public static void PopulateFileValue(this IField field, int value)
  • public static void PopulateFileValue(this IField field, IFile value)

Relativity.API.Foundation.MassOperations

• public enum AuditLevel
  • FullAudit = 0
  • NoAudit = 2
  • NoSnapshot = 1
• public interface ICreateBuilder : IMassOperationBuilderWithObjectList<IMassOperation, IRelativityObject, ICreateParameters>, IMassOperationBuilder, IContextualInformation
• public interface ICreateParameters
  • AuditLevel AuditLevel { get; }
  • IEnumerable<IFieldRef> Fields { get; }
  • IObjectTypeRef ObjectType { get; }
  • IArtifactRef ParentArtifact { get; }
• public interface IDeleteParameters
  • int? BatchSize { get; set; }
• public interface IMassOperationBuilderWithObjectList<TMassOperation, TOperands, TMassOperationParameters> : IMassOperationBuilder, IContextualInformation where TMassOperation : IMassOperation
  • TMassOperation CreateMassOperation(IEnumerable<TOperands> operands, TMassOperationParameters parameters)

Relativity.API.Foundation.Permissions

• public enum AdminPermission
  • AgentOperations = 0
  • AllowdtSearchIndexSwap = 1
  • AllowExport = 2
  • AllowImport = 3
  • AssignBatches = 4
  • ChangeQueuePriority = 5
  • DeleteObjectDependencies = 6
  • DownloadRelativityDesktopClient = 7
  • EmailThreadVisualization = 9
  • ExportDashboard = 8
  • ForceLogoutOnUserStatus = 10
  • ManageObjectTypes = 11
  • ManageRelativityApplications = 12
  • ModifySystemKeyboardShortcuts = 13
  • OverrideProductionRestrictions = 14
  • SendMessage = 15
  • UsePivotAndChart = 16
  • UseQuickNav = 17
  • UseSampling = 18
  • ViewAdminRepository = 19
  • ViewAllAudits = 20
  • ViewAudits = 21
  • ViewBatchPane = 22
  • ViewImagesHiddenForQCReview = 24
  • ViewImageThumbnails = 23
  • ViewUserPersonalItems = 26
  • ViewUserStatus = 25
  • ViewWorkspaceDetails = 27
• public interface IArtifactPermission
  • IArtifactRef Artifact { get; }
  • IEnumerable<IPermissionCheckResult> Permissions { get; }
• public interface IPermissionChecker : IContextualInformation
  • bool HasAdminOperationPermission(AdminPermission permission)
  • bool HasPermission(IArtifactRef artifactRef, PermissionType permission)
  • IArtifactPermission HasPermission(IArtifactRef artifactRef, IEnumerable<PermissionType> permissionsTypes)
  • IEnumerable<IArtifactPermission> HasPermission(IEnumerable<IArtifactRef> artifactRefs, IEnumerable<PermissionType> permissionTypes)
• public interface IPermissionCheckResult
  • bool HasPermission { get; }
  • PermissionType Type { get; }
• public enum PermissionType
  • Add = 6
  • Delete = 3
  • Edit = 2
  • Secure = 4
  • View = 1

Relativity.API.Foundation.Repositories

• public interface IChoiceRepository : IRepository, IContextualInformation
  • IChoice Read(IArtifactRef choiceRef)
• public interface IExportAuditRepository : IRepository, IContextualInformation
  • bool CreateAuditForExport(ExportStatistics exportStatistics, int contextUserId)
• public interface IFieldRepository : IRepository, IContextualInformation
  • IEnumerable<IField> GetAllFields(IObjectTypeRef objectTypeRef)
  • IEnumerable<IField> RetrieveAllFieldsByArtifactTypeID(int artifactTypeID)
• public interface IObjectTypeCacheRepository : IRepository, IContextualInformation
  • IObjectType RetrieveObjectTypeByIdentifier(int artifactID)
  • IObjectType RetrieveObjectTypeByIdentifier(IArtifactRef artifactRef)
• public interface ISystemArtifactCacheRepository : IRepository, IContextualInformation
  • bool ExistsInSystemArtifact(int artifactID)
  • int RetrieveArtifactIDByIdentifier(string identifier)
  • int RetrieveArtifactIDByIdentifier(SystemArtifact identifier)
• public interface ISystemArtifactTypeCacheRepository : IRepository, IContextualInformation
  • int RetrieveArtifactIDByIdentifier(SystemArtifact systemArtifact)
  • int RetrieveArtifactIDByIdentifier(string systemArtifact)

Relativity.API.Managers

• public interface ISanitizerManagerHelper
  • bool SanitizeHtmlOutput { get; }
  • SanitizeHtmlContentResult SanitizeHtmlContent(string taintedHtml)