UnsubscriptionHandler Class

Handler for the event when subscriber email is being unsubscribed.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractHandler
    CMS.Base.SimpleHandler<UnsubscriptionHandler, UnsubscriptionEventArgs>
      CMS.Newsletters.UnsubscriptionHandler

Namespace: CMS.Newsletters
Assembly: CMS.Newsletters (in CMS.Newsletters.dll) Version: 12.0.0

Syntax

public class UnsubscriptionHandler : SimpleHandler<UnsubscriptionHandler, UnsubscriptionEventArgs>

The UnsubscriptionHandler type exposes the following members.

Constructors

	Name	Description
Public method	UnsubscriptionHandler

Properties

	Name	Description
Public property	ControlRecursion	If true, the recursion control is enabled on this handler. (Inherited from AbstractHandler.)
Public property	Debug	If true, the handler is included in debug (Inherited from AbstractHandler.)
Public property	EventArguments	Handler arguments (Inherited from SimpleHandler<THandler, TArgs>.)
Public property	IsBound	Returns true if the handler has some events bound (Inherited from SimpleHandler<THandler, TArgs>.)
Public property	IsStatic	True, if the handler is a static handler (Inherited from AbstractHandler.)
Public property	Name	Event name. The name serves for debug purposes and to uniquely identify the handler. (Inherited from AbstractHandler.)
Public property	OneTime	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 property	Parent	Parent handler (Inherited from SimpleHandler<THandler, TArgs>.)
Public property	WasExecuted	Returns true if the event was already executed (Inherited from AbstractHandler.)

Methods

	Name	Description
Protected method	AddEvent<THandler>	Adds the event to the list (Inherited from AbstractHandler.)
Protected method	AssignCurrentHandler	Assigns the current handler to the event arguments (Inherited from AbstractHandler.)
Protected method	CheckBase	Checks if the handler is base handler instance, and fires an exception if not (Inherited from AbstractHandler.)
Protected method	CheckEvent	Checks if the handler is event handler instance, and fires an exception if not (Inherited from AbstractHandler.)
Public method	Clear	Clears all bound event handlers from the event and resets the number of executions of the event (Inherited from SimpleHandler<THandler, TArgs>.)
Protected method	CountExecution	Counts the execution of the event (Inherited from AbstractHandler.)
Public method	Dispose	Disposes the object (Inherited from AbstractHandler.)
Protected method	Raise<TArgs>	Raises the list of events (Inherited from AbstractHandler.)
Protected method	RaiseExecute	Raises the execute event (Inherited from SimpleHandler<THandler, TArgs>.)
Protected method	RemoveEvent<THandler>	Removes the event from the list (Inherited from AbstractHandler.)
Public method	Reset	Resets the number of executions of the event (Inherited from AbstractHandler.)
Public method	SetParent	Sets the parent event of the event (Inherited from SimpleHandler<THandler, TArgs>.)
Public method	StartEvent	Initiates the new handler context (Inherited from SimpleHandler<THandler, TArgs>.)

Events

	Name	Description
Public event	Execute	Raised before the event occurs (Inherited from SimpleHandler<THandler, TArgs>.)