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

AF SDK Reference

AFNotificationRuleTemplate.GetAllDeliveryFormats Method

AFNotificationRuleTemplate.GetAllDeliveryFormats Method

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFNotificationRuleTemplate.GetAllDeliveryFormats Method
Gets a read only collection of all AFDeliveryFormat that belong to this AFNotificationRuleTemplate and to the PISystem.

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

Syntax

public AFNamedCollectionList<AFDeliveryFormat> GetAllDeliveryFormats(
	AFPlugIn deliveryChannelPlugIn = null
)
Public Function GetAllDeliveryFormats ( 
	Optional deliveryChannelPlugIn As AFPlugIn = Nothing
) As AFNamedCollectionList(Of AFDeliveryFormat)

Dim instance As AFNotificationRuleTemplate
Dim deliveryChannelPlugIn As AFPlugIn
Dim returnValue As AFNamedCollectionList(Of AFDeliveryFormat)

returnValue = instance.GetAllDeliveryFormats(deliveryChannelPlugIn)
public:
AFNamedCollectionList<AFDeliveryFormat^>^ GetAllDeliveryFormats(
	AFPlugIn^ deliveryChannelPlugIn = nullptr
)
member GetAllDeliveryFormats : 
        ?deliveryChannelPlugIn : AFPlugIn 
(* Defaults:
        let _deliveryChannelPlugIn = defaultArg deliveryChannelPlugIn null
*)
-> AFNamedCollectionList<AFDeliveryFormat> 

Parameters

deliveryChannelPlugIn (Optional)
Type: OSIsoft.AFAFPlugIn
Optionally filter results to only the specified delivery channel plug in.

Return Value

Type: AFNamedCollectionListAFDeliveryFormat
A collection of all AFDeliveryFormat that belong to this AFNotificationRuleTemplate and to the PISystem.

Remarks

This method gets a collection of all AFDeliveryFormat objects that belong to this AFNotificationRuleTemplate and the PISystem. It will not include any AFDeliveryFormat objects that belong to any AFNotificationRule that was created from this template.

The output from this method may be used to create a unique name using the GenerateUniqueName(String, IAFList) method.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8

See Also

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