Interface IDataExporter
Component responsible for exporting data to an exportable package
Inherited Members
Namespace: EPiServer.Enterprise
Assembly: EPiServer.Enterprise.dll
Version: 11.20.7Syntax
public interface IDataExporter : IDisposable
Properties
ExportableItems
Can be used to add instances to the export package
Declaration
IDictionary<string, IList> ExportableItems { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IDictionary<System.String, System.Collections.IList> | A collection that instances can be added to |
Remarks
Supported key/types are ContentType/ContentType, Category/Category, TabDefinition/TabDefinition, Frame/Frame and ContentLanguages/System.Globalization.CultureInfo.
Status
Gets status information about the ongoing export job
Declaration
IExportStatus Status { get; }
Property Value
Type | Description |
---|---|
IExportStatus |
Methods
Abort()
Abort the running export.
Declaration
void Abort()
Export(Stream, IEnumerable<ExportSource>, ExportOptions)
Export the specified data to an export package specified by System.IO.Stream
Declaration
ITransferLog Export(Stream stream, IEnumerable<ExportSource> sourceRoots, ExportOptions options)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | stream | The stream to where the export packages is saved |
System.Collections.Generic.IEnumerable<ExportSource> | sourceRoots | The list of content roots to export |
ExportOptions | options | Specify settings for how the export should be done |
Returns
Type | Description |
---|---|
ITransferLog |
Remarks
Potential errors and warnings are logged to returned logger
Continuous progress can be retreieved from Status.