AFDeliveryFormat Class
- Last UpdatedNov 18, 2025
- 5 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFDeliveryFormat defines the format of an AFNotificationRule.
Inheritance Hierarchy
Namespace: OSIsoft.AF.Notification
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[SerializableAttribute] public sealed class AFDeliveryFormat : AFObject, IComparable<AFDeliveryFormat>
<SerializableAttribute> Public NotInheritable Class AFDeliveryFormat Inherits AFObject Implements IComparable(Of AFDeliveryFormat) Dim instance As AFDeliveryFormat
[SerializableAttribute] public ref class AFDeliveryFormat sealed : public AFObject, IComparable<AFDeliveryFormat^>
[<SealedAttribute>] [<SerializableAttribute>] type AFDeliveryFormat = class inherit AFObject interface IComparable<AFDeliveryFormat> end
The AFDeliveryFormat type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | Database |
This read-only property returns the AFDatabase where this object is defined.
|
| DeliveryChannelPlugIn |
The delivery channel plug in property is used to specify which
delivery channel will be used to deliver the AFNotificationRule.
|
| ID |
Read-only property that provides a unique identifier for the object to be used for
quick access that is not dependent upon the index.
(Inherited from AFObject.) |
| Identity |
This read-only property contains identity of the object.
(Inherited from AFObject.) |
| IsDefinedByDeliveryChannel |
Determines whether this AFDeliveryFormat can be changed.
|
| IsDefinedByTemplate |
Indicates whether the current delivery format was created from an DeliveryFormats
collection.
|
| IsDeleted |
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.) |
| Name |
Read/write property that identifies the name of the object.
|
| Owner |
The AFObject that owns the AFDeliveryFormats collection
to which this object belongs.
|
| PISystem |
This read-only property allows access to the PISystem associated with this
object.
(Inherited from AFObject.) |
| Properties |
A collection of properties belonging to the AFDeliveryFormat.
|
| UniqueID |
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.) |
Methods
| Name | Description | |
|---|---|---|
 | CompareTo(Object) |
Compares this instance with a specified Object.
(Inherited from AFObject.) |
| CompareTo(AFObject) |
Compares this instance with a specified AFObject.
(Inherited from AFObject.) |
| 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.) |
| 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.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Persist |
This method returns the persistence string for the object.
(Inherited from AFObject.) |
| ToString |
Returns a String that represents the current object.
(Inherited from AFObject.) |
Remarks
The delivery format defines the format of an AFNotificationRule. If an AFNotificationRule is created from an AFNotificationRuleTemplate, then the notification's formats can be defined by notification template's DeliveryFormats collection.