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

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

When implemented in derived classes, checks if the the event passed in is valid for this implementation.

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

protected override bool ValidateEvent(
	int csEvent
)

Parameters

csEvent
Type: SystemInt32
The cs event identifier to validate.

The value of this parameter is the numeric value of the ContentStudioEvents enumeration.

Return Value

Type: Boolean
true if the event passed in is valid for this event handler; otherwise false.
Exceptions

ExceptionCondition
InvalidOperationExceptionThe passed in event is not valid for this implementation
Remarks

The eventhandler call this method once at the beginning of the event handlig process to ensure that not any invalid event gets processed by this handler. This implementation accepts only the OnTestDocumentSubscription (value = 32) and OnDocumentSubscription (value = 31) event types. Derived classes can override this method to limit extend this constraint.

When this method returns true the event handler throws an InvalidOperationException

See Also

Reference