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

AF SDK Reference

AFNotification Methods

  • Last UpdatedNov 18, 2025
  • 9 minute read
AFNotification Methods

The AFNotification 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 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
CreateElementTemplate
Create an AFElementTemplate based upon the element.
(Inherited from AFBaseElement.)
Public method
Delete
Deletes this notification from the AFDatabase.
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 method
FindContact
Used for finding the AFNotificationContact with a given ID for the notification contact, contact definition, or its template.
Public methodStatic member
FindNotification(PISystem, Guid)
Retrieves the AFNotification object with the specified unique identifier at the AFTime.MaxValue query date.
Public methodStatic member
FindNotification(PISystem, Guid, Object)
Retrieves the AFNotification object with the specified unique identifier at the specified query date.
Public methodStatic memberCode example
FindNotifications(PISystem, Guid, Object)
Performs a search within the PISystem to retrieve a collection of AFNotification objects with the specified list of unique identifiers.
Public methodStatic memberCode example
FindNotifications(AFDatabase, String, AFSearchField, AFSortField, AFSortOrder, Int32)
Performs a non-paged text search within the AFDatabase to retrieve a collection of AFNotification objects which have a field that matches the specified query string.
Public methodStatic memberCode example
FindNotifications(AFDatabase, String, AFCategory, AFElementTemplate, AFSortField, AFSortOrder, Int32)
Performs a non-paged search within the AFDatabase to retrieve a collection of AFNotification objects that match the specified query string and additional filters.
Public methodStatic memberCode example
FindNotifications(AFDatabase, String, AFSearchField, AFSortField, AFSortOrder, Int32, Int32, Int32)
Performs a paged text search within the AFDatabase to retrieve a collection of AFNotification objects which have a field that match the specified query string.
Public methodStatic memberCode example
FindNotifications(AFDatabase, String, String, AFCategory, AFElementTemplate, AFElement, AFContact, AFStatus, AFSortField, AFSortOrder, Int32)
Performs a non-paged search within the AFDatabase to retrieve a collection of AFNotification objects that match the specified query strings and additional filters.
Public methodStatic memberCode example
FindNotifications(AFDatabase, String, String, AFCategory, AFElementTemplate, AFElement, AFContact, AFStatus, AFSortField, AFSortOrder, Int32, Int32)
Performs a paged search within the AFDatabase to retrieve a collection of AFNotification objects that match the specified query strings and additional filters.
Public methodStatic member
FindNotificationsByContact
Performs a non-paged search to retrieve a collection of all the AFNotification objects that have the specified AFContact configured to receive the notification.
Public methodStatic member
FindNotificationsByContactTemplate
Performs a non-paged search to retrieve a collection of all the AFNotification objects that have the specified AFNotificationContactTemplate configured to receive the notification.
Public methodStatic member
FindNotificationsByElement
Performs a non-paged search to retrieve a collection of all the AFNotification objects that have the specified AFElement as a target of its analysis.
Public method
GetAnnotations
Retrieves a collection of existing AFAnnotation objects belonging to this AFBaseElement.
(Inherited from AFBaseElement.)
Public method
GetAttributeByTrait
Retrieves the child AFAttribute with the specified AFAttributeTrait.
(Inherited from AFBaseElement.)
Public method
GetAttributesByTrait
Retrieves a list of child AFAttribute objects identified by the specified list of attribute traits.
(Inherited from AFBaseElement.)
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 notification's Status property immediately in the PI AF Server.
Public methodStatic member
GetStatus(IListAFNotification)
Get the status for the list of notifications from the PI AF Server.
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
IsTraced
Indicates if a specified level is being traced.
Public method
IsTypeOf
Checks if the current AFBaseElement is derived from the specified AFElementTemplate.
(Inherited from AFBaseElement.)
Public methodStatic memberCode example
LoadNotifications(IListAFNotification, Boolean)
Loads the specified list of AFNotification objects.
Public methodStatic memberCode example
LoadNotifications(PISystem, Guid, Object)
Loads the AFNotification objects with the specified unique identifiers at the specified query date.
Public methodStatic memberCode example
LoadTargets
Loads the Target of the specified list of AFNotification 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
SetNotificationContact(String) Obsolete.
The SetNotificationContact method sets the NotificationContact property to a newly created AFNotificationContact with the specified name.
Public method
SetNotificationContact(AFNotificationContactTemplate) Obsolete.
The SetNotificationContact method sets the NotificationContact property to a newly created AFNotificationContact using the specified AFNotificationContactTemplate.
Public method
SetNotificationContact(AFContact, String) Obsolete.
The SetNotificationContact method sets the NotificationContact property to a newly created AFNotificationContact using the specified AFContact and name.
Public method
SetStatus(AFStatus, String)
Set the notification's Status and ErrorMessage properties immediately in the server.
Public methodStatic member
SetStatus(IListAFNotification, AFStatus, String)
Set the list of notifications to the specified status and error message.
Public method
ToString
Returns a String that represents the current object.
(Inherited from AFObject.)
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.
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

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