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

---

API Differences between 9.4.315.5 and 17.0.4

54 Additions 155 Removals

Relativity.API

• public class DBContext : IDBContext
  • public string Database { get; }
  • public bool IsMasterDatabase { get; }
  • public string ServerName { get; }
  • public DBContext(BaseContext context)
  • public void BeginTransaction()
  • public void Cancel()
  • public void CommitTransaction()
  • public DbParameter CreateDbParameter()
  • public int ExecuteNonQuerySQLStatement(string sqlStatement)
  • public int ExecuteNonQuerySQLStatement(string sqlStatement, int timeoutValue)
  • public int ExecuteNonQuerySQLStatement(string sqlStatement, IEnumerable<SqlParameter> parameters)
  • public int ExecuteNonQuerySQLStatement(string sqlStatement, IEnumerable<SqlParameter> parameters, int timeoutValue)
  • public SqlDataReader ExecuteParameterizedSQLStatementAsReader(string sqlStatement, IEnumerable<SqlParameter> parameters, int timeoutValue = -1, bool sequentialAccess = false)
  • public DbDataReader ExecuteProcedureAsReader(string procedureName, IEnumerable<SqlParameter> parameters)
  • public int ExecuteProcedureNonQuery(string procedureName, IEnumerable<SqlParameter> parameters)
  • public DataSet ExecuteSqlStatementAsDataSet(string sqlStatement)
  • public DataSet ExecuteSqlStatementAsDataSet(string sqlStatement, IEnumerable<SqlParameter> parameters)
  • public DataSet ExecuteSqlStatementAsDataSet(string sqlStatement, int timeoutValue)
  • public DataSet ExecuteSqlStatementAsDataSet(string sqlStatement, IEnumerable<SqlParameter> parameters, int timeoutValue)
  • public DataTable ExecuteSqlStatementAsDataTable(string sqlStatement)
  • public DataTable ExecuteSqlStatementAsDataTable(string sqlStatement, int timeoutValue)
  • public DataTable ExecuteSqlStatementAsDataTable(string sqlStatement, IEnumerable<SqlParameter> parameters)
  • public DataTable ExecuteSqlStatementAsDataTable(string sqlStatement, int timeoutValue, IEnumerable<SqlParameter> parameters)
  • public DbDataReader ExecuteSqlStatementAsDbDataReader(string sqlStatement)
  • public DbDataReader ExecuteSqlStatementAsDbDataReader(string sqlStatement, int timeoutValue)
  • public DbDataReader ExecuteSqlStatementAsDbDataReader(string sqlStatement, IEnumerable<DbParameter> parameters)
  • public DbDataReader ExecuteSqlStatementAsDbDataReader(string sqlStatement, IEnumerable<DbParameter> parameters, int timeoutValue)
  • public SqlDataReader ExecuteSQLStatementAsReader(string sqlStatement, int timeout = -1)
  • public T ExecuteSqlStatementAsScalar<T>(string sqlStatement)
  • public T ExecuteSqlStatementAsScalar<T>(string sqlStatement, IEnumerable<SqlParameter> parameters)
  • public T ExecuteSqlStatementAsScalar<T>(string sqlStatement, int timeoutValue)
  • public T ExecuteSqlStatementAsScalar<T>(string sqlStatement, IEnumerable<SqlParameter> parameters, int timeoutValue)
  • public T ExecuteSqlStatementAsScalar<T>(string sqlStatement, SqlParameter[] parameters)
  • public object ExecuteSqlStatementAsScalar(string sqlStatement, SqlParameter[] parameters)
  • public object ExecuteSqlStatementAsScalar(string sqlStatement, IEnumerable<SqlParameter> parameters, int timeoutValue)
  • public object ExecuteSqlStatementAsScalarWithInnerTransaction(string sqlStatement, IEnumerable<SqlParameter> parameters, int timeoutValue)
  • public DataTable ExecuteSQLStatementGetSecondDataTable(string sqlStatement, int timeout = -1)
  • public SqlConnection GetConnection()
  • public SqlConnection GetConnection(bool openConnectionIfClosed)
  • public SqlTransaction GetTransaction()
  • public void ReleaseConnection()
  • public void RollbackTransaction()
  • public void RollbackTransaction(Exception originatingException)
• public static class ExtensionPointServiceFinder
  • public static IInstanceSettingsBundle InstanceSettingsBundle { get; set; }
  • public static ISecretStore SecretStoreHelper { get; set; }
  • public static IMonitorSecurityEvents SecurityEventMonitor { get; set; }
  • public static IProvideSystemTokens SystemTokenProvider { get; set; }
  • public static IProvideSystemTokens SystemTokenProvider { get; set; }
• 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)
  • IEnumerable<T> ExecuteSQLStatementAsEnumerable<T>(string sqlStatement, Func<SqlDataReader, T> converter, int timeout = -1)
  • Task<IDbConnection> GetConnectionAsync(CancellationToken cancelToken)
• public interface IHelper : IDisposable
  • IInstanceSettingsBundle GetInstanceSettingBundle()
  • ISecretStore GetSecretStore()
  • IStringSanitizer GetStringSanitizer(int workspaceID)
• public interface IInstanceSettingsBundle
• public interface IMonitorSecurityEvents
• public interface IProvideSystemTokens
• public interface ISecretStore
• public interface IStringSanitizer
• public class SanitizeHtmlContentResult
• public class Secret

Relativity.API.Context

• public class ContextQuery : IQuery
• public interface IQuery
• public interface ISqlBulkCopyParameters
• public class SqlBulkCopyParameters : ISqlBulkCopyParameters

Relativity.API.Exceptions

• public class SecretStoreException : Exception

Relativity.API.Foundation

• public enum AuditAction
• public class ContextOptions : IContextOptions
• public class ExportStatistics
• public enum FieldCategory
• public enum FieldImportBehavior
• public enum FieldType
• public interface IAgent : IArtifact, IArtifactRef
• public interface IArtifact : IArtifactRef
• public interface IArtifactRef
• public interface IAuditRecord
• public interface ICascadeDeleteAgentObjectTypeRef : IObjectTypeRef, IArtifactRef
• public interface ICascadeDeleteDocumentObjectTypeRef : IObjectTypeRef, IArtifactRef
• public interface IChoice : IArtifact, IArtifactRef
• public interface IContextOptions
• public interface IContextualInformation
• public interface IField : IFieldRef, IArtifactRef, IArtifact
• public interface IFieldRef : IArtifactRef
• public interface IFile
• public interface IKeyboardShortcut
• public interface IObjectType : IArtifact, IArtifactRef, IObjectTypeRef
• public interface IObjectTypeRef : IArtifactRef
• public interface IRelationalFieldPane
• public interface IRelativityObject : IArtifact, IArtifactRef
• public interface IResourceFileEventHandlerRef
• public interface ISearchProviderRef : IArtifactRef
• public interface IView : IArtifact, IArtifactRef
• public interface IViewCriteria
• public interface IViewerContextMenuItem
• public interface IViewField
• public interface IViewOrder
• public interface IWorkspaceContext : IContextualInformation, IDBContext
• public enum SystemArtifact
• public enum TextExtractionStatus
• public enum ViewerContextMenuItemAvailability

Relativity.API.Foundation.Extension

• public static class FieldExtensions

Relativity.API.Foundation.MassOperations

• public enum AuditLevel
• public enum DocumentDeleteOptions
• public enum ExportToFileOptions
• public interface ICancelImagingJobBuilder : IMassOperationBuilderWithoutParameters<IMassOperation, string>, IMassOperationBuilder, IContextualInformation
• public interface ICascadeDeleteBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, ICascadeDeleteParameters>, IMassOperationBuilder, IContextualInformation
• public interface ICascadeDeleteParameters
• public interface ICopyBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, ICopyParameters>, IMassOperationBuilder, IContextualInformation
• public interface ICopyParameters
• public interface ICreateBuilder : IMassOperationBuilderWithObjectList<IMassOperation, IRelativityObject, ICreateParameters>, IMassOperationBuilder, IContextualInformation
• public interface ICreateParameters
• public interface ICustomBuilder : IMassOperationBuilderWithParameters<ICustomMassOperation, int, ICustomParameters>, IMassOperationBuilder, IContextualInformation
• public interface ICustomMassOperation : IMassOperation
• public interface ICustomParameters
• public interface ICustomValidationResponse
• public interface IDeleteBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IDeleteParameters>, IMassOperationBuilder, IContextualInformation
• public interface IDeleteParameters
• public interface IEditBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IEditParameters>, IMassOperationBuilder, IContextualInformation
• public interface IEditParameters
• public interface IEditWorkerManagerItemPriorityBuilder : IMassOperationBuilderWithParameters<IMassOperation, string, IEditWorkerManagerPriorityParameters>, IMassOperationBuilder, IContextualInformation
• public interface IEditWorkerManagerPriorityParameters
• public interface IExportToFileBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IExportToFileParameters>, IMassOperationBuilder, IContextualInformation
• public interface IExportToFileParameters
• public interface IMassOperation
• public interface IMassOperationBuilder : IContextualInformation
• public interface IMassOperationBuilderWithObjectList<TMassOperation, TOperands, TMassOperationParameters> : IMassOperationBuilder, IContextualInformation where TMassOperation : IMassOperation
• public interface IMassOperationBuilderWithoutParameters<TMassOperation, TIDs> : IMassOperationBuilder, IContextualInformation where TMassOperation : IMassOperation
• public interface IMassOperationBuilderWithParameters<TMassOperation, TIDs, TMassOperationParameters> : IMassOperationBuilder, IContextualInformation where TMassOperation : IMassOperation
• public interface IMassOperationCompletedEvent
• public interface IMassOperationRef
• public interface IMoveBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IMoveParameters>, IMassOperationBuilder, IContextualInformation
• public interface IMoveParameters
• public interface IReplaceAction
• public interface IReplaceBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, IReplaceParameters>, IMassOperationBuilder, IContextualInformation
• public interface IReplaceFieldRef
• public interface IReplaceOptions
• public interface IReplaceParameters
• public interface IResumeProcessingJobBuilder : IMassOperationBuilderWithoutParameters<IMassOperation, string>, IMassOperationBuilder, IContextualInformation
• public interface ISaveAsListBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, ISaveAsListBuilder>, IMassOperationBuilder, IContextualInformation
• public interface ISaveAsListOptions
• public interface ISaveAsListParameters
• public interface ITallySumAverageBuilder : IMassOperationBuilderWithParameters<IMassOperation, int, ITallySumAverageParameters>, IMassOperationBuilder, IContextualInformation
• public interface ITallySumAverageParameters
• public enum OperationState
• public enum ReplaceActionOptions
• public enum ReplaceWithOptions
• public enum SaveAsListAction
• public enum TallySumAverageOptions
• public enum ValidationResponseSeverity

Relativity.API.Foundation.ObjectRule

• public interface IChoiceAddLinkVisibilityObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<IChoiceAddLinkVisibilityRule>
• public interface IChoiceAddLinkVisibilityRule : IObjectRule, IArtifact, IArtifactRef
• public interface IConditionalButtonVisibilityObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<IConditionalButtonVisibilityRule>
• public interface IConditionalButtonVisibilityRule : IGlobalButtonVisibilityRule, IObjectRule, IArtifact, IArtifactRef
• public interface ICustomSingleObjectAddLinkVisibilityObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<ICustomSingleObjectAddLinkVisibilityRule>
• public interface ICustomSingleObjectAddLinkVisibilityRule : IObjectRule, IArtifact, IArtifactRef
• public interface IDefaultLayoutObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<IDefaultLayoutRule>
• public interface IDefaultLayoutOnNewObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<IDefaultLayoutOnNewRule>
• public interface IDefaultLayoutOnNewRule : IObjectRule, IArtifact, IArtifactRef
• public interface IDefaultLayoutRule : IObjectRule, IArtifact, IArtifactRef
• public interface IGlobalButtonVisibilityObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<IGlobalButtonVisibilityRule>
• public interface IGlobalButtonVisibilityRule : IObjectRule, IArtifact, IArtifactRef
• public interface IMassActionVisibilityObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<IMassActionVisibilityRule>
• public interface IMassActionVisibilityRule : IObjectRule, IArtifact, IArtifactRef
• public interface INewButtonOverrideObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<INewButtonOverrideRule>
• public interface INewButtonOverrideRule : IObjectRule, IArtifact, IArtifactRef
• public interface IObjectRule : IArtifact, IArtifactRef
• public interface IObjectRuleRepositoryBase<T> where T : IObjectRule
• public interface IOverrideEditLinkUrlObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<IOverrideEditLinkUrlRule>
• public interface IOverrideEditLinkUrlRule : IObjectRule, IArtifact, IArtifactRef
• public interface IOverrideViewLinkUrlObjectRuleRepository : IRepository, IContextualInformation, IObjectRuleRepositoryBase<IOverrideViewLinkUrlRule>
• public interface IOverrideViewLinkUrlRule : IObjectRule, IArtifact, IArtifactRef

Relativity.API.Foundation.Permissions

• public enum AdminPermission
• public interface IArtifactPermission
• public interface IPermissionChecker : IContextualInformation
• public interface IPermissionCheckResult
• public enum PermissionType

Relativity.API.Foundation.Repositories

• public interface IAgentRepository : IRepository, IContextualInformation
• public interface IApplicationArtifactCacheRepository : IRepository, IContextualInformation
• public interface IAuditRepository : IRepository, IContextualInformation
• public interface IChoiceRepository : IRepository, IContextualInformation
• public interface IErrorRepository : IRepository, IContextualInformation
• public interface IExportAuditRepository : IRepository, IContextualInformation
• public interface IFieldRepository : IRepository, IContextualInformation
• public interface IObjectRepository : IRepository, IContextualInformation
• public interface IObjectTypeCacheRepository : IRepository, IContextualInformation
• public interface IRepository : IContextualInformation
• public interface ISystemArtifactCacheRepository : IRepository, IContextualInformation
• public interface ISystemArtifactTypeCacheRepository : IRepository, IContextualInformation
• public interface IViewerContextMenuItemRepository : IRepository, IContextualInformation
• public interface IViewRepository : IRepository, IContextualInformation

Relativity.API.Managers

• public interface ISanitizerManagerHelper

Relativity.Services.Security

• public class PermissionHelper : IPermissionHelper, IDisposable
  • public Func<int, IDBContext> GetDBContext
  • public PermissionHelper()
  • public void Dispose()
  • public ArrayList GetAclListArray(int userID, int workspaceID, int artifactTypeID, int permissionTypeID)
  • public string GetAclListCsv(int userID, int workspaceID, int artifactTypeID, int permissionTypeID)
  • public ArrayList GetDeleteAclList(int userID, int workspaceID, int artifactTypeID)
  • public ArrayList GetEditAclList(int userID, int workspaceID, int artifactTypeID)
  • public ArrayList GetViewAclList(int userID, int workspaceID, int artifactTypeID)