Click or drag to resize

SiteTreeServicesMoveCopyPageAdvanced Method
Moves or Copies a Page node from one location to another location. All the descendants of the Page node gets moved/copied together. This operation divides instructions of Move/Copy into separate parameters.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.6.492
Syntax
Copy
public XHRServiceResponseGeneric<PageAdvanceMoveCopyOutput> MoveCopyPageAdvanced(
	string[] pageIds,
	string targetId,
	string location,
	bool copy,
	bool special,
	string targetLocale,
	string pubTargetId,
	bool singlePageCopy
)

Parameters

pageIds  String
Array of Id of Pages to be moved
targetId  String
Target Page Id
location  String
Postion of placements relative to target Page Id, choices are "before", "after", or "child". Any other value returns error status
copy  Boolean
Whether to perform Copy or Move
special  Boolean
Whether to trigger a different set of Custom hooks, on work with "Copy" action. When true, uses "OnBeforePasteSpecial" and "OnAfterPasterSpecial"; otherwise, uses "OnBeforeCopy" and "OnAfterCopy"
targetLocale  String
Locale to set on the Pages after move/copy
pubTargetId  String
Id of the current Publishing Target
singlePageCopy  Boolean
When true, only the specified Page is copied/moved without its descendants; when false, the operation includes the entire descendant subtree.

Return Value

XHRServiceResponseGenericPageAdvanceMoveCopyOutput

Object containing information of the action executed, and properties of the Pages after move/copy.

Example
Sample JSON return
JavaScript
Copy
{
    "code": 0,
    "error": null,
    "message": {
        "pageAction": "copy",
        "pageProperties": [{
            "name": "Soap",
            "allowedCategoryRoots": [],
            "ancestors": ["x1", "x2", "x100", "x109"],
            "assignedGroup": null,
            "assignedUser": {
                "name": "Turtle Master",
                "email": "awang@ingeniux.com",
                "userId": "INGENIUX\\awang"
            },
            "canClaimPage": false,
            "canTranslate": false,
            "checkedOut": true,
            "error": null,
            "icon": 9,
            "isAssignedToOtherUser": false,
            "isEditable": true,
            "isInWorkflow": false,
            "justRecycled": false,
            "languageRootId": "",
            "lingualMaps": {
                "clones": [],
                "master": null
            },
            "locale": "",
            "localeInherited": true,
            "markedForPublish": false,
            "markedForPublishAny": false,
            "markedForPublishPropagated": false,
            "nextPageId": null,
            "nextPageIndex": 0,
            "noDnd": false,
            "numChildPages": 0,
            "pageId": "x108",
            "parentId": null,
            "pendingMasterVersion": 0,
            "referenceProps": {
                "created": "20140110T01:21:30",
                "createdBy": "INGENIUX\\awang",
                "endDate": "00010101T00:00:00",
                "lastModified": "20140130T18:49:40",
                "lastModifiedBy": "User\/INGENIUX___awang",
                "publishAs": "",
                "startDate": "00010101T00:00:00"
            },
            "remoteServer": "",
            "schemaFriendlyName": null,
            "schemaName": "SOAPServiceClient",
            "schemaOnLatestVersion": false,
            "securityLevel": 2,
            "userCanCopyPage": true,
            "workflow": null
        }],
        "queryString": {
            "copy": false,
            "pageIds": "x108",
            "targetId": "x109"
        }
    }
}
Remarks

Non-existing Page are ignored.

All Pages specified will be placed as sibling after move/copy, without consideration of their original positions in the Site tree hierarchy.

See Also