openPDC Historian Help
NotifierBase Class
NamespacesTVA.Historian.NotifiersNotifierBase
Base class for a notifier that can process notification messages.
Declaration Syntax
C#Visual BasicVisual C++
public abstract class NotifierBase : INotifier, 
	ISupportLifecycle, IDisposable, IPersistSettings
Public MustInherit Class NotifierBase _
	Implements INotifier, ISupportLifecycle, IDisposable, IPersistSettings
public ref class NotifierBase abstract : INotifier, 
	ISupportLifecycle, IDisposable, IPersistSettings
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
NotifierBase(NotificationTypes)
Initializes a new instance of the notifier.

Dispose()()()
Releases all the resources used by the notifier.

Dispose(Boolean)
Releases the unmanaged resources used by the notifier and optionally releases the managed resources.

Enabled
Gets or sets a boolean value that indicates whether the notifier is currently enabled.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()
Releases the unmanaged resources before the notifier is reclaimed by GC.
(Overrides Object.Finalize()()().)
GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
Initialize()()()
Initializes the notifier.

LoadSettings()()()
Loads saved notifier settings from the config file if the PersistSettings property is set to true.

MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
NotificationSendComplete
Occurs when a notification has been sent.

NotificationSendException
Occurs when an Exception is encountered while sending a notification.

NotificationSendStart
Occurs when a notification is being sent.

NotificationSendTimeout
Occurs when a timeout is encountered while sending a notification.

Notify(String, String, String, NotificationTypes)
Process a notification.

NotifyAlarm(String, String, String)
When overridden in a derived class, processes a Alarm notification.

NotifyHeartbeat(String, String, String)
When overridden in a derived class, processes a Heartbeat notification.

NotifyInformation(String, String, String)
When overridden in a derived class, processes a Information notification.

NotifyOptions
Gets or set NotificationTypes that can be processed by the notifier.

NotifyTimeout
Gets or sets the number of seconds to wait for Notify(String, String, String, NotificationTypes) to complete.

NotifyWarning(String, String, String)
When overridden in a derived class, processes a Warning notification.

OnNotificationSendComplete()()()
Raises the NotificationSendComplete event.

OnNotificationSendException(Exception)
Raises the NotificationSendException event.

OnNotificationSendStart()()()
Raises the NotificationSendStart event.

OnNotificationSendTimeout()()()
Raises the NotificationSendTimeout event.

PersistSettings
Gets or sets a boolean value that indicates whether the notifier settings are to be saved to the config file.

SaveSettings()()()
Saves notifier settings to the config file if the PersistSettings property is set to true.

SettingsCategory
Gets or sets the category under which the notifier settings are to be saved to the config file if the PersistSettings property is set to true.

ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Inheritance Hierarchy
Object
NotifierBase
 EmailNotifier

Assembly: TVA.Historian (Module: TVA.Historian) Version: 1.0.33.39252