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.
Classes
Type | Class | Description |
---|---|---|
![]() | ApplySecurityTemplate |
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.
|
![]() | ChangeClass |
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.
|
![]() | ChangeState |
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.
|
![]() | Checkin |
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.
|
![]() | Checkout |
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.
|
![]() | Create |
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.
|
![]() | Delete |
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.
|
![]() | DemoteVersion |
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.
|
![]() | Freeze |
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.
|
![]() | InstallAddOn |
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.
|
![]() | Lock |
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.
|
![]() | MoveContent |
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.
|
![]() | PendingAction |
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. ![]() You can retrieve an object’s accumulated pending actions by calling its GetPendingActions method. |
![]() | PromoteVersion |
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.
|
![]() | RaiseEvent |
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.
|
![]() | Recover |
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.
|
![]() | TakeFederatedOwnership |
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.
|
![]() | Unlock |
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.
|
![]() | Update |
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.
|