<PackageReference Include="Relativity.Server.Import.SDK" Version="24000.1.1" />

ITapiBridge

public interface ITapiBridge : IDisposable
Represents an abstract object to provide Transfer API object services to the transfer bridges.
TapiClient Client { get; }

Gets the current transfer client.

Guid InstanceId { get; }

Gets the transfer bridge instance unique identifier. This value is assigned for the lifecycle of each instance, regardless of whether jobs are batched or in web fallback mode. It's recommended to include this value with verbose logs where per-instance details may provide added insight.

Gets the transfer totals for the current job.

Gets the transfer parameters.

Occurs when the transfer client is changed.

Occurs when a non-fatal error message is available.

Occurs when there is a fatal error in the transfer.

Occurs when a large file transfer is in progress.

Occurs when a path transfer progress has started or completed.

Occurs when transfer statistics are available.

Occurs when a status message is available.

Occurs when a warning message is available.

string AddPath(TransferPath path)

Adds the path to a transfer job.

Optionally force creating the transfer client instead of the default behavior where construction is deferred until a transfer request is made. Once the transfer mode is determined, TapiClientChanged is published immediately.

TapiTotals WaitForTransfers(string waitMessage, string successMessage, string errorMessage, bool keepJobAlive)

Waits for all pending transfers in the queue to complete and returns the transfer totals. This method returns immediately if transfer paths haven't been added to the queue.