Tree.delete (Method)

Deletes the specified tree.

Returns:

Void

Arguments:

Name Type Required Description
id TreeID Required The unique ID of the tree.
ignoreWarnings Boolean Optional. Defaults to '0'. Boolean flag which when set tells CommonSpot that it should ignore warnings. If this value is false, this method throws an error with a warning message.

Context:

License Requirements (none)
Permission Requirements treeNav:Admin
Deny Context (none)
Require Context AuthoringEnabled
Author Lock (not required)
Transaction Logging If transaction logging is enabled at the site level, calls to this method will be logged
Customization Customization is not supported for this method.

Error Codes:

Code Error Message
403  
409  
87501 One or more nodes already exists for the specified tree.

Notes:

None