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

AF SDK Reference

AFNotificationContactTemplate Properties

  • Last UpdatedNov 18, 2025
  • 5 minute read
AFNotificationContactTemplate Properties

The AFNotificationContactTemplate type exposes the following members.

Properties

  NameDescription
Public property
Available
This property indicates whether the AFNotificationContact objects created from this template are available to receive notifications.
Public property
CategoryString Obsolete.
This property is used by the AFNotificationContent object to determine if the AFNotificationContact is interested in the Category of the AFNotificationContent.
Public property
CheckOutInfo
This read-only property returns the checked out status information for the object.
Public property
ConfigString
This property returns the current configuration of the contact's delivery channel as a string suitable for displaying to an end-user.
Public property
Contact
This read-only property gets the AFContact associated with the notification contact template.
Public property
ContactType
The type of the AFNotificationContact to create from this template.
Public property
DeliveryChannel
The instance of the delivery channel that is associated with the AFNotificationContactTemplate to configure deliver notifications.
Public property
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.
Public property
Description
Read/write property that provides a more detailed description of the object.
Public property
EscalationTimeout
This property is for an EscalationAFNotificationContact to specify the retry interval if the notification send was not successful.
Public property
ExpirationPeriod Obsolete.
This property is for an IndividualAFNotificationContact to specify the expiration period for the notification.
Public property
HasChildren
This read-only property returns if the notification contact template has child templates.
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
IsInternal
This property indicates that the AFNotificationContactTemplate is an internal template.
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
MaximumRetries
This property is for an IndividualAFNotificationContact to specify the maximum number of times to retry sending the notification if it was not successful.
Public property
MinimumAcknowledgements
This property is for an GroupAFNotificationContact to specify the minimum number of acknowledgments before the group is considered to be acknowledged.
Public property
Name
This property defines the name that identifies the object.
Public property
NotificationContactTemplates
This property returns the collection of child notification contact templates.
Public property
NotifyWhenInstanceEnded
This property is for an IndividualAFNotificationContact to specify that the notification contact should be notified when the instance of the notification ends.
Public property
PISystem
This read-only property allows access to the PISystem associated with this object.
(Inherited from AFObject.)
Public property
RetryInterval
This property is for an IndividualAFNotificationContact to specify the retry interval if the notification send was not successful.
Public property
Security
This read-only property returns the AFSecurity information for the object.
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