Class CopyMigrationOptions

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Optional options that can be passed to the migration job

public class CopyMigrationOptions

Inheritance

object

CopyMigrationOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AllowSchemaMismatch

This allows the item to move even if the target has a mismatched schema definition from the source list.

public bool AllowSchemaMismatch { get; set; }

Property Value

bool

AllowSmallerVersionLimitOnDestination

This allows the move to take place if the target file has older version. By default it’s disallowed to prevent data loss.

public bool AllowSmallerVersionLimitOnDestination { get; set; }

Property Value

bool

BypassSharedLock

This indicates whether a file with a share lock can still be moved in a move job. If you want to move a file that is locked, you need to set this.

public bool BypassSharedLock { get; set; }

Property Value

bool

ClientEtags

If set, and the source eTag doesn’t match the eTag specified, the copy and move won’t take place. If left NULL, no check will take place.

public string[] ClientEtags { get; set; }

Property Value

string[]

ExcludeChildren

For this operation, only the root level folder of the URL is copied. The sub-folders or files within the folder will not be moved or copied.

public bool ExcludeChildren { get; set; }

Property Value

bool

IgnoreVersionHistory

If not specified, the version history will be ignored and not moved to the destination.

public bool IgnoreVersionHistory { get; set; }

Property Value

bool

IsMoveMode

By default, this is set to copy. For a move operation, set this parameter to true.

public bool IsMoveMode { get; set; }

Property Value

bool

MoveButKeepSource

Once set, this move operation is similar to copy. The file will move to destination, but the source content will not be deleted. If set, this will make a copy with the version history and preserve the original metadata. No source item deletions occurs at the end. This is not like the normal copy, which only copies the most recent major version and doesn't maintain all the metadata.

public bool MoveButKeepSource { get; set; }

Property Value

bool

NameConflictBehavior

If a name conflict occurs at the target site, the default reports a failure.

public SPMigrationNameConflictBehavior NameConflictBehavior { get; set; }

Property Value

SPMigrationNameConflictBehavior