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

AF SDK Reference

TABLE OF CONTENTS

AFNotificationContacts Class

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedNov 18, 2025
  • 10 minute read
AFNotificationContacts Class
A collection of AFNotificationContact objects. This may be the collection maintained by an AFNotificationTemplate, by an AFNotification, or by another AFNotificationContact.

Inheritance Hierarchy

SystemObject
  OSIsoft.AFAFCollection
    OSIsoft.AFAFCollectionAFNotificationContact
      OSIsoft.AFAFNamedCollectionAFNotificationContact
        OSIsoft.AF.NotificationAFNotificationContacts

Namespace:  OSIsoft.AF.Notification
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public sealed class AFNotificationContacts : AFNamedCollection<AFNotificationContact>, 
	IAFNamedCollection<IAFNotificationContact>, ICollection<IAFNotificationContact>, IEnumerable<IAFNotificationContact>, 
	IEnumerable, IList<IAFNotificationContact>, IAFTrace
Public NotInheritable Class AFNotificationContacts
	Inherits AFNamedCollection(Of AFNotificationContact)
	Implements IAFNamedCollection(Of IAFNotificationContact), ICollection(Of IAFNotificationContact), 
	IEnumerable(Of IAFNotificationContact), IEnumerable, IList(Of IAFNotificationContact), 
	IAFTrace

Dim instance As AFNotificationContacts
public ref class AFNotificationContacts sealed : public AFNamedCollection<AFNotificationContact^>, 
	IAFNamedCollection<IAFNotificationContact^>, ICollection<IAFNotificationContact^>, IEnumerable<IAFNotificationContact^>, 
	IEnumerable, IList<IAFNotificationContact^>, IAFTrace
[<SealedAttribute>]
type AFNotificationContacts =  
    class
        inherit AFNamedCollection<AFNotificationContact>
        interface IAFNamedCollection<IAFNotificationContact>
        interface ICollection<IAFNotificationContact>
        interface IEnumerable<IAFNotificationContact>
        interface IEnumerable
        interface IList<IAFNotificationContact>
        interface IAFTrace
    end

The AFNotificationContacts type exposes the following members.

Properties

  NameDescription
Public property
Count
Gets the number of items actually contained in the collection.
(Inherited from AFCollectionT.)
Public property
Database
This read-only property returns the AFDatabase where this object is defined.
Public property
Identity
This read-only property contains identity of the object.
(Inherited from AFCollection.)
Public property
IsDeleted
This read-only property indicates whether the owner of the collection has been deleted.
(Inherited from AFCollection.)
Public property
ItemGuid
Returns the item in the collection associated with the passed in ID.
(Inherited from AFCollectionT.)
Public property
ItemInt32
Returns the item located at the passed in index.
(Inherited from AFCollectionT.)
Public property
ItemString
Returns the specified object from the collection by name.
(Inherited from AFNamedCollectionT.)
Public property
ItemIdentity
This read-only property specifies the identity of the objects within the collection.
(Inherited from AFCollection.)
Public property
Notification
This property returns the AFNotification object which owns the notification contact collection.
Public property
NotificationTemplate
This property returns the AFNotificationTemplate object which owns the notification contact collection.
Public property
Parent
This read-only property returns the AFNotificationContact that owns this collection of notification contacts.
Public property
PISystem
This read-only property allows access to the PISystem associated with this collection.
(Inherited from AFCollection.)

Methods

  NameDescription
Public method
Add(T)
Adds an object to the end of the collection.
(Inherited from AFCollectionT.)
Public method
Add(String)
The Add method creates a new object and adds it to the collection.
Public method
Add(AFNotificationContactTemplate)
The Add method creates a new AFNotificationContact from an AFNotificationContactTemplate and adds it to the collection.
Public method
Add(AFContact, String)
The Add method creates a new AFNotificationContact with an associated AFContact and adds it to the collection.
Public method
Clear
Removes all items from the collection.
(Inherited from AFCollectionT.)
Public method
Contains(Guid)
This method determines whether the collection contains a specific item referenced by id.
(Inherited from AFCollectionT.)
Public method
Contains(T)
This method determines whether the collection contains a specific item.
(Inherited from AFCollectionT.)
Public method
Contains(String)
This method determines whether the collection contains a specific item referenced by name.
(Inherited from AFNamedCollectionT.)
Public method
CopyTo
Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array.
(Inherited from AFCollectionT.)
Public method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public method
GetEnumerator
Returns an enumerator that iterates through the collection.
(Inherited from AFCollectionT.)
Public method
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.)
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
IndexOf
Searches for the specified object and returns the zero-based index of the first occurrence within the entire collection.
(Inherited from AFCollectionT.)
Public method
Insert
Inserts an item into the collection at the specified index.
Public method
IsTraced
Indicates if a specified level is being traced.
Public method
Remove(Guid)
Removes the item with the specified id from the collection.
(Inherited from AFCollectionT.)
Public method
Remove(T)
Removes the first occurrence of a specific object from the collection.
(Inherited from AFCollectionT.)
Public method
Remove(String)
The Remove method removes the item from the collection by name.
(Inherited from AFNamedCollectionT.)
Public method
RemoveAt
Removes the item at the specified index of the collection.
(Inherited from AFCollectionT.)
Public method
Sort
Sorts the items in the entire collection using the default comparer.
(Inherited from AFCollectionT.)
Public method
Sort(IComparerT)
Sorts the items in the entire collection using the specified comparer.
(Inherited from AFCollectionT.)
Public method
Sort(Int32, Int32, IComparerT)
Sorts the items in a range of items in the collection using the specified comparer.
(Inherited from AFCollectionT.)
Public method
Swap
Swap the items in the collection by specified index.
Public method
ToString
Returns a String that represents the current object.
(Inherited from AFCollection.)
Public method
TraceData
Output a data trace event.
Public method
TraceDetail
Output a detail trace event.
Public method
TraceError
Output an error trace event.
Public method
TraceEvent(AFTraceSwitchLevel, String)
Output a trace event with a message.
Public method
TraceEvent(AFTraceSwitchLevel, String, Int32)
Output a trace event with a message and a duration.
Public method
TraceEvent(AFTraceSwitchLevel, String, Object)
Output a trace event as a formatted message with a variable number of arguments.
Public method
TraceInformation
Output an information trace event.
Public method
TraceSummary
Output a summary trace event.
Public method
TraceWarning
Output a warning trace event.

Extension Methods

  NameDescription
Public Extension MethodCode example
ChunkedByIAFNotificationContact
This extension method breaks up search results into chunks to make it easier to page through and process IEnumerableT collections in chunks.
(Defined by AFSDKExtension.)

Remarks

The set of notification contacts for an AFNotification is a combination of those created from a template (AFNotificationContactTemplate or AFNotificationTemplate), and if allowed, those added individually to the notification. The template based notification contacts are created from the NotificationContactTemplates collection in the AFNotificationContactTemplate that is used to create the notification contact or the NotificationContacts collection of the ContactDefinition if the notification contact was created from an AFNotificationTemplate.

Examples

// This example demonstrates how to create a hierarchy of notification
// contact templates and use them to create a hierarchy of notification
// contacts in a new notification. Then information about the created
// notification contacts is displayed.

// Get the Database
PISystems myPISystems = new PISystems();
PISystem myPISystem = myPISystems.DefaultPISystem;
AFDatabase myDB = myPISystem.Databases.DefaultDatabase;

// Create a Hierarchy of Notification Contact Templates
AFNotificationContactTemplate myContactTemplate1 = new AFNotificationContactTemplate(myPISystem, "MyContact#1");
AFNotificationContactTemplate myContactTemplate2 = new AFNotificationContactTemplate(myPISystem, "MyContact#2");
AFNotificationContactTemplate myGroupContactTemplate = new AFNotificationContactTemplate(myPISystem, "MyGroup");
myGroupContactTemplate.ContactType = AFNotificationContactType.Group;
myGroupContactTemplate.NotificationContactTemplates.Add(myContactTemplate1);
myGroupContactTemplate.NotificationContactTemplates.Add(myContactTemplate2);

// Create a Notification with Notification Contacts
AFNotification myNotification = new AFNotification(myDB, "MyNotification");
myNotification.NotificationContacts.Add("MyLocalContact#1");
myNotification.NotificationContacts.Add(myGroupContactTemplate);

// Display Information for the Created Notification Contacts
foreach (AFNotificationContact item in myNotification.NotificationContacts)
{
    Console.WriteLine("Name of Notification Contact = {0}", item.Name);
    foreach (AFNotificationContact subItem in item.NotificationContacts)
    {
        Console.WriteLine("  Name of Notification Contact = {0}", subItem.Name);
    }
}
' This example demonstrates how to create a hierarchy of notification
' contact templates and use them to create a hierarchy of notification
' contacts in a new notification. Then information about the created
' notification contacts is displayed.

' Get the Database
Dim myPISystems As PISystems = New PISystems
Dim myPISystem As PISystem = myPISystems.DefaultPISystem
Dim myDB As AFDatabase = myPISystem.Databases.DefaultDatabase

' Create a Hierarchy of Notification Contact Templates
Dim myContactTemplate1 As AFNotificationContactTemplate = New AFNotificationContactTemplate(myPISystem, "MyContact#1")
Dim myContactTemplate2 As AFNotificationContactTemplate = New AFNotificationContactTemplate(myPISystem, "MyContact#2")
Dim myGroupContactTemplate As AFNotificationContactTemplate = New AFNotificationContactTemplate(myPISystem, "MyGroup")
myGroupContactTemplate.ContactType = AFNotificationContactType.Group
myGroupContactTemplate.NotificationContactTemplates.Add(myContactTemplate1)
myGroupContactTemplate.NotificationContactTemplates.Add(myContactTemplate2)

' Create a Notification with Notification Contacts
Dim myNotification As AFNotification = New AFNotification(myDB, "MyNotification")
myNotification.NotificationContacts.Add("MyLocalContact#1")
myNotification.NotificationContacts.Add(myGroupContactTemplate)

' Display Information for the Created Notification Contacts
For Each item As AFNotificationContact In myNotification.NotificationContacts
    Console.WriteLine("Name of Notification Contact = {0}", item.Name)
    For Each subItem As AFNotificationContact In item.NotificationContacts
        Console.WriteLine("  Name of Notification Contact = {0}", subItem.Name)
    Next
Next

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.

Version Information

AFSDK


See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in