Click or drag to resize
CMSNotificationGateway Class
Base class for all notification gateways.
Inheritance Hierarchy

Namespace: CMS.Notifications
Assembly: CMS.Notifications (in CMS.Notifications.dll) Version: 8.2.23
Syntax
C#
public abstract class CMSNotificationGateway

The CMSNotificationGateway type exposes the following members.

Constructors
  NameDescription
Protected methodCMSNotificationGateway
Top
Methods
  NameDescription
Public methodClone
Returns clone of current notification gateway instance.
Public methodStatic memberGetNotificationGateway(Int32)
Gets notification gateway assambly according to the specified gateway ID.
Public methodStatic memberGetNotificationGateway(String)
Gets notification gateway assambly according to the specified gateway name.
Public methodGetNotificationGatewayForm
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 methodStatic memberRaiseEvent
Raises event with specified parameters and performs sending notifications to all subscribers who were subscribed to such event.
Public methodSendNotification
Sends notification. It is automatically called after the specified event is raised. You will need to override this method for your custom gateway.
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Properties
  NameDescription
Public propertyStatic memberEnableNotifications
Indicates if notifications are sent when specified event occurs, by default it is set to TRUE.
Public propertyGatewayName
Gets or sets the code name of the notification gateway.
Public propertyNotificationGatewayForm
Gets or sets the notification gateway form.
Public propertyNotificationGatewayObj
Gets the notification gateway object.
Public propertyNotificationSubscriptionControl
Gets or sets notification subscription control where the notification gateway form is placed on.
Public propertyNotificationSubscriptionObj
Subscritption information the gateway use when sending notification.
Public propertyResolver
Macro resolver for resolving macros in notification messages.
Top
See Also