Click or drag to resize
OSIsoft, LLC

AFNotificationRule Class

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: 2.10.8.440
Syntax
[SerializableAttribute]
public sealed class AFNotificationRule : AFObject, 
	IAFTransactable, IAFChangedEvent, IAFSecurable, IComparable<AFNotificationRule>

The AFNotificationRule type exposes the following members.

Constructors
  NameDescription
Public methodAFNotificationRule
Initializes a new instance of the class with the specified name.
Top
Properties
  NameDescription
Public propertyAutoCreated
This read-only property indicates if this notification rule was automatically created by the server.
Public propertyCategories
This is a user-defined collection of categories for the object that can be used for querying and/or reporting purposes.
Public propertyCategoriesString
This read-only property returns the list of categories in a string separated by semicolons.
Public propertyCheckOutInfo
This read-only property returns the checked out status information for the object.
Public propertyContentExample
Get or set the AFElement, AFEventFrame, or AFElementTemplate used as a content example.
Public propertyCriteria
This indicates the search criteria for the AFEventFrame that triggers the creation of the AFNotificationRule.
Public propertyDatabase
This read-only property returns the AFDatabase where this object is defined.
Public propertyDefaultDeliveryFormats
The collection of default AFDeliveryFormat objects for this notification.
Public propertyDeliveryFormats
The collection of AFDeliveryFormat objects for this notification.
Public propertyDescription
Read/write property that provides a more detailed description of the object.
Public propertyHasTarget
This read-only property indicates if there is a target associated with this AFNotificationRule.
Public propertyHasTemplate
This read-only property indicates if this notification rule is defined by an AFNotificationRuleTemplate.
Public propertyID
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 propertyIdentity
This read-only property contains identity of the object.
(Inherited from AFObject.)
Public propertyIsDeleted
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.)
Public propertyIsDirty
This read-only property indicates whether the object has been modified since the last save to the PI AF Server.
Public propertyIsNew
This read-only property indicates whether the object is new and has never been saved to the PI AF Server.
Public propertyMultiTriggerEventOption
This property specifies when a notification is sent based on severity.
Public propertyName
This property defines the name that identifies the object.
Public propertyNonrepetitionInterval
Non-repetition interval for the AFNotificationRule.
Public propertyPISystem
This read-only property allows access to the PISystem associated with this object.
(Inherited from AFObject.)
Public propertyResendInterval
The interval for resending the notification.
Public propertySecurity
This read-only property returns the AFSecurity information for the object.
Public propertyStatus
The current notification rule status.
Public propertySubscribers
The collection of AFNotificationRuleSubscriber to be receive this notification.
Public propertyTarget
Gets and sets the target of the AFNotificationRule.
Public propertyTemplate
This property returns the AFNotificationRuleTemplate that was used to create this AFNotificationRule.
Public propertyUniqueID
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.)
Top
Methods
  NameDescription
Public methodCode exampleApplyChanges
This method applies the changes to the object and makes those changes available to other objects for the current user.
Public methodCode exampleCheckIn
This method checks in (commits) all the changes to the object by saving the information to persistent storage.
Public methodCheckOut
This method locks the object so that its configuration can be modified.
Public methodStatic memberCheckOutNotificationRules
Check out the objects with the specified unique identifiers at the specified query date.
Public methodCompareTo(Object)
Compares this instance with a specified Object.
(Inherited from AFObject.)
Public methodCompareTo(AFObject)
Compares this instance with a specified AFObject.
(Inherited from AFObject.)
Public methodCreateNotificationRuleTemplate
Create an AFNotificationRuleTemplate based upon the AFNotificationRule object.
Public methodDelete
Deletes this AFNotificationRule from the AFDatabase.
Public methodStatic memberDeleteNotificationRules
Delete the objects with the specified unique identifiers.
Public methodEquals(Object)
Determines whether the specified Object is equal to the current object.
(Inherited from AFObject.)
Public methodEquals(AFObject)
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.)
Public methodStatic memberFindNotificationRule(PISystem, Guid)
Retrieves the AFNotificationRule object with the specified unique identifier at the AFTime.MaxValue query date.
Public methodStatic memberFindNotificationRule(PISystem, Guid, Object)
Retrieves the AFNotificationRule object with the specified unique identifier at the specified query date.
Public methodStatic memberFindNotificationRules
Performs a search within the PISystem to retrieve a collection of AFNotificationRule objects with the specified list of unique identifiers.
Public methodGetAllDefaultDeliveryFormats
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.
Public methodGetAllDeliveryFormats
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.
Public methodStatic memberCode exampleGetCounts(AFDatabase)
Get the number of notification rules for each status.
Public methodStatic memberCode exampleGetCountsT(AFDatabase)
Get the number of notification rules for each filter.
Public methodGetHashCode
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 methodGetPath
Returns the full path to the object, using just the names.
(Inherited from AFObject.)
Public methodGetPath(AFObject)
Returns the path to the object relative from another object.
(Inherited from AFObject.)
Public methodGetPath(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 methodGetSecurity
Gets the AFSecurity information of the specified security item associated with the object.
Public methodGetStatus
Get the Status property immediately from the PI AF Server.
Public methodStatic memberGetStatus(IListAFNotificationRule)
Get the status for the list of specified AFNotificationRule from the PI AF Server.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberLoadNotificationRules(IListAFNotificationRule)
Loads the specified list AFNotificationRule objects.
Public methodStatic memberLoadNotificationRules(PISystem, Guid, Object)
Loads the AFNotificationRule objects with the specified unique identifiers at the specified query date.
Public methodStatic memberLoadTargets
Loads the Target of the specified list of AFNotificationRule objects.
Public methodPersist
This method returns the persistence string for the object.
(Inherited from AFObject.)
Public methodRefresh
Refreshes the client with any changes that have been made to the object since loaded.
Public methodResetToTemplate
This method will reset the AFNotificationRule back to its template default values.
Public methodSetStatus(AFStatus)
Set the Status property immediately in the server.
Public methodStatic memberSetStatus(IListAFNotificationRule, AFStatus)
Set the AFNotificationRule status.
Public methodStatic memberSetStatus(AFDatabase, AFObject, AFStatus, AFStatus)
Sets all the AFNotificationRule objects based upon a filter object to the specified status.
Public methodToString
Returns a String that represents the current object.
(Inherited from AFObject.)
Public methodUndoCheckOut
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.
Top
Events
  NameDescription
Public eventCode exampleChanged
Event is raised when the object or one of its sub-objects is changed.
Top
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: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8
See Also
Enabling Operational Intelligence