Page.switchMode (Method)
Sets the working mode of a page to 'Approve', 'Author', 'Edit', or 'Read'.
Returns:
Page_SwitchMode_Struct (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| Code | SwitchModeCode | An error status code. A value of 0 indicates that operation was successful. |
| PageMode | PageMode | String identifying a page's mode, as follows: 'Approve', 'Author', 'Edit', or 'Read'. |
| Text | PlainText | A message describing any errors or warnings. An empty string indicates that the operation succeeded. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| pageID | RealPageID_NonBaseTemplate | Required | The page's ID. |
| requestedMode | PageMode | Required | The mode that CommonSpot places a page: 'Approve', 'Author', 'Edit', and 'Read'. |
Context:
| License Requirements | None |
| Permission Requirements | Contributor |
| Deny Context | None |
| Require Context | AuthoringEnabled |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | This method may be customized at the site level |
Error Codes:
| Code | Error Message |
|---|---|
| 31019 |
Notes:
None