AFNotificationContact Properties
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFNotificationContact type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| Available |
This property indicates whether the AFNotificationContact
is available to receive notifications.
| |
| CategoryString | Obsolete.
This property is used by the AFNotificationContent object to determine if the
AFNotificationContact is interested in the category of the AFNotificationContent | |
| ConfigString |
This property returns the current configuration of the contact's delivery channel
as a string suitable for displaying to an end-user.
| |
| Contact |
This read-only property gets the AFContact associated with the
Notification contact.
| |
| ContactDefinition |
This read-only property returns the AFNotificationContact
that was used to create this AFNotificationContact from the
AFNotificationTemplate.
| |
| 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 delivery channel that is used by the
AFNotificationContact to deliver notifications.
| |
| DeliveryChannelPlugIn |
The delivery channel plugin property is used to specify which
delivery channel will be used in the AFNotificationContact to deliver the notification.
| |
| Description |
Read/write property that provides a more detailed description of the object.
| |
| EscalationTimeout |
This property is for an EscalationAFNotificationContact to specify the retry interval if the notification
send was not successful.
| |
| ExpirationPeriod | Obsolete.
This property is for an IndividualAFNotificationContact to specify the expiration period for
the notification.
| |
| 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.) | |
| MaximumRetries |
This property is for an IndividualAFNotificationContact to specify the maximum number of times
to retry sending the notification if it was not successful.
| |
| MinimumAcknowledgements |
This property is for an GroupAFNotificationContact to specify the minimum number of
acknowledgments before the group is considered to be acknowledged.
| |
| Name |
This property defines the name that identifies the object.
| |
| Notification |
This property returns the AFNotification object which owns the
notification contact.
| |
| NotificationContacts |
This is a collection of child contacts that have been added to this notification contact.
| |
| NotificationTemplate |
This property returns the AFNotificationTemplate object which owns the
notification contact.
| |
| NotifyWhenInstanceEnded |
This property is for an IndividualAFNotificationContact to specify that the notification
contact should be notified when the instance of the notification ends.
| |
| Parent |
This read-only property returns the AFNotificationContact 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 IndividualAFNotificationContact to specify the retry interval if the notification
send was not successful.
| |
| Template |
This read-only property returns the AFNotificationContactTemplate
that was used to create this AFNotificationContact.
| |
| UniqueID |
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.) |
See Also
In This Topic
Related Links
- Available Property
- CategoryString Property
- ConfigString Property
- Contact Property
- ContactDefinition Property
- ContactType Property
- Database Property
- DeliveryChannel Property
- DeliveryChannelPlugIn Property
- Description Property
- EscalationTimeout Property
- ExpirationPeriod Property
- MaximumRetries Property
- MinimumAcknowledgements Property
- Name Property
- Notification Property
- NotificationContacts Property
- NotificationTemplate Property
- NotifyWhenInstanceEnded Property
- Parent Property
- RetryInterval Property
- Template Property