Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

TABLE OF CONTENTS

OSIsoft.AF.Notification Namespace

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedNov 18, 2025
  • 5 minute read
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 class
AFDefaultDeliveryFormats
A collection of default AFDeliveryFormat objects. This may be a collection maintained by an AFNotificationRuleTemplate or an AFNotificationRule.
Public class
AFDeliveryChannel
The AFDeliveryChannel defines the information needed for an notification to receive events.
Public classCode example
AFDeliveryChannelContactPropertyAttribute
Attribute used on an AFDeliveryChannel to specify linked properties of an AFContact.
Public class
AFDeliveryFormat
The AFDeliveryFormat defines the format of an AFNotificationRule.
Public class
AFDeliveryFormats
A collection of AFDeliveryFormat objects. This may be a collection maintained by an AFNotificationRuleTemplate, an AFNotificationRule or a PISystem.
Public classCode example
AFNotification
The AFNotification is a class representing objects used to generate a notification.
Public classCode example
AFNotificationContact
The AFNotificationContact defines the information needed to deliver notifications.
Public classCode example
AFNotificationContacts
A collection of AFNotificationContact objects. This may be the collection maintained by an AFNotificationTemplate, by an AFNotification, or by another AFNotificationContact.
Public classCode example
AFNotificationContactTemplate
The AFNotificationContactTemplate provides the definition used to create AFNotificationContact objects within an AFNotification or AFNotificationRuleSubscriber objects within an AFNotificationRule.
Public classCode example
AFNotificationContactTemplates
The collection of AFNotificationContactTemplate objects is maintained by the AFNotificationContactTemplate.
Public classCode example
AFNotificationContent
The AFNotificationContent defines content associated with a notification.
Public class
AFNotificationContentResult
The result content of an AFNotification.
Public class
AFNotificationContentResults
The collection of AFNotificationContentResult objects associated with an AFNotification.
Public classCode example
AFNotificationContents
A collection of AFNotificationContent objects. This may be the collection maintained by an AFNotificationTemplate or by an AFNotification.
Public class
AFNotificationRule
The AFNotificationRule is a class representing objects used to generate a notification.
Public class
AFNotificationRules
A collection of all AFNotificationRule objects that target an AFElement.
Public class
AFNotificationRuleSubscriber
The AFNotificationRuleSubscriber defines the information needed to deliver notifications.
Public class
AFNotificationRuleSubscribers
A collection of AFNotificationRuleSubscriber objects. This may be the collection maintained by an AFNotificationRuleTemplate, an AFNotificationRule, or another AFNotificationRuleSubscriber.
Public class
AFNotificationRuleTemplate
The AFNotificationRuleTemplate represents a template of information used to create an AFNotificationRule.
Public class
AFNotificationRuleTemplates
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 class
AFNotifications Obsolete.
An obsoleted collection of all AFNotification objects in an AFDatabase.
Public classCode example
AFNotificationTemplate
The AFNotificationTemplate represents a template of information used to create an AFNotification.

Interfaces

  InterfaceDescription
Public interface
IAFNotificationContact
Common interface for properties and methods of AFNotificationContactTemplate and AFNotificationContact.

Enumerations

  EnumerationDescription
Public enumeration
AFMultiTriggerEventOption
Defines at which severity an AFNotificationRule is sent.
Public enumeration
AFNotificationContactType
The value used for the AFNotificationContactTemplate.ContactType or AFNotificationContact.ContactType properties.
Public enumeration
AFNotificationContentCOGParameter
Enumeration for Content COG Parameters
Public enumeration
AFNotificationContentType
Enumeration for content type
Public enumeration
AFNotificationContentURLParameter
Enumeration for Content URL Parameters
Public enumeration
AFNotificationTemplateAutoCreateOption
Options for automatically creating an AFNotification for an AFElement.
Public enumeration
AFNotifyOption
Defines when an AFNotificationRule is to be sent.
In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in