Site.getAuthorSuspendState (Method)

Returns a structure containing information about the site's 'Author Suspend State'. For example, when it will be suspended, a warning message, and so on.

Returns:

GetAuthorSuspendState_Result (struct)

Each row of the returned query results has the following fields:

Field Name	Type	Description
AuthoringIsEnabled	Boolean	Boolean flag which when true indicates that authoring is enabled.
AuthoringState	AuthoringState	String describing the authoring state: 'Enabled', 'Scheduled to be suspended', or' Suspended'.
SuspendDateTime	DateTime_EmptyString	The date and time when CommonSpot will suspend authoring. If this value is an empty string, authoring is enabled.
SuspendDateTimeLocaleFormat	PlainText	The date and time when CommonSpot will suspend authoring in the local locale's format. If this is an empty string, authoring is enabled.
WarnMessage	PlainText	The warning message displayed that tells a user that authoring will be disabled.
WarnMinutesBefore	NonNegativeInteger	The number of minutes before authoring will be suspended. This is the time at which CommonSpot displays a warning message.

Context:

License Requirements	None
Permission Requirements	ContributorOrServerCode
Deny Context	None
Require Context	None
Author Lock

Error Codes:

None

Notes:

None