CheckOutMultiple
Checks out one or more objects.
Syntax
// Assumes shellUI has been initialized with IShellUI instance
const results = await shellUI.Vault.ObjectOperations.CheckOutMultiple({
obj_ids: [] /* Array of ObjID */,
});
Message
| Name | Description | Type |
|---|---|---|
obj_ids | Objects as JSON. (represented by MFObjIDArray struct) TRUE: [ out ] boolean pbDocumentVisible, //!< True if any version of the document is visible after the operation. FROM LATEST: [ out ] MF_DocumentLevelInfo pdoclevelinfo, //!< Document-level information (if _pbDocumentVisible is true). TRUE: [ out ] boolean pbLatestVisible, //!< True if the latest version of the document is visible after the operation. | ObjID[] |
Return type
| Name | Description | Type |
|---|---|---|
checked_out_versions | Results as JSON array. | ObjectVersionExWP[] |
previous_versions | Results as JSON array. | ObjectVersionEx[] |
Example
{
"checked_out_versions": [] /* Array of ObjectVersionExWP */,
"previous_versions": [] /* Array of ObjectVersionEx */
}