Site.saveAuthorSuspendState (Method)
Suspends or activates the site's authoring state.
Returns:
Void
Arguments:
Name | Type | Required | Description |
---|---|---|---|
authoringIsEnabled | Boolean | Required | Boolean flag which when set to true indicates that authoring is enabled for the site. |
suspendDateTime | DateTime_EmptyString | Optional. Defaults to an empty string. | The time and date when CommonSpot will suspend authoring. If this value is an empty string, CommonSpot will not suspend authoring. |
warnMinutesBefore | NonNegativeInteger | Optional. Defaults to '0'. | The number of minutes before authoring will be suspended. At this time, CommonSpot displays a warning message. A value of 0 means that CommonSpot does not post a warning. |
warnMessage | PlainText | Optional. Defaults to an empty string. | The message that CommonSpot displays when it warns users that authoring will be disabled. An empty string indicates that CommonSpot does not post a warning message. |
Context:
License Requirements | None |
Permission Requirements | site:SiteAdmin |
Deny Context | None |
Require Context | Authoring |
Author Lock |
Error Codes:
None
Notes:
None