Click or drag to resize
OSIsoft, LLC

OSIsoft.AF.Notification Namespace

The OSIsoft.AF.Notification namespace provides a set of classes for creating notifications to inform users about actions that have occurred.
Classes
  ClassDescription
Public classAFDefaultDeliveryFormats
A collection of default AFDeliveryFormat objects. This may be a collection maintained by an AFNotificationRuleTemplate or an AFNotificationRule.
Public classAFDeliveryChannel
The AFDeliveryChannel defines the information needed for an notification to receive events.
Public classCode exampleAFDeliveryChannelContactPropertyAttribute
Attribute used on an AFDeliveryChannel to specify linked properties of an AFContact.
Public classAFDeliveryFormat
The AFDeliveryFormat defines the format of an AFNotificationRule.
Public classAFDeliveryFormats
A collection of AFDeliveryFormat objects. This may be a collection maintained by an AFNotificationRuleTemplate, an AFNotificationRule or a PISystem.
Public classCode exampleAFNotification
The AFNotification is a class representing objects used to generate a notification.
Public classCode exampleAFNotificationContact
The AFNotificationContact defines the information needed to deliver notifications.
Public classCode exampleAFNotificationContacts
A collection of AFNotificationContact objects. This may be the collection maintained by an AFNotificationTemplate, by an AFNotification, or by another AFNotificationContact.
Public classCode exampleAFNotificationContactTemplate
The AFNotificationContactTemplate provides the definition used to create AFNotificationContact objects within an AFNotification or AFNotificationRuleSubscriber objects within an AFNotificationRule.
Public classCode exampleAFNotificationContactTemplates
The collection of AFNotificationContactTemplate objects is maintained by the AFNotificationContactTemplate.
Public classCode exampleAFNotificationContent
The AFNotificationContent defines content associated with a notification.
Public classAFNotificationContentResult
The result content of an AFNotification.
Public classAFNotificationContentResults
The collection of AFNotificationContentResult objects associated with an AFNotification.
Public classCode exampleAFNotificationContents
A collection of AFNotificationContent objects. This may be the collection maintained by an AFNotificationTemplate or by an AFNotification.
Public classAFNotificationRule
The AFNotificationRule is a class representing objects used to generate a notification.
Public classAFNotificationRules
A collection of all AFNotificationRule objects that target an AFElement.
Public classAFNotificationRuleSubscriber
The AFNotificationRuleSubscriber defines the information needed to deliver notifications.
Public classAFNotificationRuleSubscribers
A collection of AFNotificationRuleSubscriber objects. This may be the collection maintained by an AFNotificationRuleTemplate, an AFNotificationRule, or another AFNotificationRuleSubscriber.
Public classAFNotificationRuleTemplate
The AFNotificationRuleTemplate represents a template of information used to create an AFNotificationRule.
Public classAFNotificationRuleTemplates
A collection of AFNotificationRuleTemplate maintained on either an AFElementTemplate or AFDatabase. The AFDatabase collection contains all AFNotificationRuleTemplate objects associated with that database. The AFElementTemplate collection contains all AFNotificationRuleTemplate objects that target the AFElementTemplate
Public classAFNotifications Obsolete.
An obsoleted collection of all AFNotification objects in an AFDatabase.
Public classCode exampleAFNotificationTemplate
The AFNotificationTemplate represents a template of information used to create an AFNotification.
Interfaces
  InterfaceDescription
Public interfaceIAFNotificationContact
Common interface for properties and methods of AFNotificationContactTemplate and AFNotificationContact.
Enumerations
  EnumerationDescription
Public enumerationAFMultiTriggerEventOption
Defines at which severity an AFNotificationRule is sent.
Public enumerationAFNotificationContactType
Public enumerationAFNotificationContentCOGParameter
Enumeration for Content COG Parameters
Public enumerationAFNotificationContentType
Enumeration for content type
Public enumerationAFNotificationContentURLParameter
Enumeration for Content URL Parameters
Public enumerationAFNotificationTemplateAutoCreateOption
Options for automatically creating an AFNotification for an AFElement.
Public enumerationAFNotifyOption
Defines when an AFNotificationRule is to be sent.
Enabling Operational Intelligence