AFNotification Methods
- Last UpdatedNov 18, 2025
- 9 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFNotification type exposes the following members.
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.
| |
| CompareTo(Object) |
Compares this instance with a specified Object.
(Inherited from AFObject.) | |
| CompareTo(AFObject) |
Compares this instance with a specified AFObject.
(Inherited from AFObject.) | |
| CreateElementTemplate |
Create an AFElementTemplate based upon the element.
(Inherited from AFBaseElement.) | |
| Delete |
Deletes this notification from the AFDatabase.
| |
| 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.) | |
| FindContact |
Used for finding the AFNotificationContact with a given ID for
the notification contact, contact definition, or its template.
| |
| FindNotification(PISystem, Guid) |
Retrieves the AFNotification object with the specified unique identifier
at the AFTime.MaxValue query date.
| |
| FindNotification(PISystem, Guid, Object) |
Retrieves the AFNotification object with the specified unique identifier
at the specified query date.
| |
| FindNotifications(PISystem, Guid, Object) |
Performs a search within the PISystem to retrieve a collection
of AFNotification objects with the specified list of unique identifiers.
| |
| 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.
| |
| 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.
| |
| 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.
| |
| 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.
| |
| 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.
| |
| 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.
| |
| 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.
| |
| 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.
| |
| GetAnnotations |
Retrieves a collection of existing AFAnnotation objects belonging to this
AFBaseElement.
(Inherited from AFBaseElement.) | |
| GetAttributeByTrait |
Retrieves the child AFAttribute with the specified AFAttributeTrait.
(Inherited from AFBaseElement.) | |
| GetAttributesByTrait |
Retrieves a list of child AFAttribute objects identified by the specified list of attribute traits.
(Inherited from AFBaseElement.) | |
| 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 notification's Status property immediately in the PI AF Server.
| |
| GetStatus(IListAFNotification) |
Get the status for the list of notifications from the PI AF Server.
| |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| IsTraced |
Indicates if a specified level is being traced.
| |
| IsTypeOf |
Checks if the current AFBaseElement is derived from the
specified AFElementTemplate.
(Inherited from AFBaseElement.) | |
| LoadNotifications(IListAFNotification, Boolean) |
Loads the specified list of AFNotification objects.
| |
| LoadNotifications(PISystem, Guid, Object) |
Loads the AFNotification objects with the specified unique identifiers
at the specified query date.
| |
| LoadTargets |
Loads the Target of the specified list of AFNotification 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.
| |
| SetNotificationContact(String) | Obsolete.
The SetNotificationContact method sets the NotificationContact
property to a newly created AFNotificationContact with the specified name.
| |
| SetNotificationContact(AFNotificationContactTemplate) | Obsolete.
The SetNotificationContact method sets the NotificationContact
property to a newly created AFNotificationContact using the specified
AFNotificationContactTemplate.
| |
| SetNotificationContact(AFContact, String) | Obsolete.
The SetNotificationContact method sets the NotificationContact
property to a newly created AFNotificationContact using the specified
AFContact and name.
| |
| SetStatus(AFStatus, String) |
Set the notification's Status and ErrorMessage properties
immediately in the server.
| |
| SetStatus(IListAFNotification, AFStatus, String) |
Set the list of notifications to the specified status and error message.
| |
| ToString |
Returns a String that represents the current object.
(Inherited from AFObject.) | |
| TraceData |
Output a data trace event.
| |
| TraceDetail |
Output a detail trace event.
| |
| TraceError |
Output an error trace event.
| |
| TraceEvent(AFTraceSwitchLevel, String) |
Output a trace event with a message.
| |
| TraceEvent(AFTraceSwitchLevel, String, Int32) |
Output a trace event with a message and a duration.
| |
| TraceEvent(AFTraceSwitchLevel, String, Object) |
Output a trace event as a formatted message with a variable number of arguments.
| |
| TraceInformation |
Output an information trace event.
| |
| TraceSummary |
Output a summary trace event.
| |
| TraceWarning |
Output a warning trace event.
| |
| 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
Related Links
- ApplyChanges Method
- CheckIn Method
- CheckOut Method
- Delete Method
- FindContact Method
- FindNotification Method
- FindNotifications Method
- FindNotificationsByContact Method
- FindNotificationsByContactTemplate Method
- FindNotificationsByElement Method
- GetSecurity Method
- GetStatus Method
- IsTraced Method
- LoadNotifications Method
- LoadTargets Method
- Refresh Method
- SetNotificationContact Method
- SetStatus Method
- TraceData Method
- TraceDetail Method
- TraceError Method
- TraceEvent Method
- TraceInformation Method
- TraceSummary Method
- TraceWarning Method
- UndoCheckOut Method