AFNotificationRuleSubscriber Properties
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFNotificationRuleSubscriber type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| ConfigString |
This property returns the current configuration of the contact's delivery channel
as a string suitable for displaying to an end-user.
| |
| ContactTemplate |
This read-only property returns the AFNotificationContactTemplate
that was used to create this AFNotificationRuleSubscriber.
| |
| ContactType |
The type of the notification contact.
| |
| Database |
This read-only property returns the AFDatabase where this object is defined.
| |
| DeliveryChannel |
The instance of the AFDeliveryChannel that is used by the
AFNotificationRuleSubscriber to deliver notifications.
| |
| DeliveryChannelPlugIn |
The delivery channel plug in property is used to specify which
delivery channel will be used in the AFNotificationRuleSubscriber to deliver the AFNotificationRule.
| |
| DeliveryFormat |
Get or set the AFDeliveryFormat associated with the current AFNotificationRuleSubscriber.
| |
| Description |
Read/write property that provides a more detailed description of the object.
| |
| EscalationTimeout |
This property is for an EscalationAFNotificationRuleSubscriber to specify the retry interval if the notification
send was not successful.
| |
| 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.) | |
| IsDefinedByTemplate |
Indicates whether the current subscriber was created from an Subscribers
collection.
| |
| IsDeleted |
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.) | |
| MaximumRetries |
This property is for an IndividualAFNotificationRuleSubscriber to specify the maximum number of times
to retry sending the notification if it was not successful.
| |
| Name |
Read/write property that identifies the name of the object.
| |
| NotificationRule |
This property returns the AFNotificationRule object which owns the
AFNotificationRuleSubscriber.
| |
| NotificationRuleTemplate |
This property returns the AFNotificationRuleTemplate object which owns the
AFNotificationRuleSubscriber.
| |
| NotifyOption |
This property specifies when the subscriber will receive notifications.
| |
| Parent |
This read-only property returns the AFNotificationRuleSubscriber that
is the parent of this notification contact.
| |
| PISystem |
This read-only property allows access to the PISystem associated with this
object.
(Inherited from AFObject.) | |
| RetryInterval |
This property is for an IndividualAFNotificationRuleSubscriber to specify the retry interval if the notification
send was not successful.
| |
| SubscriberDefinedOnTemplate |
This read-only property returns the AFNotificationRuleSubscriber
that was used to create this AFNotificationRuleSubscriber from the
Subscribers collection.
| |
| Subscribers |
This is a collection of child AFNotificationRuleSubscriber objects that have been added to this AFNotificationRuleSubscriber.
| |
| UniqueID |
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.) |
See Also
In This Topic
Related Links
- ConfigString Property
- ContactTemplate Property
- ContactType Property
- Database Property
- DeliveryChannel Property
- DeliveryChannelPlugIn Property
- DeliveryFormat Property
- Description Property
- EscalationTimeout Property
- IsDefinedByTemplate Property
- MaximumRetries Property
- Name Property
- NotificationRule Property
- NotificationRuleTemplate Property
- NotifyOption Property
- Parent Property
- RetryInterval Property
- SubscriberDefinedOnTemplate Property
- Subscribers Property