AFNotificationRuleSubscribers Class
- Last UpdatedNov 18, 2025
- 6 minute read
- PI System
- AF SDK 2024 R2
- Developer
A collection of AFNotificationRuleSubscriber objects. This may be the
collection maintained by an AFNotificationRuleTemplate, an
AFNotificationRule, or another AFNotificationRuleSubscriber.
Inheritance Hierarchy
SystemObject
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFNotificationRuleSubscriber
OSIsoft.AFAFNamedCollectionAFNotificationRuleSubscriber
OSIsoft.AF.NotificationAFNotificationRuleSubscribers
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFNotificationRuleSubscriber
OSIsoft.AFAFNamedCollectionAFNotificationRuleSubscriber
OSIsoft.AF.NotificationAFNotificationRuleSubscribers
Namespace: OSIsoft.AF.Notification
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFNotificationRuleSubscribers : AFNamedCollection<AFNotificationRuleSubscriber>
Public NotInheritable Class AFNotificationRuleSubscribers Inherits AFNamedCollection(Of AFNotificationRuleSubscriber) Dim instance As AFNotificationRuleSubscribers
public ref class AFNotificationRuleSubscribers sealed : public AFNamedCollection<AFNotificationRuleSubscriber^>
[<SealedAttribute>] type AFNotificationRuleSubscribers = class inherit AFNamedCollection<AFNotificationRuleSubscriber> end
The AFNotificationRuleSubscribers type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | Count |
Gets the number of items actually contained in the collection.
(Inherited from AFCollectionT.) |
| Database |
This read-only property returns the AFDatabase where this object is defined.
|
| Identity |
This read-only property contains identity of the object.
(Inherited from AFCollection.) |
| IsDeleted |
This read-only property indicates whether the owner of the collection has been deleted.
(Inherited from AFCollection.) |
| ItemGuid | Returns the item in the collection associated with the passed in ID. (Inherited from AFCollectionT.) |
| ItemInt32 | Returns the item located at the passed in index. (Inherited from AFCollectionT.) |
| ItemString |
Returns the specified object from the collection by name.
(Inherited from AFNamedCollectionT.) |
| ItemIdentity |
This read-only property specifies the identity of the objects within the collection.
(Inherited from AFCollection.) |
| NotificationRule |
This property returns the AFNotificationRule object which owns the
AFNotificationRuleSubscriber collection.
|
| NotificationRuleTemplate |
This property returns the AFNotificationRuleTemplate object which owns the collection.
|
| Parent |
This read-only property returns the AFNotificationRuleSubscriber that owns this
collection.
|
| PISystem |
This read-only property allows access to the PISystem
associated with this collection.
(Inherited from AFCollection.) |
Methods
| Name | Description | |
|---|---|---|
 | Add(T) |
Adds an object to the end of the collection.
(Inherited from AFCollectionT.) |
| Add(AFNotificationContactTemplate) |
The Add method creates a new AFNotificationRuleSubscriber from an
AFNotificationContactTemplate and adds it to the collection.
|
| Clear |
Removes all items from the collection.
(Inherited from AFCollectionT.) |
| Contains(Guid) |
This method determines whether the collection contains a specific item referenced by id.
(Inherited from AFCollectionT.) |
| Contains(T) |
This method determines whether the collection contains a specific item.
(Inherited from AFCollectionT.) |
| Contains(String) |
This method determines whether the collection contains a specific item referenced by name.
(Inherited from AFNamedCollectionT.) |
| CopyTo |
Copies the entire collection to a compatible one-dimensional Array,
starting at the specified index of the target array.
(Inherited from AFCollectionT.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetEnumerator |
Returns an enumerator that iterates through the collection.
(Inherited from AFCollectionT.) |
| 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 AFCollection.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IndexOf |
Searches for the specified object and returns the zero-based index of the first
occurrence within the entire collection.
(Inherited from AFCollectionT.) |
| Remove(Guid) |
Removes the item with the specified id from the collection.
(Inherited from AFCollectionT.) |
| Remove(T) |
Removes the first occurrence of a specific object from the collection.
(Inherited from AFCollectionT.) |
| Remove(String) |
The Remove method removes the item from the collection by name.
(Inherited from AFNamedCollectionT.) |
| RemoveAt |
Removes the item at the specified index of the collection.
(Inherited from AFCollectionT.) |
| Sort |
Sorts the items in the entire collection using the default comparer.
(Inherited from AFCollectionT.) |
| Sort(IComparerT) |
Sorts the items in the entire collection using the specified comparer.
(Inherited from AFCollectionT.) |
| Sort(Int32, Int32, IComparerT) |
Sorts the items in a range of items in the collection using the specified comparer.
(Inherited from AFCollectionT.) |
| Swap |
Swap the items in the collection by specified index.
|
| ToString |
Returns a String that represents the current object.
(Inherited from AFCollection.) |
Remarks
The set of AFNotificationRuleSubscriber objects for an AFNotificationRule is a combination of those created from an AFNotificationContactTemplate or AFNotificationRuleTemplate), and if allowed, those added individually to the AFNotificationRule. The AFNotificationContactTemplate based subscribers are created from the NotificationContactTemplates collection of the AFNotificationContactTemplate that is used to create the subscriber or the Subscribers collection of the SubscriberDefinedOnTemplate if the subscriber was created from an AFNotificationRuleTemplate.