Relativity.Transfer.Client 7.4.9

API Differences between 7.4.9 and 5.0.2

1090 Additions 104 Removals

Relativity.DataTransfer.Legacy.SDK.ImportExport

public sealed class AuditExportDataAttribute : Attribute
- public AuditExportDataAttribute()
public sealed class AuditImageImportDataAttribute : Attribute
- public AuditImageImportDataAttribute()
public sealed class AuditObjectImportDataAttribute : Attribute
- public AuditObjectImportDataAttribute()
public sealed class ImageLoadInfoDataAttribute : Attribute
- public ImageLoadInfoDataAttribute()
public interface IWebApiReplacementModule
public sealed class NativeLoadInfoDataAttribute : Attribute
- public NativeLoadInfoDataAttribute()
public sealed class ObjectLoadInfoDataAttribute : Attribute
- public ObjectLoadInfoDataAttribute()
public sealed class SensitiveDataAttribute : Attribute
- public SensitiveDataAttribute()

Relativity.DataTransfer.Legacy.SDK.ImportExport.V1

public interface IAuditService : IDisposable
- Task<bool> AuditExportAsync(int workspaceID, bool isFatalError, ExportStatistics exportStatistics, string correlationID)
- Task<bool> AuditImageImportAsync(int workspaceID, string runID, bool isFatalError, ImageImportStatistics importStatistics, string correlationID)
- Task<bool> AuditObjectImportAsync(int workspaceID, string runID, bool isFatalError, ObjectImportStatistics importStatistics, string correlationID)
- Task DeleteAuditTokenAsync(string token, string correlationID)
public interface IBulkImportService : IDisposable
- Task<MassImportResults> BulkImportImageAsync(int workspaceID, ImageLoadInfo settings, bool inRepository, string correlationID)
- Task<MassImportResults> BulkImportNativeAsync(int workspaceID, NativeLoadInfo settings, bool inRepository, bool includeExtractedTextEncoding, string correlationID)
- Task<MassImportResults> BulkImportObjectsAsync(int workspaceID, ObjectLoadInfo settings, bool inRepository, string correlationID)
- Task<MassImportResults> BulkImportProductionImageAsync(int workspaceID, ImageLoadInfo settings, int productionArtifactID, bool inRepository, string correlationID)
- Task<object> DisposeTempTablesAsync(int workspaceID, string runID, string correlationID)
- Task<ErrorFileKey> GenerateImageErrorFilesAsync(int workspaceID, string importKey, bool writeHeader, int keyFieldID, string correlationID)
- Task<ErrorFileKey> GenerateNonImageErrorFilesAsync(int workspaceID, string importKey, int artifactTypeID, bool writeHeader, int keyFieldID, string correlationID)
- Task<bool> HasImportPermissionsAsync(int workspaceID, string correlationID)
- Task<bool> ImageRunHasErrorsAsync(int workspaceID, string runID, string correlationID)
- Task<bool> NativeRunHasErrorsAsync(int workspaceID, string runID, string correlationID)
public interface ICaseService : IDisposable
- Task<string[]> GetAllDocumentFolderPathsAsync(string correlationID)
- Task<string[]> GetAllDocumentFolderPathsForCaseAsync(int workspaceID, string correlationID)
- Task<CaseInfo> ReadAsync(int workspaceID, string correlationID)
- Task<DataSetWrapper> RetrieveAllEnabledAsync(string correlationID)
public interface ICodeService : IDisposable
- Task<object> CreateEncodedAsync(int workspaceID, Code code, string correlationID)
- Task<DataSetWrapper> GetAllForHierarchicalAsync(int workspaceID, int codeTypeID, string correlationID)
- Task<int> GetChoiceLimitForUIAsync(string correlationID)
- Task<DataSetWrapper> GetInitialChunkAsync(int workspaceID, int codeTypeID, string correlationID)
- Task<DataSetWrapper> GetLastChunkAsync(int workspaceID, int codeTypeID, int lastCodeID, string correlationID)
- Task<int> ReadIDEncodedAsync(int workspaceID, int parentArtifactID, int codeTypeID, string name, string correlationID)
- Task<ChoiceInfo> RetrieveCodeByNameAndTypeIDEncodedAsync(int workspaceID, int codeTypeID, string name, string correlationID)
- Task<DataSetWrapper> RetrieveCodesAndTypesForCaseAsync(int workspaceID, string correlationID)
public interface IDocumentService : IDisposable
- Task<int[]> RetrieveAllUnsupportedOiFileIdsAsync(string correlationID)
public interface IExportService : IDisposable
- Task<bool> HasExportPermissionsAsync(int workspaceID, string correlationID)
- Task<InitializationResults> InitializeFolderExportAsync(int workspaceID, int viewArtifactID, int parentArtifactID, bool includeSubFolders, int[] avfIDs, int startAtRecord, int artifactTypeID, string correlationID)
- Task<InitializationResults> InitializeProductionExportAsync(int workspaceID, int productionArtifactID, int[] avfIds, int startAtRecord, string correlationID)
- Task<InitializationResults> InitializeSearchExportAsync(int workspaceID, int searchArtifactID, int[] avfIDs, int startAtRecord, string correlationID)
- Task<ExportDataWrapper> RetrieveResultsBlockForProductionStartingFromIndexAsync(int workspaceID, Guid runID, int artifactTypeID, int[] avfIds, int chunkSize, bool displayMulticodesAsNested, char multiValueDelimiter, char nestedValueDelimiter, int[] textPrecedenceAvfIds, int productionId, int index, string correlationID)
- Task<ExportDataWrapper> RetrieveResultsBlockStartingFromIndexAsync(int workspaceID, Guid runID, int artifactTypeID, int[] avfIds, int chunkSize, bool displayMulticodesAsNested, char multiValueDelimiter, char nestedValueDelimiter, int[] textPrecedenceAvfIds, int index, string correlationID)
public interface IFieldService : IDisposable
- Task<bool> IsFieldIndexedAsync(int workspaceID, int fieldArtifactID, string correlationID)
- Task<Field> ReadAsync(int workspaceID, int fieldArtifactID, string correlationID)
- Task<DataSetWrapper> RetrieveAllMappableAsync(int workspaceID, int artifactTypeID, string correlationID)
- Task<DataSetWrapper> RetrievePotentialBeginBatesFieldsAsync(int workspaceID, string correlationID)
public interface IFileIOService : IDisposable
- Task<IoResponse> BeginFillAsync(int workspaceID, byte[] b, string documentDirectory, string fileName, string correlationID)
- Task<IoResponse> FileFillAsync(int workspaceID, string documentDirectory, string fileName, byte[] b, string correlationID)
- Task<string> GetBcpSharePathAsync(int workspaceID, string correlationID)
- Task<string[][]> GetBcpShareSpaceReportAsync(int workspaceID, string correlationID)
- Task<string[][]> GetDefaultRepositorySpaceReportAsync(int workspaceID, string correlationID)
- Task RemoveFillAsync(int workspaceID, string documentDirectory, string fileName, string correlationID)
- Task RemoveTempFileAsync(int workspaceID, string fileName, string correlationID)
- Task<int> RepositoryVolumeMaxAsync(string correlationID)
- Task<bool> ValidateBcpShareAsync(int workspaceID, string correlationID)
public interface IFolderService : IDisposable
- Task<int> CreateAsync(int workspaceID, int parentArtifactID, string folderName, string correlationID)
- Task<bool> ExistsAsync(int workspaceID, int folderArtifactID, string correlationID)
- Task<Folder> ReadAsync(int workspaceID, int folderArtifactID, string correlationID)
- Task<int> ReadIDAsync(int workspaceID, int parentArtifactID, string name, string correlationID)
- Task<DataSetWrapper> RetrieveFolderAndDescendantsAsync(int workspaceID, int folderID, string correlationID)
- Task<DataSetWrapper> RetrieveInitialChunkAsync(int workspaceID, string correlationID)
- Task<DataSetWrapper> RetrieveNextChunkAsync(int workspaceID, int lastFolderID, string correlationID)
public interface IHealthCheckService : IDisposable
- Task<HealthCheckResult> HealthCheckAsync()
public interface IIAPICommunicationModeService : IDisposable
- Task<IAPICommunicationMode> GetIAPICommunicationModeAsync(string correlationId)
public interface IObjectService : IDisposable
- Task<DataSetWrapper> RetrieveArtifactIdOfMappedObjectAsync(int workspaceID, string textIdentifier, int artifactTypeID, string correlationID)
- Task<DataSetWrapper> RetrieveArtifactIdOfMappedParentObjectAsync(int workspaceID, string textIdentifier, int artifactTypeID, string correlationID)
- Task<DataSetWrapper> RetrieveTextIdentifierOfMappedObjectAsync(int workspaceID, int artifactID, int artifactTypeID, string correlationID)
public interface IObjectTypeService : IDisposable
- Task<DataSetWrapper> RetrieveAllUploadableAsync(int workspaceID, string correlationID)
- Task<DataSetWrapper> RetrieveParentArtifactTypeIDAsync(int workspaceID, int artifactTypeID, string correlationID)
public interface IProductionService : IDisposable
- Task DoPostImportProcessingAsync(int workspaceID, int productionArtifactID, string correlationID)
- Task DoPreImportProcessingAsync(int workspaceID, int productionArtifactID, string correlationID)
- Task<ProductionInfo> ReadAsync(int workspaceID, int productionArtifactID, string correlationID)
- Task<ExportDataWrapper> RetrieveBatesByProductionAndDocumentAsync(int workspaceID, int[] productionIDs, int[] documentIDs, string correlationID)
- Task<DataSetWrapper> RetrieveImportEligibleByContextArtifactIDAsync(int workspaceID, string correlationID)
- Task<DataSetWrapper> RetrieveProducedByContextArtifactIDAsync(int workspaceID, string correlationID)
public interface IRelativityService : IDisposable
- Task<string> GetImportExportWebApiVersionAsync(string correlationID)
- Task<string> GetRelativityUrlAsync(string correlationID)
- Task<bool> IsImportEmailNotificationEnabledAsync(string correlationID)
- Task<string> RetrieveCurrencySymbolAsync(string correlationID)
- Task<DataSetWrapper> RetrieveRdcConfigurationAsync(string correlationID)
- Task<bool> ValidateSuccessfulLoginAsync(string correlationID)
public interface ISearchService : IDisposable
- Task<bool[]> IsAssociatedSearchProviderAccessibleAsync(int workspaceID, int searchArtifactID, string correlationID)
- Task<DataSetWrapper> RetrieveAllExportableViewFieldsAsync(int workspaceID, int artifactTypeID, string correlationID)
- Task<DataSetWrapper> RetrieveDefaultViewFieldsForIdListAsync(int workspaceID, int artifactTypeID, int[] artifactIdList, bool isProductionList, string correlationID)
- Task<DataSetWrapper> RetrieveFilesForDynamicObjectsAsync(int workspaceID, int fileFieldArtifactID, int[] objectIDs, string correlationID)
- Task<DataSetWrapper> RetrieveImagesByProductionArtifactIDForProductionExportByDocumentSetAsync(int workspaceID, int productionArtifactID, int[] documentArtifactIDs, string correlationID)
- Task<DataSetWrapper> RetrieveImagesByProductionIDsAndDocumentIDsForExportAsync(int workspaceID, int[] productionArtifactIDs, int[] documentArtifactIDs, string correlationID)
- Task<DataSetWrapper> RetrieveImagesForSearchAsync(int workspaceID, int[] documentArtifactIDs, string correlationID)
- Task<DataSetWrapper> RetrieveNativesForProductionAsync(int workspaceID, int productionArtifactID, string documentArtifactIDs, string correlationID)
- Task<DataSetWrapper> RetrieveNativesForSearchAsync(int workspaceID, string documentArtifactIDs, string correlationID)
- Task<DataSetWrapper> RetrievePdfForSearchAsync(int workspaceID, string documentArtifactIDs, string correlationID)
- Task<DataSetWrapper> RetrieveProducedImagesForDocumentAsync(int workspaceID, int documentArtifactID, string correlationID)
- Task<DataSetWrapper> RetrieveViewsByContextArtifactIDAsync(int workspaceID, int artifactTypeID, bool isSearch, string correlationID)
public interface ITAPIService : IDisposable
- Task<TAPIConfiguration> RetrieveConfigurationAsync(string correlationID)
public interface IUserService : IDisposable
- Task ClearCookiesBeforeLoginAsync(string correlationID)
- Task<string> GenerateDistributedAuthenticationTokenAsync(string correlationID)
- Task<bool> LoggedInAsync(string correlationID)
- Task<bool> LoginAsync(string emailAddress, string password, string correlationID)
- Task LogoutAsync(string correlationID)
- Task<DataSetWrapper> RetrieveAllAssignableInCaseAsync(int workspaceID, string correlationID)
public interface IWebDistributedService : IDisposable
- Task<IKeplerStream> DownloadFieldFileAsync(int workspaceID, int objectArtifactID, int fileID, int fileFieldArtifactId, string correlationID)
- Task<IKeplerStream> DownloadFullTextAsync(int workspaceID, int artifactID, string correlationID)
- Task<IKeplerStream> DownloadLongTextFieldAsync(int workspaceID, int artifactID, int longTextFieldArtifactID, string correlationID)
- Task<IKeplerStream> DownloadNativeFileAsync(int workspaceID, int artifactID, Guid remoteGuid, string correlationID)
- Task<IKeplerStream> DownloadTempFileAsync(int workspaceID, Guid remoteGuid, string correlationID)

Relativity.DataTransfer.Legacy.SDK.ImportExport.V1.Models

public class Artifact
- public int AccessControlListID { get; set; }
- public bool AccessControlListIsInherited { get; set; }
- public int ArtifactID { get; set; }
- public int ArtifactTypeID { get; set; }
- public int? ContainerID { get; set; }
- public int CreatedBy { get; set; }
- public DateTime CreatedOn { get; set; }
- public bool DeleteFlag { get; set; }
- public List<Guid> Guids { get; set; }
- public string Keywords { get; set; }
- public int LastModifiedBy { get; set; }
- public DateTime LastModifiedOn { get; set; }
- public string Notes { get; set; }
- public int? ParentArtifactID { get; set; }
- public string TextIdentifier { get; set; }
- public Artifact()
public class CaseInfo
- public int ArtifactID { get; set; }
- public bool AsImportAllowed { get; set; }
- public string DocumentPath { get; set; }
- public string DownloadHandlerURL { get; set; }
- public bool EnableDataGrid { get; set; }
- public bool ExportAllowed { get; set; }
- public int MatterArtifactID { get; set; }
- public string Name { get; set; }
- public int RootArtifactID { get; set; }
- public int RootFolderID { get; set; }
- public int StatusCodeArtifactID { get; set; }
- public CaseInfo()
public class ChoiceInfo
- public int ArtifactID { get; set; }
- public int CodeTypeID { get; set; }
- public string Name { get; set; }
- public int Order { get; set; }
- public int ParentArtifactID { get; set; }
- public ChoiceInfo()
public class Code : Artifact
- public int CodeType { get; set; }
- public bool IsActive { get; set; }
- public KeyboardShortcut KeyboardShortcut { get; set; }
- public string Name { get; set; }
- public int? OIHiliteStyleID { get; set; }
- public int Order { get; set; }
- public int[] RelativityApplications { get; set; }
- public bool UpdateInSearchEngine { get; set; }
- public Code()
public class DataSetWrapper : ISerializable
- public DataSetWrapper(DataSet dataSet)
- public DataSetWrapper(SerializationInfo info, StreamingContext context)
- public void GetObjectData(SerializationInfo info, StreamingContext context)
- public DataSet Unwrap()
public class ErrorFileKey
- public string LogKey { get; set; }
- public string OpticonKey { get; set; }
- public ErrorFileKey()
public enum ExecutionSource
- ImportAPI = 2
- Processing = 4
- Rdc = 1
- RIP = 3
- Unknown = 0
public class ExportDataWrapper : ISerializable
- public ExportDataWrapper(object[] exportData)
- public ExportDataWrapper(object[][] exportData)
- public ExportDataWrapper(SerializationInfo info, StreamingContext context)
- public void GetObjectData(SerializationInfo info, StreamingContext context)
- public object[][] Unwrap()
public class ExportStatistics
- 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 ExportSearchablePDFs { 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 string SubdirectoryPDFPrefix { 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 class Field : Artifact
- public bool AllowGroupBy { get; set; }
- public bool AllowHtml { get; set; }
- public bool AllowPivot { get; set; }
- public int ArtifactViewFieldID { get; set; }
- public int? AssociativeArtifactTypeID { get; set; }
- public bool AutoAddChoices { get; set; }
- public bool AvailableInViewer { get; set; }
- public int? CodeTypeID { get; set; }
- public string ColumnName { get; set; }
- public string DisplayName { get; set; }
- public string DisplayValueFalse { get; set; }
- public string DisplayValueTrue { get; set; }
- public bool EnableDataGrid { get; set; }
- public int FieldArtifactTypeID { get; set; }
- public FieldCategory FieldCategory { get; set; }
- public int FieldCategoryID { get; set; }
- public int FieldDisplayTypeID { get; set; }
- public int? FieldTreeView { get; set; }
- public FieldType FieldType { get; set; }
- public int FieldTypeID { get; set; }
- public string FilterType { get; set; }
- public string FormatString { get; set; }
- public string FriendlyName { get; set; }
- public ImportBehaviorChoice? ImportBehavior { get; set; }
- public bool IsArtifactBaseField { get; set; }
- public bool IsAvailableInChoiceTree { get; set; }
- public bool IsAvailableToAssociativeObjects { get; set; }
- public bool IsEditable { get; set; }
- public bool IsGroupByEnabled { get; set; }
- public bool IsIndexEnabled { get; set; }
- public bool IsLinked { get; set; }
- public bool IsReadOnlyInLayout { get; set; }
- public bool IsReflected { get; set; }
- public bool IsRelationalField { get; set; }
- public bool IsRemovable { get; set; }
- public bool IsRequired { get; set; }
- public bool IsSortable { get; set; }
- public bool IsSystemField { get; set; }
- public bool IsSystemOrRelationalField { get; set; }
- public bool IsUpdatable { get; set; }
- public bool IsVisible { get; set; }
- public KeyboardShortcut KeyboardShortcut { get; set; }
- public int LinkLayoutArtifactID { get; set; }
- public bool LinkType { get; set; }
- public int? MaxLength { get; set; }
- public string NameValue { get; set; }
- public ObjectsFieldParameters ObjectsFieldArgs { get; set; }
- public bool? OverlayBehavior { get; set; }
- public int? PopupPickerView { get; set; }
- public int? RelationalIndexViewArtifactID { get; set; }
- public RelationalFieldPane RelationalPane { get; set; }
- public int[] RelativityApplications { get; set; }
- public int? RepeatColumn { get; set; }
- public int Rows { get; set; }
- public string TableName { get; set; }
- public bool UseUnicodeEncoding { get; set; }
- public object Value { get; set; }
- public string Width { get; set; }
- public bool Wrapping { get; set; }
- public Field()
public enum FieldCategory
- AutoCreate = 7
- Batch = 15
- Comments = 4
- FileInfo = 10
- FileSize = 8
- FolderName = 9
- FullText = 1
- Generic = 0
- GenericSystem = 13
- Identifier = 2
- MarkupSetMarker = 12
- MultiReflected = 14
- ParentArtifact = 11
- ProductionMarker = 6
- Reflected = 3
- Relational = 5
public class FieldInfo
- public int ArtifactID { get; set; }
- public FieldCategory Category { get; set; }
- public int CodeTypeID { get; set; }
- public string DisplayName { get; set; }
- public bool EnableDataGrid { get; set; }
- public string FormatString { get; set; }
- public ImportBehaviorChoice? ImportBehavior { get; set; }
- public bool IsUnicodeEnabled { get; set; }
- public int TextLength { get; set; }
- public FieldType Type { get; set; }
- public FieldInfo()
public enum FieldType
- Boolean = 3
- Code = 5
- Currency = 7
- Date = 2
- Decimal = 6
- Empty = -1
- File = 9
- Integer = 1
- LayoutText = 12
- MultiCode = 8
- Object = 10
- Objects = 13
- OffTableText = 14
- Text = 4
- User = 11
- Varchar = 0
public class Folder : Artifact
- public string Name { get; set; }
- public Folder()
public class HealthCheckResult
- public bool IsHealthy { get; }
- public string Message { get; }
- public HealthCheckResult(bool isHealthy, string message)
public enum IAPICommunicationMode
- ForceKepler = 3
- ForceWebAPI = 2
- Kepler = 1
- WebAPI = 0
public enum ImageFileExportType
- MultiPageTiff = 1
- PDF = 2
- SinglePage = 0
public class ImageImportStatistics : ImportStatistics
- public int DestinationProductionArtifactID { get; set; }
- public int ExtractedTextDefaultEncodingCodePageID { get; set; }
- public bool ExtractedTextReplaced { get; set; }
- public bool SupportImageAutoNumbering { get; set; }
- public ImageImportStatistics()
public enum ImageLoadFileFormatType
- Ipro = 1
- IproFullText = 2
- Opticon = 0
public class ImageLoadInfo
- public ImportAuditLevel AuditLevel { get; set; }
- public bool Billable { get; set; }
- public string BulkFileName { get; set; }
- public string BulkFileSharePath { get; set; }
- public string DataGridFileName { get; set; }
- public int DestinationFolderArtifactID { get; set; }
- public bool DisableUserSecurityCheck { get; set; }
- public ExecutionSource ExecutionSource { get; set; }
- public int KeyFieldArtifactID { get; set; }
- public OverwriteType Overlay { get; set; }
- public int OverlayArtifactID { get; set; }
- public string Repository { get; set; }
- public string RunID { get; set; }
- public bool UploadFullText { get; set; }
- public bool UseBulkDataImport { get; set; }
- public ImageLoadInfo()
public enum ImagesToExportType
- Both = 2
- Original = 0
- Produced = 1
public enum ImportAuditLevel
- FullAudit = 0
- NoAudit = 2
- NoSnapshot = 1
public enum ImportBehaviorChoice
- ChoiceFieldIgnoreDuplicates = 4
- LeaveBlankValuesUnchanged = 1
- ObjectFieldContainsArtifactId = 3
- ReplaceBlankValuesWithIdentifier = 2
public class ImportStatistics
- public int[] BatchSizes { get; set; }
- public int DestinationFolderArtifactID { get; set; }
- public string FilesCopiedToRepository { get; set; }
- public string LoadFileName { get; set; }
- public int NumberOfDocumentsCreated { get; set; }
- public int NumberOfDocumentsUpdated { get; set; }
- public long NumberOfErrors { get; set; }
- public int NumberOfFilesLoaded { get; set; }
- public long NumberOfWarnings { get; set; }
- public OverlayBehavior? OverlayBehavior { get; set; }
- public int OverlayIdentifierFieldArtifactID { get; set; }
- public OverwriteType Overwrite { get; set; }
- public RepositoryConnectionType RepositoryConnection { get; set; }
- public int RunTimeInMilliseconds { get; set; }
- public bool SendNotification { get; set; }
- public int StartLine { get; set; }
- public long TotalFileSize { get; set; }
- public long TotalMetadataBytes { get; set; }
- public ImportStatistics()
public class InitializationResults
- public string[] ColumnNames { get; set; }
- public long RowCount { get; set; }
- public Guid RunId { get; set; }
- public InitializationResults()
public class IoResponse
- public string ErrorMessage { get; set; }
- public string ErrorText { get; set; }
- public string Filename { get; set; }
- public bool Success { get; set; }
- public IoResponse()
public class KeyboardShortcut
- public bool Alt { get; set; }
- public bool Ctrl { get; set; }
- public int Id { get; set; }
- public int Key { get; set; }
- public bool Shift { get; set; }
- public KeyboardShortcut()
public enum LoadFileFormat
- Csv = 0
- Custom = 2
- Dat = 1
- Html = 3
public class LoadRange
- public int Count { get; set; }
- public int StartIndex { get; set; }
- public LoadRange()
public class MassImportResults
- public int ArtifactsCreated { get; set; }
- public int ArtifactsUpdated { get; set; }
- public SoapExceptionDetail ExceptionDetail { get; set; }
- public int FilesProcessed { get; set; }
- public string RunID { get; set; }
- public MassImportResults()
public class NativeLoadInfo
- public ImportAuditLevel AuditLevel { get; set; }
- public bool Billable { get; set; }
- public string BulkFileSharePath { get; set; }
- public string BulkLoadFileFieldDelimiter { get; set; }
- public string CodeFileName { get; set; }
- public string DataFileName { get; set; }
- public string DataGridFileName { get; set; }
- public string DataGridOffsetFileName { get; set; }
- public bool DisableUserSecurityCheck { get; set; }
- public ExecutionSource ExecutionSource { get; set; }
- public int KeyFieldArtifactID { get; set; }
- public bool LinkDataGridRecords { get; set; }
- public bool LoadImportedFullTextFromServer { get; set; }
- public FieldInfo[] MappedFields { get; set; }
- public bool MoveDocumentsInAppendOverlayMode { get; set; }
- public string ObjectFileName { get; set; }
- public string OnBehalfOfUserToken { get; set; }
- public OverwriteType Overlay { get; set; }
- public int OverlayArtifactID { get; set; }
- public OverlayBehavior OverlayBehavior { get; set; }
- public LoadRange Range { get; set; }
- public string Repository { get; set; }
- public int RootFolderID { get; set; }
- public string RunID { get; set; }
- public bool UploadFiles { get; set; }
- public bool UseBulkDataImport { get; set; }
- public NativeLoadInfo()
public class ObjectImportStatistics : ImportStatistics
- public int ArtifactTypeID { get; set; }
- public char Bound { get; set; }
- public char Delimiter { get; set; }
- public int ExtractedTextFileEncodingCodePageID { get; set; }
- public bool ExtractedTextPointsToFile { get; set; }
- public int[][] FieldsMapped { get; set; }
- public string FileFieldColumnName { get; set; }
- public string FolderColumnName { get; set; }
- public int LoadFileEncodingCodePageID { get; set; }
- public char MultiValueDelimiter { get; set; }
- public char NestedValueDelimiter { get; set; }
- public char NewlineProxy { get; set; }
- public int NumberOfChoicesCreated { get; set; }
- public int NumberOfFoldersCreated { get; set; }
- public ObjectImportStatistics()
public class ObjectLoadInfo : NativeLoadInfo
- public int ArtifactTypeID { get; set; }
- public ObjectLoadInfo()
public class ObjectsFieldParameters
- public bool CreateForeignKeys { get; set; }
- public string FieldSchemaColumnName { get; set; }
- public bool ManageFieldExposure { get; set; }
- public bool ManageFieldExposureForSingleObjectField { get; set; }
- public string RelationalTableSchemaName { get; set; }
- public List<Guid> SiblingFieldGuids { get; set; }
- public string SiblingFieldName { get; set; }
- public string SiblingFieldSchemaColumnName { get; set; }
- public ObjectsFieldParameters()
public enum OverlayBehavior
- MergeAll = 1
- ReplaceAll = 2
- UseRelativityDefaults = 0
public enum OverwriteType
- Append = 0
- Both = 2
- Overlay = 1
public class ProductionInfo
- public bool BatesNumbering { get; set; }
- public int BeginBatesReflectedFieldId { get; set; }
- public bool DocumentsHaveRedactions { get; set; }
- public bool IncludeImageLevelNumberingForDocumentLevelNumbering { get; set; }
- public string Name { get; set; }
- public bool UseDocumentLevelNumbering { get; set; }
- public ProductionInfo()
public class RelationalFieldPane
- public string ColumnName { get; set; }
- public int FieldArtifactID { get; set; }
- public string HeaderText { get; set; }
- public byte[] IconFileData { get; set; }
- public string IconFilename { get; set; }
- public int PaneID { get; set; }
- public int PaneOrder { get; set; }
- public int RelationalViewArtifactID { get; set; }
- public RelationalFieldPane()
public enum RepositoryConnectionType
- Direct = 1
- Web = 0
public class SoapExceptionDetail
- public List<string> Details { get; set; }
- public string ExceptionFullText { get; set; }
- public string ExceptionMessage { get; set; }
- public string ExceptionTrace { get; set; }
- public string ExceptionType { get; set; }
- public SoapExceptionDetail()
public class TAPIConfiguration
- public bool IsCloudInstance { get; set; }
- public uint? TapiMaxAllowedTargetDataRateMbps { get; set; }
- public TAPIConfiguration()

Relativity.DataTransfer.Nodes

public class DirectoryNode : Node, IDirectory, INode
- public DateTime Modified { get; }
- public long? TotalFiles { get; }
- public long? TotalFolders { get; }
- public long? TotalSize { get; }
- public DirectoryNode(string name, INode parentNode, DateTime modified)
- public void SetTotalFiles(long totalFiles)
- public void SetTotalFolders(long totalFolders)
- public void SetTotalSize(long totalSize)
public class FileNode : Node, IFile, INode
- public string Extension { get; }
- public DateTime Modified { get; }
- public long Size { get; }
- public FileNode(string name, INode parentNode, DateTime modified, long size)
public interface IDirectory : INode
- DateTime Modified { get; }
- long? TotalFiles { get; }
- long? TotalFolders { get; }
- long? TotalSize { get; }
- void SetTotalFiles(long totalFiles)
- void SetTotalFolders(long totalFolders)
- void SetTotalSize(long totalSize)
public interface IDrive : INode
public interface IFile : INode
- string Extension { get; }
- DateTime Modified { get; }
- long Size { get; }
public interface INode
- string AbsolutePath { get; }
- INodeContext Context { get; }
- string HashedAbsolutePath { get; }
- string HashedName { get; }
- string Name { get; }
- INode Parent { get; }
public interface INodeContext : IEquatable<INodeContext>
- int ArtifactId { get; }
- string FileshareName { get; }
- string FilesharePath { get; }
public interface IRoot : INode
public sealed class LinuxDrive : Node, IDrive, INode
- public LinuxDrive()
public sealed class LocalDrive : Node, IDrive, INode
- public LocalDrive(string name)
public sealed class LocalRoot : Root
- public static IRoot Instance { get; }
public abstract class Node : INode, IEquatable<Node>
- public virtual string AbsolutePath { get; }
- public INodeContext Context { get; }
- public string HashedAbsolutePath { get; }
- public string HashedName { get; }
- public string Name { get; }
- public INode Parent { get; }
- protected Node(string name, INode parentNode)
- protected Node(string name, IRoot rootNode, INodeContext context)
- public static bool op_Equality(Node left, Node right)
- public static bool op_Inequality(Node left, Node right)
- public bool Equals(Node other)
public sealed class NodeContext : NodeContextBase
- public NodeContext(string fileshareName, int artifactId, string filesharePath)
public abstract class NodeContextBase : INodeContext, IEquatable<INodeContext>
- public int ArtifactId { get; }
- public string FileshareName { get; }
- public string FilesharePath { get; }
- protected NodeContextBase(string fileshareName, int artifactId, string filesharePath)
- public bool Equals(INodeContext other)
public static class NodeExtensions
- public static int CompareTo(this INode thisNode, INode otherNode)
- public static bool IsDirectory(this INode node)
- public static bool IsDrive(this INode node)
- public static bool IsFile(this INode node)
- public static bool IsRoot(this INode node)
public sealed class NullNodeContext : NodeContextBase
- public static INodeContext Instance { get; }
public static class PathConstants
- public static readonly char DirectorySeparatorAsChar
- public static string DevicePathSpecifier { get; }
- public static string DirectorySeparatorAsString { get; }
- public static string UncPathLongPrefix { get; }
- public static string UncPathShortPrefix { get; }
- public static string UnixDirectorySeparator { get; }
- public static char UnixSingleCharDirectorySeparator { get; }
- public static char WindowsSingleCharDirectorySeparator { get; }
public sealed class RemoteDrive : Node, IDrive, INode
- public RemoteDrive(INodeContext context)
public sealed class RemoteRoot : Root
- public static IRoot Instance { get; }
public class UncDrive : Node, IDrive, INode
- public UncDrive(string name)

Relativity.DataTransfer.Nodes.Internal

public abstract class Root : IRoot, INode, IEquatable<Root>
- public string AbsolutePath { get; }
- public INodeContext Context { get; }
- public string HashedAbsolutePath { get; }
- public string HashedName { get; }
- public string Name { get; }
- public INode Parent { get; }
- protected Root(string name)
- public static bool op_Equality(Root left, Root right)
- public static bool op_Inequality(Root left, Root right)
- public bool Equals(Root other)

Relativity.DataTransfer.Nodes.PathConversion

public abstract class CanonicalFormConverterBase : ICanonicalFormConverter
- protected CanonicalFormConverterBase()
- public string Convert(string rawPath)
- protected abstract string FixSlashes(string path)
- protected abstract string RemoveAdditionalSlashes(string path)
public class CanonicalFormConverterFactory : ICanonicalFormConverterFactory
- public CanonicalFormConverterFactory()
- public ICanonicalFormConverter Create(string path)
public interface ICanonicalFormConverter
- string Convert(string rawPath)
public interface ICanonicalFormConverterFactory
- ICanonicalFormConverter Create(string path)
public interface IContextHolder
- IPathHolder WithContext(INodeContext context)
public interface INodeBuilder
- IPathHolder WithContext(INodeContext context)
public interface INodeParser
- T Parse<T>() where T : INode
- bool TryParse<T>(out T node) where T : INode
public class InvalidPathCharacterException : Exception
- public InvalidPathCharacterException()
- public InvalidPathCharacterException(string message)
- public InvalidPathCharacterException(string message, Exception innerException)
- protected InvalidPathCharacterException(SerializationInfo info, StreamingContext context)
public class InvalidPathException : Exception
- public InvalidPathException()
- public InvalidPathException(string message)
- public InvalidPathException(string message, Exception innerException)
- protected InvalidPathException(SerializationInfo info, StreamingContext context)
public class InvalidWindowsCharacterException : InvalidPathCharacterException
- public InvalidWindowsCharacterException()
public interface IPathHolder
- INodeParser WithPath(string path)
public class LocalCanonicalFormConverter : CanonicalFormConverterBase
- public LocalCanonicalFormConverter()
public class NodeParser : INodeBuilder, INodeParser, IPathHolder, IContextHolder
- public static INodeBuilder Node()
- public T Parse<T>() where T : INode
- public IFile ParseFile()
- public bool TryParse<T>(out T node) where T : INode
- public IPathHolder WithContext(INodeContext context)
- public INodeParser WithPath(string path)
public class PathConversionPipelineException : Exception
- public PathConversionPipelineException()
- public PathConversionPipelineException(string message)
- public PathConversionPipelineException(string message, Exception innerException)
- protected PathConversionPipelineException(SerializationInfo info, StreamingContext context)
public class RemoteCanonicalFormConverter : CanonicalFormConverterBase
- public RemoteCanonicalFormConverter()

Relativity.Transfer

public class HttpClientConfiguration
- public const int DefaultChunkSize = 1048576
- public const int DefaultMaxRetryAttempts = 5
- public const double DefaultRetryTimeoutSeconds = 15
- public const double DefaultTimeoutSeconds = 300
- public int ChunkSize { get; set; }
- public CookieContainer CookieContainer { get; set; }
- public int MaxRetryAttempts { get; set; }
- public double RetryTimeoutSeconds { get; set; }
- public double TimeoutSeconds { get; set; }
- public HttpClientConfiguration()
public interface IRelativityTransferHost : IDisposable
- IFileStorageSearch CreateFileStorageSearch(ClientConfiguration configuration)
- Task<Workspace> GetWorkspaceAsync(int workspaceArtifactId, ClientConfiguration configuration, CancellationToken token)
- Task<Workspace> GetWorkspaceAsync(ClientConfiguration configuration)
- Task<Workspace> GetWorkspaceAsync(ClientConfiguration configuration, CancellationToken token)
- Task VersionCheckAsync(ClientConfiguration configuration)
- Task VersionCheckAsync(ClientConfiguration configuration, CancellationToken token)
public class RelativityTransferHost : IRelativityTransferHost, IDisposable
- public static Task VersionCheckAsync(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration)
- public static Task VersionCheckAsync(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, CancellationToken token)
- public static Task VersionCheckAsync(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, ITransferLog log, CancellationToken token)
- public IFileStorageSearch CreateFileStorageSearch(ClientConfiguration configuration)
- public Task<Workspace> GetWorkspaceAsync(ClientConfiguration configuration)
- public Task<Workspace> GetWorkspaceAsync(ClientConfiguration configuration, CancellationToken token)
- public Task<Workspace> GetWorkspaceAsync(int workspaceArtifactId, ClientConfiguration configuration, CancellationToken token)
- public Task VersionCheckAsync(ClientConfiguration configuration)
- public Task VersionCheckAsync(ClientConfiguration configuration, CancellationToken token)
public sealed class AsperaCredential : IEquatable<AsperaCredential>
- public const string AsperaNodeCredentialType = "AsperaNode"
public sealed class AsperaCredentials
public class AsperaNodeException : Exception
public class BasicAuthenticationCredential : IHttpCredential
- public Credentials CreateRelativityCredentials()
- public void RefreshCredentials()
public class BearerTokenCredential : IHttpCredential
- public BearerTokenCredential()
- public BearerTokenCredential(string token, IAuthenticationTokenProvider authTokenProvider)
- public Credentials CreateRelativityCredentials()
- public void RefreshCredentials()
public class ClientConfiguration : Dictionary<string, object>
- public const bool DefaultPreCalculateJobSize = false
- public const bool DefaultUseLegacyWebApi = false
- public bool PreCalculateJobSize { get; set; }
- public bool SavingMemoryMode { get; set; }
- public bool UseLegacyWebApi { get; set; }
public static class ClientConfigurationKeys
- public const string AscpVersion = "ascp-version"
- public const string PreCalculateJobSize = "pre-calculate-jobsize"
- public const string SavingMemoryMode = "saving-memory-mode"
- public const string UseAscp4 = "use-ascp4"
- public const string UseLegacyWebApi = "use-legacy-webapi"
public class ClientLimits
- public int? MaxClientSupportedPathLength { get; set; }
- public int? TransferFileNameLength { get; set; }
- public int MaxSupportedPathLength { get; set; }
- public int TransferFileNameLength { get; set; }
public abstract class ConnectionServiceBase : IDisposable
- protected virtual Task RunPostTestsAsync(CancellationToken token)
- protected virtual Task RunPortsTestAsync(CancellationToken token)
public class DiagnosticsConfiguration
- public bool UseLegacyWebApi { get; set; }
public class EnumeratedPathsResult
- public IEnumerable<string> ErrorPaths { get; }
- public IEnumerable<ErrorPath> ErrorPaths { get; }
- public EnumeratedPathsResult(IEnumerable<string> searchPaths, IEnumerable<TransferPath> paths, IEnumerable<string> errorPaths, long totalDirectories, bool localPaths, TimeSpan elapsed)
- public EnumeratedPathsResult(IEnumerable<string> searchPaths, IEnumerable<TransferPath> paths, IEnumerable<ErrorPath> errorPaths, long totalDirectories, bool localPaths, TimeSpan elapsed)
public class ErrorPath
- public string Path { get; set; }
- public string Reason { get; set; }
- public ErrorPath(string path, string reason)
public sealed class FileShareResourceServer
- public AsperaCredentials AsperaCredentials { get; }
- public AsperaCredential AsperaCredential { get; }
- public FileShareResourceServer(int artifactId, AsperaCredentials credentials, string name, ResourceServerType serverType, string uncPath, bool cloudInstance)
- public FileShareResourceServer(int artifactId, AsperaCredentials credentials, string name, ResourceServerType serverType, string uncPath, bool cloudInstance, ResourcePool pool)
- public FileShareResourceServer(int artifactId, AsperaCredential credential, string name, ResourceServerType serverType, string uncPath, bool cloudInstance)
- public FileShareResourceServer(int artifactId, AsperaCredential credential, string name, ResourceServerType serverType, string uncPath, bool cloudInstance, ResourcePool pool)
public class GlobalSettings : IGlobalSettings
- public const bool DefaultApmFireAndForgetEnabled = true
- public const bool DefaultLogPackageSourceFiles = true
- public const int DefaultMaxAllowedTargetDataRateMbps = 600
- public const long DefaultMaxFilesPerBatch = 50000
- public const int DefaultMaxFilesPerBatch = 50000
- public bool ApmFireAndForgetEnabled { get; set; }
- public bool LogPackageSourceFiles { get; set; }
- public int MaxAllowedTargetDataRateMbps { get; set; }
- public long MaxFilesPerBatch { get; set; }
- public int MaxFilesPerBatch { get; set; }
- public int NodePageSize { get; set; }
public interface IAuthenticationTokenProvider
- string GenerateToken()
public interface IBatchSerializer
- void AddTransferPath(TransferPath path)
- Task<SerializedPathsResult> CreateBatchAsync()
public interface ICredentialService
- Task<AsperaCredentials> GetResourceServerAsperaCredentialsAsync(int resourceServerArtifactId, CancellationToken token)
- Task<AsperaCredential> GetResourceServerAsperaCredentialAsync(int resourceServerArtifactId, CancellationToken token)
public interface IFileShareService
- Task<BrowseDirectoryResponseDto> BrowseDirectoryAsync(string path, int page, int pageSize, int enumerateMax, CancellationToken token)
- Task DeleteDirectoriesAsync(IEnumerable<string> paths, CancellationToken token)
- Task DeleteFilesAsync(IEnumerable<string> paths, CancellationToken token)
- Task<bool> DirectoryEmptyAsync(string path, CancellationToken token)
- Task<FileShareItem> GetFileShareItemAsync(string path, CancellationToken token)
- Task<IEnumerable<FileShareItem>> GetFileShareItemsAsync(IEnumerable<string> directories, IEnumerable<string> files, CancellationToken token)
- Task<QueryPropertiesResponseDto> GetItemAttributesAsync(string path, CancellationToken token)
- Task<bool> ItemExistsAsync(string path, CancellationToken token)
- Task<bool> ItemsExistAsync(IEnumerable<string> paths, CancellationToken token)
public interface IHttpCredential
- Credentials CreateRelativityCredentials()
- void RefreshCredentials()
public class IntegratedSecurityCredential : IHttpCredential
- public Credentials CreateRelativityCredentials()
- public void RefreshCredentials()
public interface IPackageLibrary : IDisposable
public interface IPackageLibraryMetadata
public interface IPackageResult
public interface IPackageTransferResult : ITransferResult, IPackageResult
public interface IPathValidationFactory
- IPathValidationProvider CreatePathValidationProvider()
public interface IPathValidationProvider : IPathValidator
- void Register(IPathValidator pathValidator)
public interface IPathValidator
- PathValidationResult Validate(TransferPath transferPath)
- void Validate(IEnumerable<string> searchPaths, string targetPath)
public interface IRelativityManagerService : IDisposable
- Task<string> GetBcpSharePathAsync(int workspaceId, CancellationToken token)
public interface IRelativityServiceFactory
- IPathValidationProvider PathValidationProvider { get; }
- IFileShareService CreateFileShareService(int fileShareId)
- IInstanceSettingService CreateInstanceSettingService()
- IRelativityManagerService CreateRelativityManagerService(IUserManagerService service)
- ITargetRateThrottler CreateTargetRateThrottler()
- ITargetRateValidator CreateTargetRateValidator()
- IUserManagerService CreateUserManagerService()
public interface ITargetRateThrottler
- void ThrottleToMaxAllowedValue(ClientConfiguration configuration)
- int ThrottleToMaxAllowedValue(int targetRateMbps)
public interface ITargetRateValidator
- void Validate(int minRateMbps, int targetRateMbps)
- void Validate(ClientConfiguration configuration)
public interface ITransferClient : IDisposable
- ClientLimits ClientLimits { get; }
- IBatchSerializer CreateBatchSerializer(string batchDirectory, TransferDirection direction, PathEnumeratorContext context)
- Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, PackageContext context)
- Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, PackageContext context, CancellationToken token)
- Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, IEnumerable<SerializedBatch> batches, PackageContext context, CancellationToken token)
- Task<ITransferResult> TransferAsync(ITransferRequest request, TimeSpan completionTimeout, CancellationToken token)
public interface ITransferIssue : IEquatable<ITransferIssue>
- bool IsRetryable { get; }
public interface ITransferIssueBuilder
- ITransferIssue Build()
- ITransferIssueBuilder FromJobPath(JobTransferPath jobPath)
- ITransferIssueBuilder FromPath(TransferPath jobPath)
- ITransferIssueBuilder WithAttributes(IssueAttributes attributes)
- ITransferIssueBuilder WithIndex(int index)
- ITransferIssueBuilder WithMaxRetryAttempts(int maxRetryAttempts)
- ITransferIssueBuilder WithMessage(string message)
- ITransferIssueBuilder WithRetryable(bool retrayable)
- ITransferIssueBuilder WithRetryAttempt(int retryAttempt)
public interface ITransferJob : IDisposable
- void ChangeDataRate(int minRateMbps, int targetRateMbps)
- void ChangeDataRate(int minRateMbps, int targetRateMbps, CancellationToken token)
- Task ChangeDataRateAsync(int minRateMbps, int targetRateMbps)
- Task ChangeDataRateAsync(int minRateMbps, int targetRateMbps, CancellationToken token)
- int ChangeDataRate(int minRateMbps, int targetRateMbps)
- int ChangeDataRate(int minRateMbps, int targetRateMbps, CancellationToken token)
- Task<int> ChangeDataRateAsync(int minRateMbps, int targetRateMbps)
- Task<int> ChangeDataRateAsync(int minRateMbps, int targetRateMbps, CancellationToken token)
- void ValidatePath(TransferPath path)
- PathValidationResult ValidatePath(TransferPath path)
public interface ITransferJobService
- void Initialize()
- bool IsCompleted(TransferPathStatus status)
- bool IsRetrayable(TransferPathStatus status)
public interface ITransferResult
- int Attempts { get; }
- List<long> TotalRequestedBytesPerAttempt { get; }
- List<long> TotalRequestedFilesPerAttempt { get; }
public class LargeFileProgress : IProgress<LargeFileProgressEventArgs>
- public double LargeFileProgressRateSeconds { get; }
- public LargeFileProgress(Action<LargeFileProgressEventArgs> handler, double largeFileProgressRateSeconds, JobTransferPath jobTransferPath)
- public LargeFileProgress(Action<LargeFileProgressEventArgs> handler, double largeFileProgressRateSeconds)
- public void Report(LargeFileProgressEventArgs value)
public static class LogExtensions
- public static void LogTransferDebug(this ITransferLog log, ITransferRequest request, string messageTemplate, object[] propertyValues)
- public static void LogTransferDebug(this ITransferLog log, Exception exception, ITransferRequest request, string messageTemplate, object[] propertyValues)
- public static void LogTransferError(this ITransferLog log, ITransferRequest request, string messageTemplate, object[] propertyValues)
- public static void LogTransferError(this ITransferLog log, Exception exception, ITransferRequest request, string messageTemplate, object[] propertyValues)
- public static void LogTransferFatal(this ITransferLog log, ITransferRequest request, string messageTemplate, object[] propertyValues)
- public static void LogTransferFatal(this ITransferLog log, Exception exception, ITransferRequest request, string messageTemplate, object[] propertyValues)
- public static void LogTransferInformation(this ITransferLog log, ITransferRequest request, string messageTemplate, object[] propertyValues)
- public static void LogTransferInformation(this ITransferLog log, Exception exception, ITransferRequest request, string messageTemplate, object[] propertyValues)
- public static void LogTransferStatistics(this ITransferLog log, ITransferRequest request, ITransferStatistics statistics)
- public static void LogTransferWarning(this ITransferLog log, ITransferRequest request, string messageTemplate, object[] propertyValues)
- public static void LogTransferWarning(this ITransferLog log, Exception exception, ITransferRequest request, string messageTemplate, object[] propertyValues)
public sealed class PackageConfiguration : Dictionary<string, object>
public sealed class PackageContext
public class PackageEventArgs : EventArgs
public class PackageFileMetadata
public abstract class PackageLibraryBase : IPackageLibrary, IDisposable
public sealed class PackageLibraryMetadataAttribute : ExportAttribute, IPackageLibraryMetadata
public class PackageProgressEventArgs : EventArgs
public class PackageQueuedEventArgs : EventArgs
public sealed class PackageResult : IPackageResult
public sealed class PackageTransferResult : IPackageTransferResult, ITransferResult, IPackageResult
public class PackagingFileMetadataEventArgs : EventArgs
public abstract class PathEnumeratorBase : IPathEnumerator
- protected ClientLimits ClientLimits { get; }
- protected PathEnumeratorBase(ITransferLog log, ClientLimits limits, IFileSystemService fileSystemService)
- protected abstract Task OnInitializeAsync(PathEnumeratorContext context, CancellationToken token)
- protected virtual void OnInitialize(PathEnumeratorContext context, CancellationToken token)
public static class PathHelper
- public static string GetTargetFilePath(string sourcePath, string targetPath, string targetFileName)
public class PathValidationProvider : IPathValidationProvider, IPathValidator
- public PathValidationProvider()
- public void Register(IPathValidator pathValidator)
- public PathValidationResult Validate(TransferPath transferPath)
- public void Validate(IEnumerable<string> searchPaths, string targetPath)
public class PathValidationResult
- public string ErrorMessage { get; }
- public bool IsOk { get; }
- public PathValidationStatus Status { get; }
- public TransferPath ValidatedPath { get; }
- public static PathValidationResult Error(TransferPath validatedPath, PathValidationStatus status, string errorMessage)
- public static PathValidationResult Ok(TransferPath transferPath)
- public ErrorPath CreatesErrorPath()
public enum PathValidationStatus
- Ok = 0
- SourcePathTooLong = 1
- TargetPathToLong = 2
- WrongFileType = 3
public sealed class RelativityFileShare : RelativityFileShareBase
- public RelativityFileShare(int artifactId, string name, string path, AsperaCredentials credentials, bool cloudInstance)
- public RelativityFileShare(int artifactId, string name, string path, ResourceServerType resourceServerType, AsperaCredentials credentials, bool cloudInstance)
- public RelativityFileShare(int artifactId, string name, string path, AsperaCredential credentials, bool cloudInstance)
- public RelativityFileShare(int artifactId, string name, string path, ResourceServerType resourceServerType, AsperaCredential credential, bool cloudInstance)
public abstract class RelativityFileShareBase : FileStorageBase
- public AsperaCredentials AsperaCredentials { get; protected set; }
- public AsperaCredential AsperaCredential { get; protected set; }
- public AsperaCredential NodeCredential { get; }
- public AsperaCredential TransferCredential { get; }
public abstract class RemotePathResolverBase : IRemotePathResolver
- protected ITransferLog transferLog
- protected RemotePathResolverBase()
- protected RemotePathResolverBase(ITransferLog transferLog)
public abstract class RestServiceBase
- protected RestServiceBase(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, ITransferLog log)
public sealed class SerializedPathsResult
- public IEnumerable<string> ErrorPaths { get; }
- public IEnumerable<ErrorPath> ErrorPaths { get; }
- public SerializedPathsResult(IEnumerable<string> searchPaths, IEnumerable<SerializedBatch> batches, IEnumerable<string> errorPaths, bool localPaths, TimeSpan elapsed)
- public SerializedPathsResult(IEnumerable<string> searchPaths, IEnumerable<SerializedBatch> batches, IEnumerable<ErrorPath> errorPaths, bool localPaths, TimeSpan elapsed)
public sealed class SqlResourceServer
- public AsperaCredentials AsperaCredentials { get; }
- public AsperaCredential AsperaCredential { get; }
- public SqlResourceServer(int artifactId, AsperaCredentials credentials, string name, ResourceServerType serverType, string bcpPath, bool cloudInstance)
- public SqlResourceServer(int artifactId, AsperaCredential credential, string name, ResourceServerType serverType, string bcpPath, bool cloudInstance)
public abstract class TransferClientBase : ITransferClient, IDisposable
- public ClientLimits ClientLimits { get; set; }
- protected IPathValidationProvider PathValidationProvider { get; }
- protected TransferClientBase(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, IWorkspaceService workspaceService, ITransferLog log, IFileSystemService fileSystemService, Guid id, WellKnownTransferClient client, string name, string displayName)
- protected TransferClientBase(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, IWorkspaceService workspaceService, ITransferLog log, Guid id, WellKnownTransferClient client, string name, string displayName, IPathValidationFactory pathValidationFactory)
- protected TransferClientBase(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, IWorkspaceService workspaceService, ITransferLog log, IFileSystemService fileSystemService, Guid id, WellKnownTransferClient client, string name, string displayName, IPathValidationFactory pathValidationFactory)
- public IBatchSerializer CreateBatchSerializer(string batchDirectory, TransferDirection direction, PathEnumeratorContext context)
- public Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, PackageContext context)
- public Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, PackageContext context, CancellationToken token)
- public Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, IEnumerable<SerializedBatch> batches, PackageContext context, CancellationToken token)
- public virtual Task<ITransferResult> TransferAsync(ITransferRequest request, TimeSpan completionTimeout, CancellationToken token)
public static class TransferClientConstants
- public const string AzureBlobClientDisplayName = "Azure Blob"
- public const string AzureBlobClientId = "962EE9FF-6E12-4EBF-A0C3-F2BB5B1547C4"
- public const string AzureBlobClientName = "Azure Blob"
- public const string AzureFilesClientDisplayName = "Azure Files"
- public const string AzureFilesClientId = "302B33BB-1CC5-4901-B1CD-78D755986E7A"
- public const string AzureFilesClientName = "Azure Files"
- public const string HttpClientDiplayName = "Web"
- public const string HttpClientDisplayName = "Web"
public sealed class TransferContext
- public event EventHandler<TransferPathIssueEventArgs> TransferJobIssue
- public void PublishTransferJobIssue(ITransferRequest request, ITransferIssue issue)
public class TransferIssue : ITransferIssue, IEquatable<ITransferIssue>
- public bool IsRetryable { get; set; }
public abstract class TransferJobBase : ITransferJob, IDisposable
- public int? ClientMaxSupportedPathLength { get; set; }
- public int? ClientTransferFileNameLength { get; set; }
- public void ChangeDataRate(int minRateMbps, int targetRateMbps)
- public void ChangeDataRate(int minRateMbps, int targetRateMbps, CancellationToken token)
- public Task ChangeDataRateAsync(int minRateMbps, int targetRateMbps)
- public Task ChangeDataRateAsync(int minRateMbps, int targetRateMbps, CancellationToken token)
- public int ChangeDataRate(int minRateMbps, int targetRateMbps)
- public int ChangeDataRate(int minRateMbps, int targetRateMbps, CancellationToken token)
- public Task<int> ChangeDataRateAsync(int minRateMbps, int targetRateMbps)
- public Task<int> ChangeDataRateAsync(int minRateMbps, int targetRateMbps, CancellationToken token)
- protected void LogErrorPath(string path)
- public void ValidatePath(TransferPath path)
- protected void ValidateSourcePathLength(TransferPath path)
- public PathValidationResult ValidatePath(TransferPath path)
- protected virtual void ValidateTargetPathLength(TransferPath path)
public class TransferJobService : ITransferJobService
- public IPathStatusChecker RetryablePathChecker { get; set; }
- public void Initialize()
- public bool IsCompleted(TransferPathStatus status)
- public bool IsRetrayable(TransferPathStatus status)
public abstract class TransferPathCommandBase : ITransferPathCommand
- protected void PublishTransferJobIssue(ITransferIssue issue)
- protected bool ShouldPublishLargeFileProgress(int chunkNumber, int totalChunks, DateTime timestamp)
public class TransferPathIssueEventArgs : EventArgs
- public bool IsRetryable { get; }
public class TransferPathProgressEventArgs : EventArgs
- public bool Completed { get; }
- public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, TransferPathStatus status)
- public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, TransferPathStatus status, DateTime? startTime, DateTime? endTime, long bytesTransferred)
- public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, TransferPathStatus status, DateTime? startTime, DateTime? endTime, long bytesTransferred, string checksum)
- public string TargetFile { get; }
- public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, string targetFile, TransferPathStatus status, bool completed)
- public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, string targetFile, TransferPathStatus status, bool completed, DateTime? startTime, DateTime? endTime, long bytesTransferred)
- public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, string targetFile, TransferPathStatus status, bool completed, DateTime? startTime, DateTime? endTime, long bytesTransferred, string checksum)
public class TransferPathResult
- public bool Completed { get; set; }
- public string TargetFile { get; }
public sealed class TransferResult : ITransferResult
- public int Attempts { get; }
- public List<long> TotalRequestedBytesPerAttempt { get; set; }
- public List<long> TotalRequestedFilesPerAttempt { get; set; }
public static class UncPathToDocRootConverter
- public static string Convert(string uncPath, bool validateConvention = true)
- public static void ValidateNamingConvention(string uncPath)
public enum WellKnownPackageLibrary
public enum WellKnownTransferClient
- AzureBlob = 1
- AzureFiles = 2
public class WorkspaceService : RestServiceBase, IWorkspaceService
- public WorkspaceService(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, ITransferLog log)

Relativity.Transfer.Aspera

public enum AscpVersion
- Experimental = 2
- Stable = 1
public class AsperaClientConfiguration : ClientConfiguration
- public const AscpVersion DefaultAscpVersion = 1
- public const int DefaultDatagramSize = 0
- public const string DefaultResumeSuffix = ".aspx"
- public const bool DefaultUseAscp4 = false
- public const string OldDefaultTestConnectionDestinationPath = "/FTA/TestConnectionResults"
- public AscpVersion AscpClientVersion { get; set; }
- public int DatagramSize { get; set; }
- public bool LegacyPortCheck { get; set; }
- public string NodeAccountPassword { get; set; }
- public string NodeAccountUserName { get; set; }
- public Uri NodeHost { get; set; }
- public bool ReportNotOverriddenFiles { get; set; }
- public string ResumeSuffix { get; set; }
- public bool UseAscp4 { get; set; }
public static class AsperaClientConfigurationKeys
- public const string DatagramSize = "aspera-datagram-size"
- public const string LegacyPortCheck = "aspera-legacy-port-check"
- public const string NodeAccountPassword = "node-aspera-account-password"
- public const string NodeAccountUserName = "node-aspera-account-username"
- public const string NodeHost = "node-aspera-host"
- public const string ReportNotOverriddenFiles = "aspera-report-skipped-files"
- public const string ResumeSuffix = "aspera-resume-suffix"
public class AsperaUncBcpPathResolver : RemotePathResolverBase
- public AsperaUncBcpPathResolver()
- public AsperaUncBcpPathResolver(string bcpUncPath, string rootFolder)
- public AsperaUncBcpPathResolver(ITransferLog transferLog)
- public AsperaUncBcpPathResolver(string bcpUncPath, string rootFolder, ITransferLog transferLog)
public class AsperaUncPathResolver : RemotePathResolverBase
- public AsperaUncPathResolver()
- public AsperaUncPathResolver(string fileShareUncPath, int docRootLevels)
- public AsperaUncPathResolver(ITransferLog transferLog)
- public AsperaUncPathResolver(string fileShareUncPath, int docRootLevels, ITransferLog transferLog)
public static class XferParamsExtensions
- public static string Dump(this XferParams xferParams)

Relativity.Transfer.Aspera.Enumeration.Filters

public class AspxExtensionFilter : INodeFilter, IFilter<INode>
- public string Message { get; }
- public AspxExtensionFilter()
- public bool IsMet(INode node)
public class PathLengthFilter : INodeFilter, IFilter<INode>
- public string Message { get; }
- public PathLengthFilter()
- public bool IsMet(INode node)

Relativity.Transfer.Aspera.Issues

public static class IssuesDumper
- public static string Dump(IReadOnlyCollection<ITransferIssue> issues)

Relativity.Transfer.Dto

public class BrowseDirectoryResponseDto : FileShareResponseBaseDto
- public FileShareItem[] Items { get; set; }
- public int TotalCount { get; set; }
- public BrowseDirectoryResponseDto()
public class FileShareItem
- public DateTime Modified { get; set; }
- public string Name { get; set; }
- public string Path { get; set; }
- public string PathType { get; set; }
- public long Size { get; set; }
- public FileShareItem()
- public bool IsFile()
public enum FileShareOperationErrorCode
- AccessDenied = 8
- DirectoryMissingDuringProcessing = 18
- DirectoryNotEmpty = 12
- FailedToProcessItem = 19
- HostBreakDown = 15
- HostDisabled = 14
- InvalidName = 6
- InvalidPageNumber = 10
- InvalidPageSizeNumber = 11
- InvalidPath = 4
- NameDuplicated = 17
- NoSourcePaths = 1
- NotEnoughSpaceOnDisk = 3
- OperationNotFound = 16
- PathAlreadyExists = 7
- PathDoesNotExist = 2
- PathIsNotDirectory = 5
- PathNotFound = 9
- QueryItemsLimitExceeded = 13
- Unknown = 0
public enum FileShareOperationState
- Calculating = 1
- Canceled = 3
- Deleted = 9
- Failed = 4
- Finished = 5
- FinishedWithErrors = 6
- Indeterminate = 7
- InProgress = 2
- New = 0
- Pending = 8
public class FileShareResponseBaseDto
- public string Error { get; set; }
- public FileShareOperationErrorCode ErrorCode { get; set; }
- public FileShareOperationState State { get; set; }
- public FileShareResponseBaseDto()
public class GetItemRequestDto
- public int FileshareId { get; set; }
- public string Path { get; set; }
- public GetItemRequestDto()
public class GetItemResponseDto : FileShareResponseBaseDto
- public FileShareItem Item { get; set; }
- public GetItemResponseDto()
public class GetItemsRequestDto
- public string[] DirectoriesPaths { get; set; }
- public int FileshareId { get; set; }
- public string[] FilesPaths { get; set; }
- public GetItemsRequestDto()
public class GetItemsResponseDto : FileShareResponseBaseDto
- public FileShareItem[] Items { get; set; }
- public GetItemsResponseDto()
public class ItemExistsRequestDto
- public int FileshareId { get; set; }
- public string Path { get; set; }
- public ItemExistsRequestDto()
public class ItemExistsResponseDto : FileShareResponseBaseDto
- public bool Exist { get; set; }
- public ItemExistsResponseDto()
public class ItemsExistRequestDto
- public int FileshareId { get; set; }
- public string[] Paths { get; set; }
- public ItemsExistRequestDto()
public class ItemsExistResponseDto : FileShareResponseBaseDto
- public bool Exist { get; set; }
- public ItemsExistResponseDto()
public class QueryPropertiesResponseDto : FileShareResponseBaseDto
- public long TotalFiles { get; set; }
- public long TotalFolders { get; set; }
- public long TotalSize { get; set; }
- public QueryPropertiesResponseDto()

Relativity.Transfer.Enumeration

public sealed class EnumerationBuilder : IEnumerationFinalActionsBuilder, IEnumerationNecessaryActionsBuilder
- public static IEnumerationNecessaryActionsBuilder ForDownload(IEnumeratorProvider enumerator, ITransferLog logger, Guid correlationId)
- public static IEnumerationNecessaryActionsBuilder ForUpload(ITransferLog logger, Guid correlationId)
- public static IEnumerationNecessaryActionsBuilder ForUpload(IEnumeratorProvider enumerator, ITransferLog logger, Guid correlationId)
- public IEnumerationOrchestrator Create()
- public IEnumerationFinalActionsBuilder StartFrom(IEnumerable<INode> nodesOfSameParent)
- public IEnumerationFinalActionsBuilder StartFrom(IEnumerable<INode> nodesUnderRootNode, INode rootNode)
- public IEnumerationFinalActionsBuilder WithBatching(INode destinationNode, IDirectory batchSerializationDirectory, IEnumerationHandler<SerializedBatch> batchCreatedHandler)
- public IEnumerationFinalActionsBuilder WithFilters(IEnumerable<INodeFilter> filters, IEnumerationHandler<EnumerationIssue> skippedItemHandler)
- public IEnumerationFinalActionsBuilder WithStatistics(IEnumerationHandler<EnumerationStatistic> statisticsHandler)
public class EnumerationException : Exception
- public int Error { get; }
- public EnumerationException(int error)
- public EnumerationException(int error, string message)
- public EnumerationException(string message, Exception innerException)
public class EnumerationIssue
- public string ErrorMessage { get; }
- public string Path { get; }
- public EnumerationIssue(string path, string errorMessage)
public class EnumerationOrchestrator : IEnumerationOrchestrator
- public void ExecuteEnumerate(CancellationToken token)
- public IEnumerable<INode> LazyEnumerate(CancellationToken token)
public class EnumerationStatistic
- public long TotalBytes { get; }
- public long TotalEmptyDirectories { get; }
- public long TotalFiles { get; }
public class PathDoesNotExistException : EnumerationException
- public PathDoesNotExistException()
- public PathDoesNotExistException(string message, Exception innerException)
public class SynchronousHandler<T> : IEnumerationHandler<T>
- public SynchronousHandler(Action<T> action)
- public void Report(T value)

Relativity.Transfer.Enumeration.Filters

public interface IFilter<T>
- string Message { get; }
- bool IsMet(T item)
public interface INodeFilter : IFilter<INode>
public class NoReadAccessFileNodeFilter : INodeFilter, IFilter<INode>
- public string Message { get; }
- public NoReadAccessFileNodeFilter()
- public bool IsMet(INode item)
public class R1PathSizeFilter : INodeFilter, IFilter<INode>
- public string Message { get; }
- public R1PathSizeFilter(IEnumerable<INode> transferredNodes, IDirectory targetDirectory)
- public bool IsMet(INode item)

Relativity.Transfer.Resources

public class CoreStrings

API Differences between 7.4.9 and 5.0.2

Relativity.DataTransfer.Legacy.SDK.ImportExport

Relativity.DataTransfer.Legacy.SDK.ImportExport.V1

Relativity.DataTransfer.Legacy.SDK.ImportExport.V1.Models

Relativity.DataTransfer.Nodes

Relativity.DataTransfer.Nodes.Internal

Relativity.DataTransfer.Nodes.PathConversion

Relativity.Transfer

Relativity.Transfer.Aspera

Relativity.Transfer.Aspera.Enumeration.Filters

Relativity.Transfer.Aspera.Issues

Relativity.Transfer.Dto

Relativity.Transfer.Enumeration

Relativity.Transfer.Enumeration.Filters

Relativity.Transfer.Enumeration.Interfaces

Relativity.Transfer.Exceptions

Relativity.Transfer.Paths

Relativity.Transfer.Resources