Search Results for

    Show / Hide Table of Contents

    Class CopyMigrationOptions

    Optional options that can be passed to the migration job

    Inheritance
    System.Object
    CopyMigrationOptions
    Namespace: PnP.Core.Model.SharePoint
    Assembly: PnP.Core.dll
    Syntax
    public class CopyMigrationOptions : object

    Properties

    AllowSchemaMismatch

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

    Declaration
    public bool AllowSchemaMismatch { get; set; }
    Property Value
    System.Boolean

    AllowSmallerVersionLimitOnDestination

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

    Declaration
    public bool AllowSmallerVersionLimitOnDestination { get; set; }
    Property Value
    System.Boolean

    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.

    Declaration
    public bool BypassSharedLock { get; set; }
    Property Value
    System.Boolean

    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.

    Declaration
    public string[] ClientEtags { get; set; }
    Property Value
    System.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.

    Declaration
    public bool ExcludeChildren { get; set; }
    Property Value
    System.Boolean

    IgnoreVersionHistory

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

    Declaration
    public bool IgnoreVersionHistory { get; set; }
    Property Value
    System.Boolean

    IsMoveMode

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

    Declaration
    public bool IsMoveMode { get; set; }
    Property Value
    System.Boolean

    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.

    Declaration
    public bool MoveButKeepSource { get; set; }
    Property Value
    System.Boolean

    NameConflictBehavior

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

    Declaration
    public SPMigrationNameConflictBehavior NameConflictBehavior { get; set; }
    Property Value
    SPMigrationNameConflictBehavior

    Back to top PnP Core SDK
    Generated by DocFX with Material UI
    spacer