SiteTreeServices.MoveCopyPageAdvanced Method

SiteTreeServicesMoveCopyPageAdvanced Method

Ingeniux CMS Web Services API

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: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<PageAdvanceMoveCopyOutput> MoveCopyPageAdvanced(
	string[] pageIds,
	string targetId,
	string location,
	bool copy,
	bool special,
	string targetLocale,
	string pubTargetId
)

Public Function MoveCopyPageAdvanced ( 
	pageIds As String(),
	targetId As String,
	location As String,
	copy As Boolean,
	special As Boolean,
	targetLocale As String,
	pubTargetId As String
) As XHRServiceResponseGeneric(Of PageAdvanceMoveCopyOutput)

public:
virtual XHRServiceResponseGeneric<PageAdvanceMoveCopyOutput^>^ MoveCopyPageAdvanced(
	array<String^>^ pageIds, 
	String^ targetId, 
	String^ location, 
	bool copy, 
	bool special, 
	String^ targetLocale, 
	String^ pubTargetId
) sealed

abstract MoveCopyPageAdvanced : 
        pageIds : string[] * 
        targetId : string * 
        location : string * 
        copy : bool * 
        special : bool * 
        targetLocale : string * 
        pubTargetId : string -> XHRServiceResponseGeneric<PageAdvanceMoveCopyOutput> 
override MoveCopyPageAdvanced : 
        pageIds : string[] * 
        targetId : string * 
        location : string * 
        copy : bool * 
        special : bool * 
        targetLocale : string * 
        pubTargetId : string -> XHRServiceResponseGeneric<PageAdvanceMoveCopyOutput>

Parameters

pageIds: Type: SystemString
Array of Id of Pages to be moved
targetId: Type: SystemString
Target Page Id
location: Type: SystemString
Postion of placements relative to target Page Id, choices are "before", "after", or "child". Any other value returns error status
copy: Type: SystemBoolean
Whether to perform Copy or Move
special: Type: SystemBoolean
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: Type: SystemString
Locale to set on the Pages after move/copy
pubTargetId: Type: SystemString
Id of the current Publishing Target

Return Value

Type: XHRServiceResponseGenericPageAdvanceMoveCopyOutput

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

Examples

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.

Reference

SiteTreeServices Class

IngeniuxCMService Namespace