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

AF SDK Reference

AFNotification.FindNotificationsByContactTemplate Method

AFNotification.FindNotificationsByContactTemplate Method

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFNotification.FindNotificationsByContactTemplate Method
Performs a non-paged search to retrieve a collection of all the AFNotification objects that have the specified AFNotificationContactTemplate configured to receive the notification.

Namespace:  OSIsoft.AF.Notification
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public static AFNamedCollectionList<AFNotification> FindNotificationsByContactTemplate(
	AFNotificationContactTemplate target,
	AFSortField sortField,
	AFSortOrder sortOrder,
	int maxCount
)
Public Shared Function FindNotificationsByContactTemplate ( 
	target As AFNotificationContactTemplate,
	sortField As AFSortField,
	sortOrder As AFSortOrder,
	maxCount As Integer
) As AFNamedCollectionList(Of AFNotification)

Dim target As AFNotificationContactTemplate
Dim sortField As AFSortField
Dim sortOrder As AFSortOrder
Dim maxCount As Integer
Dim returnValue As AFNamedCollectionList(Of AFNotification)

returnValue = AFNotification.FindNotificationsByContactTemplate(target, 
	sortField, sortOrder, maxCount)
public:
static AFNamedCollectionList<AFNotification^>^ FindNotificationsByContactTemplate(
	AFNotificationContactTemplate^ target, 
	AFSortField sortField, 
	AFSortOrder sortOrder, 
	int maxCount
)
static member FindNotificationsByContactTemplate : 
        target : AFNotificationContactTemplate * 
        sortField : AFSortField * 
        sortOrder : AFSortOrder * 
        maxCount : int -> AFNamedCollectionList<AFNotification> 

Parameters

target
Type: OSIsoft.AF.NotificationAFNotificationContactTemplate
The AFNotificationContactTemplate that is to receive the desired AFNotification objects.
sortField
Type: OSIsoft.AFAFSortField
The field or property of the object used to sort the returned collection.
sortOrder
Type: OSIsoft.AFAFSortOrder
The order that the returned collection is sorted.
maxCount
Type: SystemInt32
The maximum number of objects to be returned.

Return Value

Type: AFNamedCollectionListAFNotification
Returns a collection containing the first page of AFNotification objects which have the specified target.

Remarks

An AFNotification is returned in the collection if the specified AFNotificationContactTemplate is configured to receive the notification.

Version Information

AFSDK


See Also

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