November Happy Hour will be moved to Thursday December 5th.

AI OnAI Off

Interface IContentTransferContext

Context for transfer of contents

Namespace: EPiServer.Core.Transfer
Assembly: EPiServer.dll
Version: 12.0.3
Syntax
public interface IContentTransferContext

Properties

ContentLanguages

Gets the content languages to transfer, if no list of languages is in the list all languages is transfered.

Declaration
IList<string> ContentLanguages { get; }
Property Value
Type Description
System.Collections.Generic.IList<System.String>

The languages to be transfered.

ContentTypes

Gets the content types.

Declaration
IList<ContentType> ContentTypes { get; }
Property Value
Type Description
System.Collections.Generic.IList<ContentType>

ContentTypesMap

Gets the look up table between incoming content type names and existing content type GUIDs.

Declaration
IDictionary<string, Guid> ContentTypesMap { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Guid>

The map for content type name from package and existing content type GUID.

Gets or sets the the content link used as root of the copied contents.

Declaration
ContentReference CopiedContentLink { get; set; }
Property Value
Type Description
ContentReference

DestinationRoot

Gets or sets the destination root for the transfer.

Declaration
ContentReference DestinationRoot { get; set; }
Property Value
Type Description
ContentReference

The destination root.

FileTransfer

Gets the file transfer functionality.

Declaration
IFileTransfer FileTransfer { get; }
Property Value
Type Description
IFileTransfer

The object used to transfer files.

ForceNewIdentitiesOnExport

Gets or sets a value indicating whether to force new page identifiers for the mirrored pages.

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

true if [force new identities]; otherwise, false.

IgnoreHierarchy

Gets a value indicating if the page hierarchy shoud be ignored for the destination pages (all pages will be stored below the destination root).

Declaration
bool IgnoreHierarchy { get; }
Property Value
Type Description
System.Boolean

true if the page hierarchy should be ]; otherwise, false.

ImplicitContents

Gets the implicit contents.

Declaration
Queue<ExportSource> ImplicitContents { get; }
Property Value
Type Description
System.Collections.Generic.Queue<ExportSource>

IncludeImplicitContentDependencies

Gets a value indicating whether to implicitly include referenced global contents.

Declaration
bool IncludeImplicitContentDependencies { get; }
Property Value
Type Description
System.Boolean

true if referenced global contents should be implicitly included; otherwise, false.

IncludeImplicitContentTypeDependencies

Gets a value indicating whether to implicitly include referenced global content types.

Declaration
bool IncludeImplicitContentTypeDependencies { get; }
Property Value
Type Description
System.Boolean

true if referenced global content types should be implicitly included; otherwise, false.

IsAborting

Gets a value indicating whether the transfer is aborting.

Declaration
bool IsAborting { get; }
Property Value
Type Description
System.Boolean

true if the transfer is aborting; otherwise, false.

IsDone

Gets a value indicating whether the transfer is done.

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

true if the transfer is done; otherwise, false.

KeepIdentity

Set to true if a copy, import or export operation should retain the Guid of the pages. Set to false to always create a new page at the destination.

Declaration
bool KeepIdentity { get; }
Property Value
Type Description
System.Boolean

LinkGuidMap

Gets the lookup table between page old and new Guids.

Declaration
IDictionary<Guid, Guid> LinkGuidMap { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.Guid, System.Guid>

The map old GUID new link.

Log

Gets the logger for the context.

Declaration
TransferLogger Log { get; }
Property Value
Type Description
TransferLogger

The logger.

SaveAction

Gets the save action for the copied pages.

Declaration
SaveAction SaveAction { get; }
Property Value
Type Description
SaveAction

The save action for the copy pages

SourceRoots

Gets the roots to tranfer pages from.

Declaration
IList<ExportSource> SourceRoots { get; }
Property Value
Type Description
System.Collections.Generic.IList<ExportSource>

A list of source roots.

TransferType

Gets or sets the type of the transfer.

Declaration
TypeOfTransfer TransferType { get; set; }
Property Value
Type Description
TypeOfTransfer

The type of the transfer.

Methods

Abort()

Aborts the transfer.

Declaration
void Abort()

OnExportProperty(TransformPropertyEventArgs)

Raises the event to export a property.

Declaration
void OnExportProperty(TransformPropertyEventArgs e)
Parameters
Type Name Description
TransformPropertyEventArgs e

The TransformPropertyEventArgs instance containing the event data.

OnImportProperty(TransformPropertyEventArgs)

Raises the event to import a property.

Declaration
void OnImportProperty(TransformPropertyEventArgs e)
Parameters
Type Name Description
TransformPropertyEventArgs e

The TransformPropertyEventArgs instance containing the event data.

Extension Methods