CMSNotificationGateway Class

Base class for all notification gateways.

Inheritance Hierarchy

System.Object
  CMS.Notifications.CMSNotificationGateway
    CMS.Notifications.CMSEmailNotificationGateway

Namespace: CMS.Notifications
Assembly: CMS.Notifications (in CMS.Notifications.dll) Version: 8.2.23

Syntax

public abstract class CMSNotificationGateway

The CMSNotificationGateway type exposes the following members.

Constructors

	Name	Description
Protected method	CMSNotificationGateway

Methods

	Name	Description
Public method	Clone	Returns clone of current notification gateway instance.
Public method Static member	GetNotificationGateway(Int32)	Gets notification gateway assambly according to the specified gateway ID.
Public method Static member	GetNotificationGateway(String)	Gets notification gateway assambly according to the specified gateway name.
Public method	GetNotificationGatewayForm	Returns notification gateway form with custom control(s) which are used to enter/select user target(s) the provider should send notification to. You will need to override this method for your custom gateway.
Public method Static member	RaiseEvent	Raises event with specified parameters and performs sending notifications to all subscribers who were subscribed to such event.
Public method	SendNotification	Sends notification. It is automatically called after the specified event is raised. You will need to override this method for your custom gateway.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property Static member	EnableNotifications	Indicates if notifications are sent when specified event occurs, by default it is set to TRUE.
Public property	GatewayName	Gets or sets the code name of the notification gateway.
Public property	NotificationGatewayForm	Gets or sets the notification gateway form.
Public property	NotificationGatewayObj	Gets the notification gateway object.
Public property	NotificationSubscriptionControl	Gets or sets notification subscription control where the notification gateway form is placed on.
Public property	NotificationSubscriptionObj	Subscritption information the gateway use when sending notification.
Public property	Resolver	Macro resolver for resolving macros in notification messages.