AFDeliveryChannel Class
- Last UpdatedNov 18, 2025
- 7 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFDeliveryChannel defines the information needed for an
notification to receive events.
Inheritance Hierarchy
Namespace: OSIsoft.AF.Notification
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[SerializableAttribute] public abstract class AFDeliveryChannel : AFObject, IComparable<AFDeliveryChannel>, IAFTrace
<SerializableAttribute> Public MustInherit Class AFDeliveryChannel Inherits AFObject Implements IComparable(Of AFDeliveryChannel), IAFTrace Dim instance As AFDeliveryChannel
[SerializableAttribute] public ref class AFDeliveryChannel abstract : public AFObject, IComparable<AFDeliveryChannel^>, IAFTrace
[<AbstractClassAttribute>] [<SerializableAttribute>] type AFDeliveryChannel = class inherit AFObject interface IComparable<AFDeliveryChannel> interface IAFTrace end
The AFDeliveryChannel type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | AvailableForSend |
Read-only Boolean indicating if the delivery channel is available for sending.
/// |
| CanBeAcknowledged |
Read-only Boolean describing if this channel can be used for acknowledgment.
|
| ConfigString |
The current configuration of the Delivery Channel as a string suitable
for displaying to an end-user and/or setting its configuration.
|
| ConfigStringStored |
Returns the currently stored configuration string.
|
| ContentEditorType |
The Type of the content editor that is used to configure this
delivery channel.
|
| Database |
This read-only property returns the AFDatabase where this object is defined.
|
| Description |
Read-only property that provides more detailed description of the object.
|
| EditorType |
The Type of the editor that is used to configure this
delivery channel.
|
| 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.) |
| IsConfigured |
Read-only Boolean indicating if the deliver channel instance is properly configured.
|
| IsDeleted |
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.) |
| IsInitializing |
Indicates that the AFDeliveryChannel is in the process
of being initialized.
|
| Name |
Read-only property that identifies the name of the object.
|
| Notification |
This read-only property returns the AFNotification that owns this object.
|
| NotificationContact |
This read-only property returns the notification contact that owns this object.
|
| NotificationRule |
This read-only property returns the AFNotificationRule that owns this object.
|
| NotificationRuleSubscriber |
This read-only property returns the AFNotificationRuleSubscriber that owns this object.
|
| NotificationRuleTemplate |
This read-only property returns the AFNotificationRuleTemplate that owns this object.
|
| NotificationTemplate |
This read-only property returns the AFNotificationTemplate that owns this object.
|
| PISystem |
This read-only property allows access to the PISystem associated with this
object.
(Inherited from AFObject.) |
| PlugIn |
This read-only property returns the AFPlugIn used to create
this instance of the plugin.
|
| Template |
This read-only property returns the AFNotificationContactTemplate that owns this object.
|
| 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.) |
| IsTraced |
Indicates if a specified level is being traced.
|
| Persist |
This method returns the persistence string for the object.
(Inherited from AFObject.) |
| Send |
Sends the notification results to the contact. This method must be overridden.
|
| Test |
Tests if a message can be sent to a contact via this delivery channel. This method should be overridden.
|
| ToString |
Returns a String that represents the current object.
(Overrides AFObjectToString.) |
| TraceData |
Output a data trace event.
|
| TraceDetail |
Output a detail trace event.
|
| TraceError |
Output an error trace event.
|
| TraceEvent(AFTraceSwitchLevel, String) |
Output a trace event with a message.
|
| TraceEvent(AFTraceSwitchLevel, String, Int32) |
Output a trace event with a message and a duration.
|
| TraceEvent(AFTraceSwitchLevel, String, Object) |
Output a trace event as a formatted message with a variable number of arguments.
|
| TraceInformation |
Output an information trace event.
|
| TraceSummary |
Output a summary trace event.
|
| TraceWarning |
Output a warning trace event.
|
Remarks
Event Providers are defined and implemented by AFPlugIns
which inherit from this abstract class.