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

AFNotificationRule Methods

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedNov 18, 2025
  • 6 minute read
AFNotificationRule Methods

The AFNotificationRule type exposes the following members.

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
CheckOutNotificationRules
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
CreateNotificationRuleTemplate
Create an AFNotificationRuleTemplate based upon the AFNotificationRule object.
Public method
Delete
Deletes this AFNotificationRule from the AFDatabase.
Public methodStatic member
DeleteNotificationRules
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
FindNotificationRule(PISystem, Guid)
Retrieves the AFNotificationRule object with the specified unique identifier at the AFTime.MaxValue query date.
Public methodStatic member
FindNotificationRule(PISystem, Guid, Object)
Retrieves the AFNotificationRule object with the specified unique identifier at the specified query date.
Public methodStatic member
FindNotificationRules
Performs a search within the PISystem to retrieve a collection of AFNotificationRule objects with the specified list of unique identifiers.
Public method
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.
Public method
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.
Public methodStatic memberCode example
GetCounts(AFDatabase)
Get the number of notification rules for each status.
Public methodStatic memberCode example
GetCountsT(AFDatabase)
Get the number of notification rules for each filter.
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
GetStatus
Get the Status property immediately from the PI AF Server.
Public methodStatic member
GetStatus(IListAFNotificationRule)
Get the status for the list of specified AFNotificationRule from the PI AF Server.
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic member
LoadNotificationRules(IListAFNotificationRule)
Loads the specified list AFNotificationRule objects.
Public methodStatic member
LoadNotificationRules(PISystem, Guid, Object)
Loads the AFNotificationRule objects with the specified unique identifiers at the specified query date.
Public methodStatic member
LoadTargets
Loads the Target of the specified list of AFNotificationRule objects.
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
ResetToTemplate
This method will reset the AFNotificationRule back to its template default values.
Public method
SetStatus(AFStatus)
Set the Status property immediately in the server.
Public methodStatic member
SetStatus(IListAFNotificationRule, AFStatus)
Set the AFNotificationRule status.
Public methodStatic member
SetStatus(AFDatabase, AFObject, AFStatus, AFStatus)
Sets all the AFNotificationRule objects based upon a filter object to the specified status.
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.

See Also

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