Interface IFileTransferFactory<T>
The File Transfer interface
Namespace: Catalyst.Abstractions.FileTransfer
Assembly: Catalyst.Abstractions.dll
Syntax
public interface IFileTransferFactory<T>
where T : IFileTransferInformationType Parameters
| Name | Description |
|---|---|
| T |
Properties
| Improve this Doc View SourceKeys
Gets the keys.
Declaration
Guid[] Keys { get; }Property Value
| Type | Description |
|---|---|
| System.Guid[] | The keys. |
Methods
| Improve this Doc View SourceFileTransferAsync(ICorrelationId, CancellationToken)
Files the transfer asynchronous.
Declaration
Task FileTransferAsync(ICorrelationId correlationId, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| ICorrelationId | correlationId | The correlation unique identifier. |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
GetFileTransferInformation(ICorrelationId)
Gets the file transfer information.
Declaration
T GetFileTransferInformation(ICorrelationId correlationId)Parameters
| Type | Name | Description |
|---|---|---|
| ICorrelationId | correlationId | The correlation unique identifier. |
Returns
| Type | Description |
|---|---|
| T |
RegisterTransfer(T)
Registers the transfer.
Declaration
FileTransferResponseCodeTypes RegisterTransfer(T fileTransferInformation)Parameters
| Type | Name | Description |
|---|---|---|
| T | fileTransferInformation | The file transfer information. |
Returns
| Type | Description |
|---|---|
| FileTransferResponseCodeTypes | Initialization response code |
Remove(T, Boolean)
Removes the specified file transfer information.
Declaration
void Remove(T fileTransferInformation, bool expiredOrCancelled)Parameters
| Type | Name | Description |
|---|---|---|
| T | fileTransferInformation | The file transfer information. |
| System.Boolean | expiredOrCancelled | if set to |