AFNotificationRuleSubscriber Class
- Last UpdatedNov 18, 2025
- 7 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFNotificationRuleSubscriber defines the information needed to
deliver notifications.
Inheritance Hierarchy
Namespace: OSIsoft.AF.Notification
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[SerializableAttribute] public sealed class AFNotificationRuleSubscriber : AFObject
<SerializableAttribute> Public NotInheritable Class AFNotificationRuleSubscriber Inherits AFObject Dim instance As AFNotificationRuleSubscriber
[SerializableAttribute] public ref class AFNotificationRuleSubscriber sealed : public AFObject
[<SealedAttribute>] [<SerializableAttribute>] type AFNotificationRuleSubscriber = class inherit AFObject end
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.) |
Methods
| Name | Description | |
|---|---|---|
 | CompareTo(Object) |
Compares this instance with a specified Object.
(Inherited from AFObject.) |
| CompareTo(AFObject) |
Compares this instance with a specified AFObject.
(Inherited from AFObject.) |
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Inherited from AFObject.) |
| Equals(AFObject) |
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.) |
 | FindNotificationRuleSubscriber(AFNotificationRule, Guid) |
Retrieves the AFNotificationRuleSubscriber object with the specified unique identifier within
the AFNotificationRule.
|
| FindNotificationRuleSubscriber(AFNotificationRuleTemplate, Guid) |
Retrieves the AFNotificationRuleSubscriber object with the specified unique identifier within
the AFNotificationRuleTemplate.
|
| FindNotificationRuleSubscriber(AFNotificationRule, Guid, Guid) |
Retrieves the AFNotificationRuleSubscriber object with the specified unique identifier
and parent unique identifier within the AFNotificationRule.
|
| FindNotificationRuleSubscriber(AFNotificationRuleTemplate, Guid, Guid) |
Retrieves the AFNotificationRuleSubscriber object with the specified unique identifier
and parent unique identifier within the AFNotificationRuleTemplate.
|
| GetDeliveryFormat |
Get the AFDeliveryFormat object associated with the DeliveryChannelPlugIn.
|
| GetDeliveryFormat(AFObject) |
Get the AFDeliveryFormat object associated with the DeliveryChannelPlugIn.
|
| GetHashCode |
Gets the hash code for this instance of the object which is suitable for use in hashing
algorithms and data structures like a hash table.
(Inherited from AFObject.) |
| GetPath |
Returns the full path to the object, using just the names.
(Inherited from AFObject.) |
| GetPath(AFObject) |
Returns the path to the object relative from another object.
(Inherited from AFObject.) |
| GetPath(AFEncodeType, AFObject) |
Returns the path to the object relative from another object,
using the name and/or id as specified
by encodeType.
(Inherited from AFObject.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Persist |
This method returns the persistence string for the object.
(Inherited from AFObject.) |
| ToString |
Returns a String that represents the current object.
(Inherited from AFObject.) |
Remarks
If an AFNotificationRule is created from an AFNotificationRuleTemplate, then the subscriber hierarchy can be defined by the Subscribers collection.