Creates a new instance of a Checkout pending action object.

Namespace:  FileNet.Api.Action
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Public Sub New ( _
	reservationId As String, _
	reservationType As ReservationType, _
	reservationClass As String, _
	reservationProperties As IProperties _
)
C#
public Checkout(
	string reservationId,
	ReservationType reservationType,
	string reservationClass,
	IProperties reservationProperties
)
Visual C++
public:
Checkout(
	String^ reservationId, 
	ReservationType reservationType, 
	String^ reservationClass, 
	IProperties^ reservationProperties
)
JavaScript
FileNet.Api.Action.Checkout = function(reservationId, reservationType, reservationClass, reservationProperties);

Parameters

reservationId
Type: System..::.String
A String specifying a GUID to be assigned to the reservation object that is created when a document is checked out, thus overriding the reservation object's ID. An assigned ID can be useful if you need to later import a series of document versions. Use with caution. If null, the API generates a new GUID for the reservation object.
reservationType
Type: FileNet.Api.Constants..::.ReservationType
A ReservationType constant specifying the type of checkout reservation: collaborative, exclusive, or the default object store setting (DefaultReservationType property). If null, the API uses the default object store setting.
reservationClass
Type: System..::.String
A String specifying the symbolic name of the class to which a document's reservation object belongs. If null, the class of the reservation object remains the same as that of the checked-out document.
reservationProperties
Type: FileNet.Api.Property..::.IProperties
A Properties object containing a list of property values to pre-assign to a document's reservation object. If null, no property values are pre-assigned to the reservation object.

ToggleSee Also