SubscriptionEventHandlerBaseSetStatus Method Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Sets the status text that is sent back to the Service Manager after that the event handler has finished.

Namespace: ContentStudio.Document.Subscription.EventHandler
Assembly: CSSubscriptionEventHandler (in CSSubscriptionEventHandler.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax

protected void SetStatus(
	string statusTextValue
)

Parameters

statusTextValue
Type: SystemString
The status text.

For a general success this value can be "OK" or "Success". The status can also be an informative message that should be logged in the Content Studio event log. This value cannot be null (Nothing in Visual Basic).

Exceptions

ExceptionCondition
ArgumentNullExceptionstatusTextValue cannot be null
Remarks

Do not use StatusText to return error messages to the Service Manager unless these error are trivial that did not interrupt the event handler's job. Instead you should throw exceptions. Exceptions are logged as such by the Service Manager

See Also

Reference