Properties

Methods

Events

Class CQ.wcm.msm.MSM.Commands

Package:	CQ.wcm.msm.MSM
Class:	Commands
Extends:	Object
Clientlib:	cq.widgets

Container for the static methods to operate on a Live Copy.

Public Properties

This class has no public properties.

Public Methods

Method		Defined By
	Commands.addSkippedPage( `String parentTargetPath`, `String[] childNames`, [`Function callback`], [`Object scope`] ) : void <static> Adds a list of child pages to the skipped page list. <static> Adds a list of child pages to the skipped page list. Parameters: `parentTargetPath` : String Target parent path (Live Copy page path) `childNames` : String[] List of child page to add to skipped page list `callback` : Function (optional) After command callback, see CQ.Ext.Ajax.request `scope` : Object (optional) Callback scope Returns: `void`	Commands
	Commands.attachLiveCopy( `String srcPath`, `String targetPath`, [`Boolean deep`], [`Function callback`], [`Object scope`] ) : void <static> Attaches a Live Copy page to its Blueprint page, i.e. transform a standalone page into a Live Copy. <static> Attaches a Live Copy page to its Blueprint page, i.e. transform a standalone page into a Live Copy. Parameters: `srcPath` : String Source path (Blueprint page path) `targetPath` : String Target path (Live Copy page path) `deep` : Boolean (optional) True to attach children to (defaults to false) `callback` : Function (optional) After command callback, see CQ.Ext.Ajax.request `scope` : Object (optional) Callback scope Returns: `void`	Commands
	Commands.createCatalog( `String parentPath` ) : void Deprecated: since 5.6.1; use CQ.commerce.Edit.createCatalog <static> Creates a Catalog from a Catalog Blueprint. While very similar to creating a LiveCopy, Catalog creatio... <static> Creates a Catalog from a Catalog Blueprint. While very similar to creating a LiveCopy, Catalog creation uses special rolloutConfigs which create LiveCopy pages from templates rather than from the blueprint pages themselves. The blueprint pages define the templates, the page names, and other properties. Catalog creation is always deep, and unlike livecopy creation, the catalog blueprint is always in control of the rolloutConfig. Parameters: `parentPath` : String Source path (Blueprint page path) Returns: `void`	Commands
	Commands.createLiveCopy( `String srcPath`, `String destPath`, [`String before`], [`String pageName`], [`Boolean shallow`], [`String[] rolloutConfigs`], [`Function callback`], [`Object scope`] ) : void <static> Creates a Live Copy. <static> Creates a Live Copy. Parameters: `srcPath` : String Source path (Blueprint page path) `destPath` : String Destination path (Live Copy parent page path) `before` : String (optional) Name of the future next sibling page `pageName` : String (optional) Name of the root page (defaults to the name of the Blueprint page) `shallow` : Boolean (optional) True to only create a single page Live Copy (defaults to false) `rolloutConfigs` : String[] (optional) Rollout config paths (defaults to "default" config) `callback` : Function (optional) After command callback, see CQ.Ext.Ajax.request `scope` : Object (optional) Callback scope Returns: `void`	Commands
	Commands.detachLiveCopy( `String targetPath`, [`Function callback`], [`Object scope`] ) : void <static> Detaches a Live Copy, i.e. transform Live Copy into a standalone page. <static> Detaches a Live Copy, i.e. transform Live Copy into a standalone page. Parameters: `targetPath` : String Target path (Live Copy page path) `callback` : Function (optional) After command callback, see CQ.Ext.Ajax.request `scope` : Object (optional) Callback scope Returns: `void`	Commands
	Commands.recreateLiveCopy( `String srcPath`, `String targetPath`, [`Function callback`], [`Object scope`] ) : void Deprecated: Use rollout with reset option instead <static> Recreates a Live Copy. Warning: all local modifications will be lost. <static> Recreates a Live Copy. Warning: all local modifications will be lost. Parameters: `srcPath` : String Source path (Blueprint page path) `targetPath` : String Target path (Live Copy page path) `callback` : Function (optional) After command callback, see CQ.Ext.Ajax.request `scope` : Object (optional) Callback scope Returns: `void`	Commands
	Commands.removeSkippedPage( `String parentTargetPath`, `String[] childNames`, [`Function callback`], [`Object scope`] ) : void <static> Removes a list of child pages from the skipped page list. <static> Removes a list of child pages from the skipped page list. Parameters: `parentTargetPath` : String Target parent path (Live Copy page path) `childNames` : String[] List of child page to remove from skipped page list `callback` : Function (optional) After command callback, see CQ.Ext.Ajax.request `scope` : Object (optional) Callback scope Returns: `void`	Commands
	Commands.resetLiveCopy( `String srcPath`, `String targetPath`, [`Boolean deep`], [`Function callback`], [`Object scope`] ) : void <static> Runs a reset rollout on a Live Copy. Warning !! Some local modifications will be lost: deleted paragra... <static> Runs a reset rollout on a Live Copy. Warning !! Some local modifications will be lost: deleted paragraphs/pages will be restored cancelled inheritance will be restored local modifications will be removed Parameters: `srcPath` : String Source path (Blueprint page path) `targetPath` : String Target path (Live Copy page path) `deep` : Boolean (optional) True to run a deep reset (defaults to false) `callback` : Function (optional) After command callback, see CQ.Ext.Ajax.request `scope` : Object (optional) Callback scope Returns: `void`	Commands
	Commands.rollout( `String srcPath`, `String targetPath`, [`Boolean deep`], [`Boolean reset`], [`Function callback`], [`Object scope`] ) : void <static> Rolls out a Live Copy. <static> Rolls out a Live Copy. Parameters: `srcPath` : String Source path (Blueprint page path) `targetPath` : String Target path (Live Copy page path) `deep` : Boolean (optional) True to run a deep rollout (defaults to false) `reset` : Boolean (optional) True to run a reset rollout (defaults to false) `callback` : Function (optional) After command callback, see CQ.Ext.Ajax.request `scope` : Object (optional) Callback scope Returns: `void`	Commands
	Commands.rolloutLiveCopy( `String srcPath`, `String targetPath`, [`Boolean deep`], [`Function callback`], [`Object scope`] ) : void <static> Rolls out a Live Copy. <static> Rolls out a Live Copy. Parameters: `srcPath` : String Source path (Blueprint page path) `targetPath` : String Target path (Live Copy page path) `deep` : Boolean (optional) True to run a deep rollout (defaults to false) `callback` : Function (optional) After command callback, see CQ.Ext.Ajax.request `scope` : Object (optional) Callback scope Returns: `void`	Commands
	Commands.skipLiveCopy( `String targetPath`, [`Function callback`], [`Object scope`] ) : void <static> Adds a page to the skipped page list. <static> Adds a page to the skipped page list. Parameters: `targetPath` : String Target path (Live Copy page path) `callback` : Function (optional) After command callback, see CQ.Ext.Ajax.request `scope` : Object (optional) Callback scope Returns: `void`	Commands
	Commands.unskipLiveCopy( `String targetPath`, [`Function callback`], [`Object scope`] ) : void <static> Removes a page from the skipped page list. <static> Removes a page from the skipped page list. Parameters: `targetPath` : String Target path (Live Copy page path) `callback` : Function (optional) After command callback, see CQ.Ext.Ajax.request `scope` : Object (optional) Callback scope Returns: `void`	Commands

Public Events

This class has no public events.