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

AFNotificationRuleTemplate Class

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedNov 18, 2025
  • 9 minute read
AFNotificationRuleTemplate Class
The AFNotificationRuleTemplate represents a template of information used to create an AFNotificationRule.

Inheritance Hierarchy

SystemObject
  OSIsoft.AFAFObject
    OSIsoft.AF.NotificationAFNotificationRuleTemplate

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

Syntax

[SerializableAttribute]
public sealed class AFNotificationRuleTemplate : AFObject, 
	IAFTransactable, IAFChangedEvent, IAFSecurable, IComparable<AFNotificationRuleTemplate>
<SerializableAttribute>
Public NotInheritable Class AFNotificationRuleTemplate
	Inherits AFObject
	Implements IAFTransactable, IAFChangedEvent, IAFSecurable, IComparable(Of AFNotificationRuleTemplate)

Dim instance As AFNotificationRuleTemplate
[SerializableAttribute]
public ref class AFNotificationRuleTemplate sealed : public AFObject, 
	IAFTransactable, IAFChangedEvent, IAFSecurable, IComparable<AFNotificationRuleTemplate^>
[<SealedAttribute>]
[<SerializableAttribute>]
type AFNotificationRuleTemplate =  
    class
        inherit AFObject
        interface IAFTransactable
        interface IAFChangedEvent
        interface IAFSecurable
        interface IComparable<AFNotificationRuleTemplate>
    end

The AFNotificationRuleTemplate type exposes the following members.

Constructors

  NameDescription
Public method
AFNotificationRuleTemplate
Initializes a new instance of the class with default values.
Public method
AFNotificationRuleTemplate(String, AFElementTemplate, Boolean)
Initializes a new instance of the class with the specified name.

Properties

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

Methods

  NameDescription
Public methodCode example
ApplyChanges
This method applies the changes to the object and makes those changes available to other objects for the current user.
Public methodCode example
CheckIn
This method checks in (commits) all the changes to the object by saving the information to persistent storage.
Public method
CheckOut
This method locks the object so that its configuration can be modified.
Public methodStatic member
CheckOutNotificationRuleTemplates
Check out the objects with the specified unique identifiers at the specified query date.
Public method
CompareTo(Object)
Compares this instance with a specified Object.
(Inherited from AFObject.)
Public method
CompareTo(AFObject)
Compares this instance with a specified AFObject.
(Inherited from AFObject.)
Public method
Delete
Deletes this AFNotificationRuleTemplate from the AFDatabase.
Public methodStatic member
DeleteNotificationRuleTemplates
Delete the objects with the specified unique identifiers.
Public method
Equals(Object)
Determines whether the specified Object is equal to the current object.
(Inherited from AFObject.)
Public method
Equals(AFObject)
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.)
Public methodStatic member
FindNotificationRuleTemplate(PISystem, Guid)
Retrieves the AFNotificationRuleTemplate object with the specified unique identifier at the AFTime.MaxValue query date.
Public methodStatic member
FindNotificationRuleTemplate(PISystem, Guid, Object)
Retrieves the AFNotificationRuleTemplate object with the specified unique identifier at the specified query date.
Public methodStatic member
FindNotificationRuleTemplates
Performs a search within the PISystem to retrieve a collection of AFNotificationRuleTemplate objects with the specified list of unique identifiers.
Public method
GetAllDefaultDeliveryFormats
Gets a read only collection of all default AFDeliveryFormat that belong to this AFNotificationRuleTemplate and to the PISystem.
Public method
GetAllDeliveryFormats
Gets a read only collection of all AFDeliveryFormat that belong to this AFNotificationRuleTemplate and to the PISystem.
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 AFObject.)
Public method
GetPath
Returns the full path to the object, using just the names.
(Inherited from AFObject.)
Public method
GetPath(AFObject)
Returns the path to the object relative from another object.
(Inherited from AFObject.)
Public method
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.)
Public method
GetSecurity
Gets the AFSecurity information of the specified security item associated with the object.
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic member
LoadNotificationRuleTemplates(IListAFNotificationRuleTemplate)
Loads the specified list AFNotificationRuleTemplate objects.
Public methodStatic member
LoadNotificationRuleTemplates(PISystem, Guid, Object)
Loads the AFNotificationRuleTemplate objects with the specified unique identifiers at the specified query date.
Public method
Persist
This method returns the persistence string for the object.
(Inherited from AFObject.)
Public method
Refresh
Refreshes the client with any changes that have been made to the object since loaded.
Public method
ToString
Returns a String that represents the current object.
(Inherited from AFObject.)
Public method
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

  NameDescription
Public eventCode example
Changed
Event is raised when the object or one of its sub-objects is changed.

Remarks

The template specifies the initial value of several of the properties for the AFNotificationRule created from the template. The AFNotificationRuleTemplateSearch class can be used for finding notification rule templates.

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

See Also

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