Page.checkLock (Method)

If another user has a lock on the requested page, CommonSpot displays a message that tells the user about this problem. If the page is not locked, CommonSpot returns and empty string. If 'throwIfLocked' is true, CommonSpot throws an error whose text is the same message.

Returns:

PlainText (string)

Arguments:

Name	Type	Required	Description
pageID	NonNegativeInteger	Required	A page's ID.
throwIfLocked	Boolean	Optional. Defaults to '1'.	Boolean value which when set to true indicates that CommonSpot throws an error if the page is locked.

Context:

License Requirements	(none)
Permission Requirements	(none)
Deny Context	(none)
Require Context	(none)
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:

None

Notes:

None