AF SDK Reference

AFNotificationRule Class

Save PDF

TABLE OF CONTENTS

AFNotificationRule Class

Save PDF

Last UpdatedNov 18, 2025
11 minute read

The AFNotificationRule is a class representing objects used to generate a notification.

Inheritance Hierarchy

SystemObject
OSIsoft.AFAFObject
OSIsoft.AF.NotificationAFNotificationRule

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

Syntax

[SerializableAttribute]
public sealed class AFNotificationRule : AFObject, 
	IAFTransactable, IAFChangedEvent, IAFSecurable, IComparable<AFNotificationRule>

<SerializableAttribute>
Public NotInheritable Class AFNotificationRule
	Inherits AFObject
	Implements IAFTransactable, IAFChangedEvent, IAFSecurable, IComparable(Of AFNotificationRule)

Dim instance As AFNotificationRule

[SerializableAttribute]
public ref class AFNotificationRule sealed : public AFObject, 
	IAFTransactable, IAFChangedEvent, IAFSecurable, IComparable<AFNotificationRule^>

[<SealedAttribute>]
[<SerializableAttribute>]
type AFNotificationRule =  
    class
        inherit AFObject
        interface IAFTransactable
        interface IAFChangedEvent
        interface IAFSecurable
        interface IComparable<AFNotificationRule>
    end

The AFNotificationRule type exposes the following members.

Constructors

	Name	Description
	AFNotificationRule	Initializes a new instance of the class with the specified name.

Properties

	Name	Description
	AutoCreated	This read-only property indicates if this notification rule was automatically created by the server.
	Categories	This is a user-defined collection of categories for the object that can be used for querying and/or reporting purposes.
	CategoriesString	This read-only property returns the list of categories in a string separated by semicolons.
	CheckOutInfo	This read-only property returns the checked out status information for the object.
	ContentExample	Get or set the AFElement, AFEventFrame, or AFElementTemplate used as a content example.
	Criteria	This indicates the search criteria for the AFEventFrame that triggers the creation of the AFNotificationRule.
	Database	This read-only property returns the AFDatabase where this object is defined.
	DefaultDeliveryFormats	The collection of default AFDeliveryFormat objects for this notification.
	DeliveryFormats	The collection of AFDeliveryFormat objects for this notification.
	Description	Read/write property that provides a more detailed description of the object.
	HasTarget	This read-only property indicates if there is a target associated with this AFNotificationRule.
	HasTemplate	This read-only property indicates if this notification rule is defined by an AFNotificationRuleTemplate.
	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.)
	IsDeleted	This read-only property indicates whether the object has been deleted. (Inherited from AFObject.)
	IsDirty	This read-only property indicates whether the object has been modified since the last save to the PI AF Server.
	IsNew	This read-only property indicates whether the object is new and has never been saved to the PI AF Server.
	MultiTriggerEventOption	This property specifies when a notification is sent based on severity.
	Name	This property defines the name that identifies the object.
	NonrepetitionInterval	Non-repetition interval for the AFNotificationRule.
	PISystem	This read-only property allows access to the PISystem associated with this object. (Inherited from AFObject.)
	ResendInterval	The interval for resending the notification.
	Security	This read-only property returns the AFSecurity information for the object.
	Status	The current notification rule status.
	Subscribers	The collection of AFNotificationRuleSubscriber to be receive this notification.
	Target	Gets and sets the target of the AFNotificationRule.
	Template	This property returns the AFNotificationRuleTemplate that was used to create this AFNotificationRule.
	UniqueID	Read-only property that provides the object's ID as a String. (Inherited from AFObject.)

Methods

	Name	Description
	ApplyChanges	This method applies the changes to the object and makes those changes available to other objects for the current user.
	CheckIn	This method checks in (commits) all the changes to the object by saving the information to persistent storage.
	CheckOut	This method locks the object so that its configuration can be modified.
	CheckOutNotificationRules	Check out the objects with the specified unique identifiers at the specified query date.
	CompareTo(Object)	Compares this instance with a specified Object. (Inherited from AFObject.)
	CompareTo(AFObject)	Compares this instance with a specified AFObject. (Inherited from AFObject.)
	CreateNotificationRuleTemplate	Create an AFNotificationRuleTemplate based upon the AFNotificationRule object.
	Delete	Deletes this AFNotificationRule from the AFDatabase.
	DeleteNotificationRules	Delete the objects with the specified unique identifiers.
	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.)
	FindNotificationRule(PISystem, Guid)	Retrieves the AFNotificationRule object with the specified unique identifier at the AFTime.MaxValue query date.
	FindNotificationRule(PISystem, Guid, Object)	Retrieves the AFNotificationRule object with the specified unique identifier at the specified query date.
	FindNotificationRules	Performs a search within the PISystem to retrieve a collection of AFNotificationRule objects with the specified list of unique identifiers.
	GetAllDefaultDeliveryFormats	Gets a read only collection of all default AFDeliveryFormat that belong to this AFNotificationRule, to the AFNotificationRuleTemplate it was optionally created from, and to the PISystem.
	GetAllDeliveryFormats	Gets a read only collection of all AFDeliveryFormat that belong to this AFNotificationRule, to the AFNotificationRuleTemplate it was optionally created from, and to the PISystem.
	GetCounts(AFDatabase)	Get the number of notification rules for each status.
	GetCountsT(AFDatabase)	Get the number of notification rules for each filter.
	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.)
	GetSecurity	Gets the AFSecurity information of the specified security item associated with the object.
	GetStatus	Get the Status property immediately from the PI AF Server.
	GetStatus(IListAFNotificationRule)	Get the status for the list of specified AFNotificationRule from the PI AF Server.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	LoadNotificationRules(IListAFNotificationRule)	Loads the specified list AFNotificationRule objects.
	LoadNotificationRules(PISystem, Guid, Object)	Loads the AFNotificationRule objects with the specified unique identifiers at the specified query date.
	LoadTargets	Loads the Target of the specified list of AFNotificationRule objects.
	Persist	This method returns the persistence string for the object. (Inherited from AFObject.)
	Refresh	Refreshes the client with any changes that have been made to the object since loaded.
	ResetToTemplate	This method will reset the AFNotificationRule back to its template default values.
	SetStatus(AFStatus)	Set the Status property immediately in the server.
	SetStatus(IListAFNotificationRule, AFStatus)	Set the AFNotificationRule status.
	SetStatus(AFDatabase, AFObject, AFStatus, AFStatus)	Sets all the AFNotificationRule objects based upon a filter object to the specified status.
	ToString	Returns a String that represents the current object. (Inherited from AFObject.)
	UndoCheckOut	This method discards all the changes to the object and all sub-objects since the last call to CheckOut. Any changes since the check out will be lost.

Events

	Name	Description
	Changed	Event is raised when the object or one of its sub-objects is changed.

Remarks

A AFNotificationRule can be created from an AFNotificationRuleTemplate, or without a template. When based on a template, the notification rule will derive its initial definition from the template. Later modifications to the template will be propagated to all notifications created from it. If the template allows it, or if the notification was not created from a template, then the notification rule's subscribers and delivery formats can be augmented with additional members. The AFNotificationRuleSearch class can be used for finding notification rules.

Use the PISystem.Supports method to check if the PISystem supports the NotificationRule feature.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8

AF SDK Reference