AFDefaultDeliveryFormats Class
- Last UpdatedNov 18, 2025
- 7 minute read
- PI System
- AF SDK 2024 R2
- Developer
A collection of default AFDeliveryFormat objects. This may be a collection
maintained by an AFNotificationRuleTemplate or an AFNotificationRule.
Inheritance Hierarchy
SystemObject
OSIsoft.AF.NotificationAFDefaultDeliveryFormats
OSIsoft.AF.NotificationAFDefaultDeliveryFormats
Namespace: OSIsoft.AF.Notification
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFDefaultDeliveryFormats : IList<AFDeliveryFormat>, ICollection<AFDeliveryFormat>, IEnumerable<AFDeliveryFormat>, IEnumerable, IAFList, IList, ICollection
Public NotInheritable Class AFDefaultDeliveryFormats Implements IList(Of AFDeliveryFormat), ICollection(Of AFDeliveryFormat), IEnumerable(Of AFDeliveryFormat), IEnumerable, IAFList, IList, ICollection Dim instance As AFDefaultDeliveryFormats
public ref class AFDefaultDeliveryFormats sealed : IList<AFDeliveryFormat^>, ICollection<AFDeliveryFormat^>, IEnumerable<AFDeliveryFormat^>, IEnumerable, IAFList, IList, ICollection
[<SealedAttribute>] type AFDefaultDeliveryFormats = class interface IList<AFDeliveryFormat> interface ICollection<AFDeliveryFormat> interface IEnumerable<AFDeliveryFormat> interface IEnumerable interface IAFList interface IList interface ICollection end
The AFDefaultDeliveryFormats type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | Count |
Gets the number of items actually contained in the collection.
|
| ItemGuid | Returns the item in the collection associated with the passed in ID. |
| ItemInt32 | Returns the item located at the passed in index. |
| ItemString | Returns the item in the collection associated with the passed in name. |
| ItemAFPlugIn |
Gets the AFDeliveryFormat for the specified AFPlugIn.
|
Methods
| Name | Description | |
|---|---|---|
 | Add |
Adds an object to the end of the collection.
|
| Clear |
Removes all items from the collection.
|
| Contains(Guid) |
This method determines whether the collection contains a specific item referenced by id.
|
| Contains(String) |
This method determines whether the collection contains a specific item referenced by name.
|
| Contains(AFDeliveryFormat) |
This method determines whether the collection contains a specific item.
|
| CopyTo |
Copies the entire collection to a compatible one-dimensional Array,
starting at the specified index of the target array.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetEnumerator |
Returns an enumerator that iterates through the collection.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IndexOf |
Searches for the specified object and returns the zero-based index of the first
occurrence within the entire collection.
|
| Insert |
Inserts an item into the collection at the specified index.
|
| Remove(AFDeliveryFormat) |
Removes the first occurrence of a specific object from the collection.
|
| Remove(AFPlugIn) |
Removes the AFDeliveryFormat for the specified AFPlugIn |
| RemoveAt |
Removes the item at the specified index of the collection.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods
| Name | Description | |
|---|---|---|
 | AggregateAFDeliveryFormat |
Performs all requested aggregates on the specified items.
(Defined by AFAggregate.) |
| AggregateAsyncAFDeliveryFormat |
Performs all requested aggregates on the specified items asynchronously.
(Defined by AFAggregate.) |
| BinnedSummaryAFDeliveryFormat, TBin |
Generates a summary broken down by the specified bins for items matching the search criteria.
(Defined by AFAggregate.) |
| BinnedSummaryAsyncAFDeliveryFormat, TBin |
Generates a summary broken down by the specified bins for items matching the search criteria asynchronously.
(Defined by AFAggregate.) |
 | ChunkedByAFDeliveryFormat |
This extension method breaks up search results into chunks to make it easier to
page through and process IEnumerableT collections in chunks.
(Defined by AFSDKExtension.) |
| FrequencyDistributionAFDeliveryFormat |
Generates a frequency distribution for the specified items.
(Defined by AFAggregate.) |
| FrequencyDistributionAsyncAFDeliveryFormat |
Generates a frequency distribution for the specified items asynchronously.
(Defined by AFAggregate.) |
| GroupedSummaryAFDeliveryFormat |
Generates a summary broken down by group for the specified items.
(Defined by AFAggregate.) |
| GroupedSummaryAsyncAFDeliveryFormat |
Generates a histogram for the specified items asynchronously.
(Defined by AFAggregate.) |
| HistogramAFDeliveryFormat, TBin |
Generates a histogram for the specified items with the specified weighting.
(Defined by AFAggregate.) |
| HistogramAsyncAFDeliveryFormat, TBin |
Generates a histogram for the specified items with the specified weighting asynchronously.
(Defined by AFAggregate.) |
| SummaryAFDeliveryFormat(String, AFSummaryTypes) | Overloaded.
Summarizes the specified items.
(Defined by AFAggregate.) |
| SummaryAFDeliveryFormat(String, AFSummaryTypes, String) | Overloaded.
Summarizes the specified items with the specified weighting.
(Defined by AFAggregate.) |
| SummaryAsyncAFDeliveryFormat(String, AFSummaryTypes, CancellationToken) | Overloaded.
Summarizes the specified items asynchronously.
(Defined by AFAggregate.) |
| SummaryAsyncAFDeliveryFormat(String, AFSummaryTypes, String, CancellationToken) | Overloaded.
Summarizes the specified items with the specified weighting asynchronously.
(Defined by AFAggregate.) |
Remarks
This is a collection of default AFDeliveryFormat objects for an AFNotificationRule or AFNotificationRuleTemplate. If a AFDeliveryFormat is set in this collection for an AFPlugIn, the GetDeliveryFormat Overload method will return the AFDeliveryFormat object in this collection, unless overridden by the subscriber.