Click or drag to resize
UnsubscriptionHandler Class
Handler for the event when subscriber email is being unsubscribed.
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractHandler
    CMS.BaseSimpleHandlerUnsubscriptionHandler, UnsubscriptionEventArgs
      CMS.NewslettersUnsubscriptionHandler

Namespace: CMS.Newsletters
Assembly: CMS.Newsletters (in CMS.Newsletters.dll) Version: 12.0.0
Syntax
C#
public class UnsubscriptionHandler : SimpleHandler<UnsubscriptionHandler, UnsubscriptionEventArgs>

The UnsubscriptionHandler type exposes the following members.

Constructors
  NameDescription
Public methodUnsubscriptionHandler
Top
Properties
  NameDescription
Public propertyControlRecursion
If true, the recursion control is enabled on this handler.
(Inherited from AbstractHandler.)
Public propertyDebug
If true, the handler is included in debug
(Inherited from AbstractHandler.)
Public propertyEventArguments
Handler arguments
(Inherited from SimpleHandlerTHandler, TArgs.)
Public propertyIsBound
Returns true if the handler has some events bound
(Inherited from SimpleHandlerTHandler, TArgs.)
Public propertyIsStatic
True, if the handler is a static handler
(Inherited from AbstractHandler.)
Public propertyName
Event name. The name serves for debug purposes and to uniquely identify the handler.
(Inherited from AbstractHandler.)
Public propertyOneTime
If true, this event can be executed only once. If the event was already executed, and new handler is added, it executes immediately.
(Inherited from AbstractHandler.)
Public propertyParent
Parent handler
(Inherited from SimpleHandlerTHandler, TArgs.)
Public propertyWasExecuted
Returns true if the event was already executed
(Inherited from AbstractHandler.)
Top
Methods
  NameDescription
Protected methodAddEventTHandler
Adds the event to the list
(Inherited from AbstractHandler.)
Protected methodAssignCurrentHandler
Assigns the current handler to the event arguments
(Inherited from AbstractHandler.)
Protected methodCheckBase
Checks if the handler is base handler instance, and fires an exception if not
(Inherited from AbstractHandler.)
Protected methodCheckEvent
Checks if the handler is event handler instance, and fires an exception if not
(Inherited from AbstractHandler.)
Public methodClear
Clears all bound event handlers from the event and resets the number of executions of the event
(Inherited from SimpleHandlerTHandler, TArgs.)
Protected methodCountExecution
Counts the execution of the event
(Inherited from AbstractHandler.)
Public methodDispose
Disposes the object
(Inherited from AbstractHandler.)
Protected methodRaiseTArgs
Raises the list of events
(Inherited from AbstractHandler.)
Protected methodRaiseExecute
Raises the execute event
(Inherited from SimpleHandlerTHandler, TArgs.)
Protected methodRemoveEventTHandler
Removes the event from the list
(Inherited from AbstractHandler.)
Public methodReset
Resets the number of executions of the event
(Inherited from AbstractHandler.)
Public methodSetParent
Sets the parent event of the event
(Inherited from SimpleHandlerTHandler, TArgs.)
Public methodStartEvent
Initiates the new handler context
(Inherited from SimpleHandlerTHandler, TArgs.)
Top
Events
See Also