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

AF SDK Reference

AFNotificationRule Properties

  • Last UpdatedNov 18, 2025
  • 4 minute read
AFNotificationRule Properties

The AFNotificationRule type exposes the following members.

Properties

  NameDescription
Public property
AutoCreated
This read-only property indicates if this notification rule was automatically created by the server.
Public property
Categories
This is a user-defined collection of categories for the object that can be used for querying and/or reporting purposes.
Public property
CategoriesString
This read-only property returns the list of categories in a string separated by semicolons.
Public property
CheckOutInfo
This read-only property returns the checked out status information for the object.
Public property
ContentExample
Get or set the AFElement, AFEventFrame, or AFElementTemplate used as a content example.
Public property
Criteria
This indicates the search criteria for the AFEventFrame that triggers the creation of the AFNotificationRule.
Public property
Database
This read-only property returns the AFDatabase where this object is defined.
Public property
DefaultDeliveryFormats
The collection of default AFDeliveryFormat objects for this notification.
Public property
DeliveryFormats
The collection of AFDeliveryFormat objects for this notification.
Public property
Description
Read/write property that provides a more detailed description of the object.
Public property
HasTarget
This read-only property indicates if there is a target associated with this AFNotificationRule.
Public property
HasTemplate
This read-only property indicates if this notification rule is defined by an AFNotificationRuleTemplate.
Public property
ID
Read-only property that provides a unique identifier for the object to be used for quick access that is not dependent upon the index.
(Inherited from AFObject.)
Public property
Identity
This read-only property contains identity of the object.
(Inherited from AFObject.)
Public property
IsDeleted
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.)
Public property
IsDirty
This read-only property indicates whether the object has been modified since the last save to the PI AF Server.
Public property
IsNew
This read-only property indicates whether the object is new and has never been saved to the PI AF Server.
Public property
MultiTriggerEventOption
This property specifies when a notification is sent based on severity.
Public property
Name
This property defines the name that identifies the object.
Public property
NonrepetitionInterval
Non-repetition interval for the AFNotificationRule.
Public property
PISystem
This read-only property allows access to the PISystem associated with this object.
(Inherited from AFObject.)
Public property
ResendInterval
The interval for resending the notification.
Public property
Security
This read-only property returns the AFSecurity information for the object.
Public property
Status
The current notification rule status.
Public property
Subscribers
The collection of AFNotificationRuleSubscriber to be receive this notification.
Public property
Target
Gets and sets the target of the AFNotificationRule.
Public property
Template
This property returns the AFNotificationRuleTemplate that was used to create this AFNotificationRule.
Public property
UniqueID
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.)

See Also

TitleResults for “How to create a CRG?”Also Available in