Interface IFileTransfer
The base interface for handling files with the transfer functionality.
Namespace: EPiServer.Core.Transfer
Assembly: EPiServer.dll
Version: 12.0.3Syntax
public interface IFileTransferProperties
Files
Returns a list of all files.
Declaration
IList<IFileTransferObject> Files { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<IFileTransferObject> | The files to be transferred. |
TransferContext
Gets or sets the transfer context.
Declaration
IContentTransferContext TransferContext { get; set; }Property Value
| Type | Description |
|---|---|
| IContentTransferContext | The transfer context. |
Methods
Export()
Exports all files to an IFileTransferObject.
Declaration
IFileTransferObject[] Export()Returns
| Type | Description |
|---|---|
| IFileTransferObject[] | A file transfer object |
Import(IFileTransferObject)
Imports a file transfer object.
Declaration
IFileTransferObject Import(IFileTransferObject metaData)Parameters
| Type | Name | Description |
|---|---|---|
| IFileTransferObject | metaData | The file transfer object to import. |
Returns
| Type | Description |
|---|---|
| IFileTransferObject | A file transfer object, if null is returned no data is imported. |
TryAddBlob(Blob)
Adds a Blob instance to the package.
Declaration
bool TryAddBlob(Blob blob)Parameters
| Type | Name | Description |
|---|---|---|
| Blob | blob | The BLOB. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if the blob was added else false. |
TryAddFile(String, out String)
Tries to add the file to the package.
Declaration
bool TryAddFile(string filePath, out string addedFilePath)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | filePath | The file path. |
| System.String | addedFilePath | The added file path. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if the file was added else false. |
