AFNotificationRule.GetAllDeliveryFormats Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Gets a read only collection of all AFDeliveryFormat that belong to this
AFNotificationRule, to the AFNotificationRuleTemplate
it was optionally created from, 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 AFNotificationRule 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: AFNamedCollectionListAFDeliveryFormatA collection of all AFDeliveryFormat that belong to this AFNotificationRule, to the AFNotificationRuleTemplate it was optionally created from, and to the PISystem.
Remarks
This method gets a collection of all AFDeliveryFormat objects that belong to this AFNotificationRule and the PISystem. If this object was created from an AFNotificationRuleTemplate, it will include all AFDeliveryFormat objects that belong to it and will not include any format on this object that was created from the template.
The output from this method may be used to create a unique name using the GenerateUniqueName(String, IAFList) method.