The Activate client API is used to activate a reserved document.
|
Argument |
Description |
|---|---|
|
Parameter 1 |
Present the classification tree |
|
Parameter 1 default |
True |
|
Parameter 1 description |
If True, presents the classification tree as a page in the wizard. If False, the classification tree is not displayed. |
|
Parameter 1 type |
Boolean |
|
Parameter 2 |
Classification tree filtering |
|
Parameter 2 default |
None |
|
Parameter 2 description |
A ~ separated list of interfaces to perform classification tree filtering (optional) |
|
Parameter 2 type |
String |
|
Parameter 3 |
Form purpose name |
|
Parameter 3 default |
Activate |
|
Parameter 3 description |
The name of the version (purpose) of the object's form that is displayed to activate the document. |
|
Parameter 3 type |
String |
|
Parameter 4 |
Title |
|
Parameter 4 default |
None |
|
Parameter 4 description |
The title that will appear at the top of the dialog box. |
|
Parameter 4 type |
String |
|
Parameter 5 |
Not used |
|
Parameter 6 |
File attachment configuration |
|
Parameter 6 default |
SPFDesignFile~SPFFileComposition~PROMPT |
|
Parameter 6 description |
File attachment configuration (optional) FileClassDef~FileRelDef~ReferenceAction~SeedFileTemplateDocName. SPFFileComposition is the default relationship definition if none other is specified. The seed file document is optional. Reference file not found actions are CONTINUE|PROMPT|ABORT. |
|
Parameter 6 type |
String |
|
Parameter 7 |
Delete local files configuration |
|
Parameter 7 default |
True~True |
|
Parameter 7 description |
Includes two options, separated by a ~, to control whether local files are deleted when attached and whether to expose the option for deleting local files on the form used for creation. |
|
Parameter 7 type |
String |
The following methods use the Activate client API to activate a reserved document.
-
SPFVendorActivate