AFNotificationRule Properties
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFNotificationRule type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| AutoCreated |
This read-only property indicates if this notification rule was automatically created by the server.
| |
| Categories |
This is a user-defined collection of categories for the object that can be used for
querying and/or reporting purposes.
| |
| CategoriesString |
This read-only property returns the list of categories in a string separated by semicolons.
| |
| CheckOutInfo |
This read-only property returns the checked out status information for the object.
| |
| ContentExample | ||
| Criteria |
This indicates the search criteria for the AFEventFrame that triggers the creation of
the AFNotificationRule.
| |
| Database |
This read-only property returns the AFDatabase where this object is defined.
| |
| DefaultDeliveryFormats |
The collection of default AFDeliveryFormat objects for this notification.
| |
| DeliveryFormats |
The collection of AFDeliveryFormat objects for this notification.
| |
| Description |
Read/write property that provides a more detailed description of the object.
| |
| HasTarget |
This read-only property indicates if there is a target
associated with this AFNotificationRule.
| |
| HasTemplate |
This read-only property indicates if this notification rule is defined by an AFNotificationRuleTemplate.
| |
| 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.) | |
| Identity |
This read-only property contains identity of the object.
(Inherited from AFObject.) | |
| IsDeleted |
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.) | |
| IsDirty |
This read-only property indicates whether the object has been modified since the
last save to the PI AF Server.
| |
| IsNew |
This read-only property indicates whether the object is new and has never been saved
to the PI AF Server.
| |
| MultiTriggerEventOption |
This property specifies when a notification is sent based on severity.
| |
| Name |
This property defines the name that identifies the object.
| |
| NonrepetitionInterval |
Non-repetition interval for the AFNotificationRule.
| |
| PISystem |
This read-only property allows access to the PISystem associated with this
object.
(Inherited from AFObject.) | |
| ResendInterval |
The interval for resending the notification.
| |
| Security |
This read-only property returns the AFSecurity information for the object.
| |
| Status |
The current notification rule status.
| |
| Subscribers |
The collection of AFNotificationRuleSubscriber to be receive this notification.
| |
| Target |
Gets and sets the target of the AFNotificationRule.
| |
| Template |
This property returns the AFNotificationRuleTemplate
that was used to create this AFNotificationRule.
| |
| UniqueID |
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.) |
See Also
In This Topic
Related Links
- AutoCreated Property
- Categories Property
- CategoriesString Property
- CheckOutInfo Property
- ContentExample Property
- Criteria Property
- Database Property
- DefaultDeliveryFormats Property
- DeliveryFormats Property
- Description Property
- HasTarget Property
- HasTemplate Property
- IsDirty Property
- IsNew Property
- MultiTriggerEventOption Property
- Name Property
- NonrepetitionInterval Property
- ResendInterval Property
- Security Property
- Status Property
- Subscribers Property
- Target Property
- Template Property