Page.setPermanentLock (Method)
Sets or removes a page's permanent lock. When setting a lock, also takes any other user who was working on the page out of that mode. Throws an error if another user has a lock on the item.
Returns:
Void
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| pageID | RealPageID_UploadedDocID_NonBaseTemplate | Required | The unique ID of the page or uploaded document to lock or unlock. |
| bLock | Boolean | Required | Boolean flag which when set to true indicates that CommonSpot will lock a page. |
Context:
| License Requirements | None |
| Permission Requirements | page:Author |
| 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 | This method may be customized at the site level |
Error Codes:
| Code | Error Message |
|---|---|
| 31000 | You cannot lock the specified $1. User '$2' has a permanent lock on this page. |
| 31001 | You cannot lock the specified $1. User '$2' is in author mode on this page. |
| 1000403 | Another page with the specified title already exists. |
Notes:
None