Content Studio Web Content Management System
Assembly: CSSubscriptionEventHandler (in CSSubscriptionEventHandler.dll) Version: 1.0.0.0 (1.0.0.0)
Custom implementation should throw exceptions if the event handler fails.
Any exception will be handled by the Service Manager and logged in the Content Studio event log.
[This is preliminary documentation and is subject to change.]
Defines an asyncronous Content Studio event handler.
This method gets called by Content Studio Service Manager when it needs to handle
a subscription related event.
Namespace: ContentStudio.Document.Subscription.EventHandler
Assembly: CSSubscriptionEventHandler (in CSSubscriptionEventHandler.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public void EventHandler( int csEvent, int connectionId, string eventXmlArguments, string customData, ICSCredentialsContainer credentials, int timeOut, out string statusText )
Parameters
- csEvent
- Type: SystemInt32
The event that triggered the job beeing executed. The value of these events are defined in the ContentStudioEvents - connectionId
- Type: SystemInt32
A value that identifies the site. - eventXmlArguments
- Type: SystemString
Data that contains standard event data passed to the implementation by the Content Studio API. The exact syntax of this xml can vary between different events and versions of Content Studio but this sample can act as a guideline. - customData
- Type: SystemString
A passed in Xml document that contains additional parameters defined by a user. - credentials
- Type: ContentStudio.EventActionsICSCredentialsContainer
A reference to Content Studio's implementation of the ICSCredentialsContainer interface. This interface is used to pass system defined credentials to the custom implementation. - timeOut
- Type: SystemInt32
A timeout value (in seconds) to use. When zero is passed in the implementation should use a default time out value ex. 30 seconds to avoid hung event handlers. - statusText
- Type: SystemString
A status message after the call the implementer can use to notify Service Manager. This message will be logged on success.
Implements
ICSAsyncEventHandlerEventHandler(Int32, Int32, String, String, ICSCredentialsContainer, Int32, String)Remarks
See Also