Server.saveAuthorSuspendState (Method)

Either suspends the server's authoring state or allows authoring to resume. If authoring will be suspended, you must enter the date and time at which this will occur and tell CommonSpot how many minutes before the suspension it will display a warning message.

Returns:

Void

Arguments:

Name Type Required Description
authoringIsEnabled Boolean Required Boolean flag which when set to true indicates that authoring is enabled for the server.
suspendDateTime DateTime_EmptyString Optional. Defaults to an empty string. The time and date when CommonSpot will suspend authoring or an empty string. If this value is an empty string, CommonSpot does not suspend authoring.
warnMinutesBefore NonNegativeInteger Optional. Defaults to '0'. Tells CommonSpot how many minutes before it suspends authoring it will display a warning message.
warnMessage PlainText Optional. Defaults to an empty string. The warning message displayed that tells users that authoring will be disabled.

Context:

License Requirements None
Permission Requirements server:ServerMaintenance
Deny Context None
Require Context Authoring
Author Lock (not required)
Transaction Logging If transaction logging is enabled at the server level, calls to this method will be logged
Customization This method may be customized at the server level

Error Codes:

None

Notes:

None