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

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

Validates the subscriber to see if he/she should receive the message.

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

protected virtual bool ValidateSubscriber(
	SubscriptionInformation subscriber
)

Parameters

subscriber
Type: ContentStudio.Document.Subscription.EventHandlerSubscriptionInformation
The subscriber to validate.

Return Value

Type: Boolean
true if the subscriber is valid and should receive a message, otherwise, false
Remarks

This method gets called by the eventhandler once for each subscriber found on the subscription handled.

The event handler reads activated subscribers only but in some scenarios there can be a need for more fine grained control over which subscribers should reciever messages. For example, in the document to send there is a meta data that indicates that only a group of subscribers should receive a message. The implementation could then look at the passed in subscriber, query an external storage too see whether this subscriber should receive the actual message. By returning false a message will not be sent to the subscriber.

Note Note
If this method returns false the message will not be sent out to the subscriber.

See Also

Reference