Don't miss out Virtual Happy Hour this Friday (April 26).

Try our conversational search powered by Generative AI!

AI OnAI Off

Class DataImporter

Inheritance
System.Object
ContentTransferContext
ExportImportBase
DataImporter
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Enterprise
Assembly: EPiServer.Cms.AspNet.dll
Version: 11.20.7
Syntax
[Obsolete("Use IDataImporter (or IDataImportEvents for events)", true)]
public class DataImporter : ExportImportBase, ITransferContext, IContentTransferContext, ITransferHandlerContext, IDataImporter

Constructors

DataImporter()

Declaration
public DataImporter()

DataImporter(PropertyContentReferenceListTransform, PropertyJsonTransform)

Declaration
public DataImporter(PropertyContentReferenceListTransform propertyContentReferenceListTransform, PropertyJsonTransform propertyJsonTransform)
Parameters
Type Name Description
PropertyContentReferenceListTransform propertyContentReferenceListTransform
PropertyJsonTransform propertyJsonTransform

DataImporter(PropertyContentReferenceListTransform, PropertyJsonTransform, IContentCacheRemover)

Declaration
public DataImporter(PropertyContentReferenceListTransform propertyContentReferenceListTransform, PropertyJsonTransform propertyJsonTransform, IContentCacheRemover contentCacheRemover)
Parameters
Type Name Description
PropertyContentReferenceListTransform propertyContentReferenceListTransform
PropertyJsonTransform propertyJsonTransform
IContentCacheRemover contentCacheRemover

DataImporter(PropertyContentReferenceListTransform, PropertyJsonTransform, IContentCacheRemover, IPrincipalAccessor)

Declaration
public DataImporter(PropertyContentReferenceListTransform propertyContentReferenceListTransform, PropertyJsonTransform propertyJsonTransform, IContentCacheRemover contentCacheRemover, IPrincipalAccessor principalAccessor)
Parameters
Type Name Description
PropertyContentReferenceListTransform propertyContentReferenceListTransform
PropertyJsonTransform propertyJsonTransform
IContentCacheRemover contentCacheRemover
IPrincipalAccessor principalAccessor

DataImporter(IContentCacheRemover, IPrincipalAccessor, IDataImportEvents, IDataImportEventsRaiser, IContentRepository, IPermanentLinkMapper, IContentTypeRepository, ContentTypeAvailabilityService, IAvailableSettingsRepository, IContentTransfer, IContentTransferValidator)

Declaration
public DataImporter(IContentCacheRemover contentCacheRemover, IPrincipalAccessor principalAccessor, IDataImportEvents dataImportEvents, IDataImportEventsRaiser eventRaiser, IContentRepository contentRepository, IPermanentLinkMapper permanentLinkMapper, IContentTypeRepository contentTypeRepository, ContentTypeAvailabilityService contentTypeAvailabilityService, IAvailableSettingsRepository availableSettingsRepository, IContentTransfer contentTransfer, IContentTransferValidator contentTransferValidator)
Parameters
Type Name Description
IContentCacheRemover contentCacheRemover
IPrincipalAccessor principalAccessor
IDataImportEvents dataImportEvents
IDataImportEventsRaiser eventRaiser
IContentRepository contentRepository
IPermanentLinkMapper permanentLinkMapper
IContentTypeRepository contentTypeRepository
ContentTypeAvailabilityService contentTypeAvailabilityService
IAvailableSettingsRepository availableSettingsRepository
IContentTransfer contentTransfer
IContentTransferValidator contentTransferValidator

Properties

AutoDetectCulture

Gets or sets a value indicating whether [auto detect culture].

Declaration
public bool AutoDetectCulture { get; set; }
Property Value
Type Description
System.Boolean

true if [auto detect culture]; otherwise, false.

IgnoreDynamicProperties

If dynamic properties in import packages should be ignored

Declaration
public bool? IgnoreDynamicProperties { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

If value is not set the default value will be based on if dynamic properties are enabled or not in configuration

ImportedVppFiles

Gets or sets a value indicating whether the importer imported vpp based files.

Declaration
public bool ImportedVppFiles { get; set; }
Property Value
Type Description
System.Boolean

true if vpp based files where imported; otherwise, false.

NumberOfPagesToImport

Gets or sets the all the pages to import.

Declaration
public int NumberOfPagesToImport { get; }
Property Value
Type Description
System.Int32

The number of pages to import.

NumberOfVisitorGroupToImport

Gets or sets the number of visitor group to import.

Declaration
public int NumberOfVisitorGroupToImport { get; }
Property Value
Type Description
System.Int32

The number of visitor group to import.

Status

Contains continuosly updates of the import process

Declaration
public IImportStatus Status { get; }
Property Value
Type Description
IImportStatus

Methods

ExsistLegacyFileInThePackage()

Declaration
public virtual bool ExsistLegacyFileInThePackage()
Returns
Type Description
System.Boolean

Import()

Execute the import.

Declaration
public virtual void Import()

Import(Stream, ContentReference, ImportOptions)

Imports the import packages specified by System.IO.Stream

Declaration
public ITransferLog Import(Stream stream, ContentReference destinationRoot, ImportOptions options)
Parameters
Type Name Description
System.IO.Stream stream

The stream to the import package
ContentReference destinationRoot

The root where content items will be imported under
ImportOptions options

Options that specify settings for the import
Returns
Type Description
ITransferLog

A logger with result
Remarks

Potential errors and warnings are logged to returned logger

Continuous progress can be retreieved from Status.

ImportFile(IFileTransferObject, ZipPackage)

Declaration
protected void ImportFile(IFileTransferObject metaData, ZipPackage package)
Parameters
Type Name Description
IFileTransferObject metaData
System.IO.Packaging.ZipPackage package

InternalImportLive(IFileTransferObject, ZipPackage)

Declaration
protected void InternalImportLive(IFileTransferObject metaData, ZipPackage package)
Parameters
Type Name Description
IFileTransferObject metaData
System.IO.Packaging.ZipPackage package

OnImportProperty(TransformPropertyEventArgs)

Declaration
public override void OnImportProperty(TransformPropertyEventArgs e)
Parameters
Type Name Description
TransformPropertyEventArgs e
Overrides

OnResolveFileTransferType(ResolveFileTransferTypeArgs)

Declaration
protected virtual void OnResolveFileTransferType(ResolveFileTransferTypeArgs e)
Parameters
Type Name Description
ResolveFileTransferTypeArgs e

Events

ContentImported

Declaration
public static event ContentImportedEventHandler ContentImported
Event Type
Type Description
ContentImportedEventHandler

ContentImporting

Declaration
public static event ContentImportingEventHandler ContentImporting
Event Type
Type Description
ContentImportingEventHandler

FileImported

Declaration
public static event FileImportedEventHandler FileImported
Event Type
Type Description
FileImportedEventHandler

FileImporting

Declaration
public static event FileImportingEventHandler FileImporting
Event Type
Type Description
FileImportingEventHandler

Imported

Declaration
public static event EventHandler Imported
Event Type
Type Description
System.EventHandler

Importing

Declaration
public static event EventHandler Importing
Event Type
Type Description
System.EventHandler

ImportingPages

Declaration
public static event EventHandler ImportingPages
Event Type
Type Description
System.EventHandler

ImportPropertyEvent

Declaration
public static event EventHandler<TransformPropertyEventArgs> ImportPropertyEvent
Event Type
Type Description
System.EventHandler<TransformPropertyEventArgs>

ResolveFileTransferType

Declaration
public static event EventHandler<ResolveFileTransferTypeArgs> ResolveFileTransferType
Event Type
Type Description
System.EventHandler<ResolveFileTransferTypeArgs>

Implements

Extension Methods