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

AF SDK Reference

AFNotificationContents Class

  • Last UpdatedNov 18, 2025
  • 9 minute read
AFNotificationContents Class
A collection of AFNotificationContent objects. This may be the collection maintained by an AFNotificationTemplate or by an AFNotification.

Inheritance Hierarchy

SystemObject
  OSIsoft.AFAFCollection
    OSIsoft.AFAFCollectionAFNotificationContent
      OSIsoft.AFAFNamedCollectionAFNotificationContent
        OSIsoft.AF.NotificationAFNotificationContents

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

Syntax

public sealed class AFNotificationContents : AFNamedCollection<AFNotificationContent>, 
	IAFTrace
Public NotInheritable Class AFNotificationContents
	Inherits AFNamedCollection(Of AFNotificationContent)
	Implements IAFTrace

Dim instance As AFNotificationContents
public ref class AFNotificationContents sealed : public AFNamedCollection<AFNotificationContent^>, 
	IAFTrace
[<SealedAttribute>]
type AFNotificationContents =  
    class
        inherit AFNamedCollection<AFNotificationContent>
        interface IAFTrace
    end

The AFNotificationContents 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 content collection.
Public property
NotificationTemplate
This property returns the AFNotificationTemplate object which owns the notification content collection.
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)
Creates a new AFAttribute and a new AFNotificationContent using the specified name.
Public method
Add(AFAttribute)
Creates a new AFNotificationContent using an AFAttribute from the AFNotification.
Public method
Add(AFAttributeTemplate)
Creates a new AFNotificationContent using an AFAttribute from the AFNotification.
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
GetContentsForContact
Gets the list of AFNotificationContent objects for the current user.
Public method
GetContentsForContact(AFContact)
Gets the list of AFNotificationContent objects for the specified AFContact.
Public method
GetContentsForContact(AFNotificationContact)
Gets the list of AFNotificationContent objects for the specified AFNotificationContact.
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
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
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.

Remarks

The set of notification contents for an AFNotification is a combination of those created from an AFNotificationTemplate), and those added individually to the AFNotification. The template based notification contents are created from the Contents collection in the AFNotificationTemplate that is used to create the notification.

Examples

// This example demonstrates how to create a notification template that
// defines some notification contacts and notification contents. It then
// creates a notification from the template and displays its information.

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

// Create a Notification Template
AFNotificationTemplate myNotificationTemplate = new AFNotificationTemplate("MyNotificationTemplate");
myDB.ElementTemplates.Add(myNotificationTemplate);
AFNotificationContact myTmplContact1 = myNotificationTemplate.NotificationContacts.Add("MyContact#1");
AFNotificationContact myTmplContact2 = myNotificationTemplate.NotificationContacts.Add("MyContact#2");
AFNotificationContent myTmplContent1 = myNotificationTemplate.Contents.Add("MyContent#1");
myTmplContent1.NotificationContacts.Add(myTmplContact1);

// Create a Notification from the Notification Template
// and Add Additional Contacts and Content
AFNotification myNotification = new AFNotification(myDB, "MyNotification", myNotificationTemplate, null);
AFNotificationContact myContact1 = myNotification.NotificationContacts["MyContact#1"];
AFNotificationContact myContact2 = myNotification.NotificationContacts["MyContact#2"];
AFNotificationContact myContact3 = myNotification.NotificationContacts.Add("MyContact#3");
AFNotificationContent myContent1 = myNotification.Contents["MyContent#1"];
AFNotificationContent myContent2 = myNotification.Contents.Add("MyContent#2");
myContent1.NotificationContacts.Add(myContact3);
myContent2.NotificationContacts.Add(myContact2);
myContent2.NotificationContacts.Add(myContact3);

// Display Information for the Notification Contents
foreach (AFNotificationContent item in myNotification.Contents)
{
    Console.WriteLine("Name of Notification Content = {0}", item.Name);
    if (item.Attribute != null)
        Console.WriteLine("    Content's Attribute = {0}", item.Attribute.Name);
}
' This example demonstrates how to create a notification template that
' defines some notification contacts and notification contents. It then
' creates a notification from the template and displays its information.

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

' Create a Notification Template
Dim myNotificationTemplate As AFNotificationTemplate = New AFNotificationTemplate("MyNotificationTemplate")
myDB.ElementTemplates.Add(myNotificationTemplate)
Dim myTmplContact1 As AFNotificationContact = myNotificationTemplate.NotificationContacts.Add("MyContact#1")
Dim myTmplContact2 As AFNotificationContact = myNotificationTemplate.NotificationContacts.Add("MyContact#2")
Dim myTmplContent1 As AFNotificationContent = myNotificationTemplate.Contents.Add("MyContent#1")
myTmplContent1.NotificationContacts.Add(myTmplContact1)

' Create a Notification from the Notification Template
' and Add Additional Contacts and Content
Dim myNotification As AFNotification = New AFNotification(myDB, "MyNotification", myNotificationTemplate, Nothing)
Dim myContact1 As AFNotificationContact = myNotification.NotificationContacts("MyContact#1")
Dim myContact2 As AFNotificationContact = myNotification.NotificationContacts("MyContact#2")
Dim myContact3 As AFNotificationContact = myNotification.NotificationContacts.Add("MyContact#3")
Dim myContent1 As AFNotificationContent = myNotification.Contents("MyContent#1")
Dim myContent2 As AFNotificationContent = myNotification.Contents.Add("MyContent#2")
myContent1.NotificationContacts.Add(myContact3)
myContent2.NotificationContacts.Add(myContact2)
myContent2.NotificationContacts.Add(myContact3)

' Display Information for the Notification Contents
For Each item As AFNotificationContent In myNotification.Contents
    Console.WriteLine("Name of Notification Content = {0}", item.Name)
    If item.Attribute <> Nothing Then
        Console.WriteLine("    Content's Attribute = {0}", item.Attribute.Name)
    End If
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

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