AFNotificationContactTemplate Properties
- Last UpdatedNov 18, 2025
- 5 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFNotificationContactTemplate type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| Available |
This property indicates whether the AFNotificationContact objects created from this template
are 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.
| |
| CheckOutInfo |
This read-only property returns the checked out status information for the object.
| |
| 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 template.
| |
| ContactType |
The type of the AFNotificationContact to create from this template.
| |
| DeliveryChannel |
The instance of the delivery channel that is associated with the
AFNotificationContactTemplate to configure deliver notifications.
| |
| DeliveryChannelPlugIn |
The delivery channel plugin property is used to specify which
delivery channel will be used in the AFNotificationContact created from this
AFNotificationContactTemplate 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.
| |
| HasChildren |
This read-only property returns if the notification contact
template has child templates.
| |
| 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.
| |
| IsInternal |
This property indicates that the AFNotificationContactTemplate
is an internal template.
| |
| IsNew |
This read-only property indicates whether the object is new and has never been saved
to the PI AF Server.
| |
| 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.
| |
| NotificationContactTemplates |
This property returns the collection of child notification contact templates.
| |
| NotifyWhenInstanceEnded |
This property is for an IndividualAFNotificationContact to specify that the notification
contact should be notified when the instance of the notification ends.
| |
| 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.
| |
| Security |
This read-only property returns the AFSecurity information for the object.
| |
| 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
- CheckOutInfo Property
- ConfigString Property
- Contact Property
- ContactType Property
- DeliveryChannel Property
- DeliveryChannelPlugIn Property
- Description Property
- EscalationTimeout Property
- ExpirationPeriod Property
- HasChildren Property
- IsDirty Property
- IsInternal Property
- IsNew Property
- MaximumRetries Property
- MinimumAcknowledgements Property
- Name Property
- NotificationContactTemplates Property
- NotifyWhenInstanceEnded Property
- RetryInterval Property
- Security Property