Provides classes that are related to making changes to objects. Changes (such as creating, locking, updating, freezing, deleting, and so on) accumulate on the underlying object as pending actions. These changes are called "pending" actions because they represent intended changes that have not yet been committed to objects on the server.

This namespace contains a base PendingAction class and subclasses related to each type of pending action. Most callers will probably want to call the type-safe wrapper methods (such as Checkin) rather than directly working with the underlying PendingAction objects.

ToggleClasses

Type ClassDescription
Public classApplySecurityTemplate
Represents an "apply security template" pending action. Calling a method that applies a security template to an object automatically creates an instance of ApplySecurityTemplate, which is then added to the underlying object’s PendingActions collection.
Public classChangeClass
Represents a pending action for changing the class of a Content Engine object. When an object calls the ChangeClass method, the API automatically creates an instance of the ChangeClass class and adds it to the underlying object's collection of PendingAction objects.
Public classChangeState
Represents a pending action for changing the lifecycle policy state of a IDocument, or for changing the state of a ICmTask. When the ChangeState method is called on IDocument or ICmTask, the API automatically creates an instance of the ChangeState class and adds it to the underlying object's collection of PendingAction objects.
Public classCheckin
Represents a pending action for checking in a document as a new version. When a document calls the Checkin method, the API automatically creates an instance of the Checkin class and adds it to the underlying object's collection of PendingAction objects.
Public classCheckout
Represents a pending action for checking out a document. When a document calls the Checkout method, the API automatically creates an instance of the Checkout class and adds it to the underlying object's collection of PendingAction objects.
Public classCreate
Represents a "create" pending action. Calling a method that creates an object automatically creates an instance of Create, which is then added to the underlying object’s PendingActions collection.
Public classDelete
Represents a "delete" pending action. Calling a method that deletes an object automatically creates an instance of Delete, which is then added to the underlying object’s PendingActions collection.
Public classDemoteVersion
Represents a pending action for demoting a major version of a document to a minor version. When an object calls the DemoteVersion method, the API automatically creates an instance of the DemoteVersion class and adds it to the underlying object's collection of PendingAction objects.
Public classFreeze
Represents a pending action for freezing the custom properties of a document. When an object calls the Freeze method, the API automatically creates an instance of the Freeze class and adds it to the underlying object's collection of PendingAction objects.
Public classInstallAddOn
Represents a pending action for installing an add-on. When you call the InstallAddOn method, the API automatically creates an instance of the InstallAddOn class, and adds it to the underlying object's collection of PendingActions objects.
Public classLock
Represents a "lock" pending action. Calling a method that locks an object automatically creates an instance of Lock, which is then added to the underlying object’s PendingActions collection.
Public classMoveContent
Represents a pending action for moving the content data of an object to a new storage area. When an object calls the MoveContent method, the API automatically creates an instance of the MoveContent class and adds it to the underlying object's collection of PendingAction objects.
Public classPendingAction
Provides the base class for all of the other classes in this package.

A pending action represents an intended change that has not yet been committed to an object on the server. When you call a method that changes an underlying object, a subclass of PendingAction is created that corresponds to the action. For example, calling Document.Checkout creates a Checkout subclass. The pending action is added to the underlying object’s ordered list of pending actions (an automatically-generated PendingActions collection). For each subsequent action (such as locking and unlocking, changing the class, freezing, and so on) taken on the object, an item is added to the pending actions list. When you commit the object, for example, by calling the Save method or, in the case of batch operations, by committing the batch, the underlying object (and its collection of pending actions) is sent to the server and changes are written to the repository in the order in which they occur in the object’s pending actions list.

A PendingAction object has a parameter bag that accompanies the action taken on the underlying object. The PendingAction class provides Get and Put methods for retrieving and setting parameters in the parameter bag. For example, if you change the class of an object, the identity of the new class is communicated as a parameter.

Note Note: Parameter names specified as input to these methods may not be documented completely. It is expected that you will use the type-safe subclasses instead of directly working with the underlying PendingAction objects. The names of valid parameters can be deduced from the formal arguments of constructors for PendingAction subclasses.)

You can retrieve an object’s accumulated pending actions by calling its GetPendingActions method.

Public classPromoteVersion
Represents a pending action for promoting a minor version of a document to a major version. When an object calls the PromoteVersion method, the API automatically creates an instance of the PromoteVersion class and adds it to the underlying object's collection of PendingAction objects.
Public classRaiseEvent
Represents a pending action for raising a custom event on a ISubscribable object. When you call the RaiseEvent method, an instance of the RaiseEvent class is created and added to the ISubscribable object's collection of PendingAction objects.
Public classRecover
Represents a pending action for recovering a deleted object. When the Recover method is called, the API automatically creates an instance of the Recover class and adds it to the underlying object's collection of PendingAction objects.
Public classTakeFederatedOwnership
Represents a pending action for giving exclusive control of the modification or deletion of a document's federated content to the Content Engine. When an object calls the TakeFederatedOwnership method, the API automatically creates an instance of the TakeFederatedOwnership class and adds it to the underlying object's collection of PendingAction objects.
Public classUnlock
Represents an "unlock" pending action. Calling a method that unlocks an object automatically creates an instance of Unlock, which is then added to the underlying object’s PendingActions collection. Only the owner of the lock can remove it.
Public classUpdate
Represents an "update" pending action. If there are dirty properties in the property cache when Save is called, the API automatically creates an instance of an Update pending action and adds it the underlying object’s PendingActions collection.