AFNotificationTemplate Methods
- Last UpdatedNov 18, 2025
- 6 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFNotificationTemplate 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.
(Inherited from AFElementTemplate.) |
| CheckIn |
This method checks in (commits) all the changes to the object by saving
the information to persistent storage.
(Inherited from AFElementTemplate.) |
| CheckOut |
This method locks the object so that its configuration can be modified.
(Inherited from AFElementTemplate.) |
| CompareTo(Object) |
Compares this instance with a specified Object.
(Inherited from AFObject.) |
| CompareTo(AFObject) |
Compares this instance with a specified AFObject.
(Inherited from AFObject.) |
| CreateDefaultPorts |
This method can be used to create the default connection ports based upon the
element's type.
(Inherited from AFElementTemplate.) |
| 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 or its template.
|
| FindDerivedTemplates |
This method returns the collection of AFElementTemplate objects that
have this template as their base template.
(Inherited from AFElementTemplate.) |
| FindInstantiatedElements(Boolean, AFSortField, AFSortOrder, Int32) |
This method returns a non-paged collection of AFBaseElement objects that were
created with this template.
(Inherited from AFElementTemplate.) |
| FindInstantiatedElements(Boolean, AFSortField, AFSortOrder, Int32, Int32, Int32) |
This method returns a paged collection of AFBaseElement objects that were
created with this template.
(Inherited from AFElementTemplate.) |
 | FindNotificationTemplate(PISystem, Guid) |
Retrieves the AFNotificationTemplate object with the specified unique identifier
at the AFTime.MaxValue query date.
|
| FindNotificationTemplate(PISystem, Guid, Object) |
Retrieves the AFNotificationTemplate object with the specified unique identifier
at the specified query date.
|
| GetAllAnalysisTemplates |
Gets the list of analysis templates for this template and all base templates.
(Inherited from AFElementTemplate.) |
| GetAllAttributeTemplates |
Gets the list of top-level attribute templates for this template and all base templates.
(Inherited from AFElementTemplate.) |
| GetAllCategories |
Gets the list of categories for this template and all base templates.
(Inherited from AFElementTemplate.) |
| GetAllCategoriesString |
Gets the list of categories for this template and all base templates.
(Inherited from AFElementTemplate.) |
| GetAllNotificationRuleTemplates |
Gets the list of AFNotificationRuleTemplate objects for this template and all base templates.
(Inherited from AFElementTemplate.) |
| GetAllPorts |
Gets the list of ports for this template and all base templates.
(Inherited from AFElementTemplate.) |
| GetAttributeTemplateByTrait |
Retrieves the child AFAttributeTemplate with the specified AFAttributeTrait.
(Inherited from AFElementTemplate.) |
| GetAttributeTemplatesByTrait |
Retrieves a list of child AFAttributeTemplate objects identified by the specified list of attribute traits.
(Inherited from AFElementTemplate.) |
| 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.
(Inherited from AFElementTemplate.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsTypeOf |
Checks if the current AFElementTemplate is derived from the
specified base element template.
(Inherited from AFElementTemplate.) |
| 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.
(Inherited from AFElementTemplate.) |
| ToString |
Returns a String that represents the current object.
(Inherited from AFObject.) |
| 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.
(Inherited from AFElementTemplate.) |