DeliveryChannel Class

The DeliveryChannel class defines a delivery channel for an alert and alert notifications.

System.Object

Microsoft.SharePoint.Portal.Alerts.Extension

  **Microsoft.SharePoint.Portal.Alerts.DeliveryChannel**

Public Constructors

The following table shows the constructors of the DeliveryChannel class and a brief description of each.

Name Description
DeliveryChannel Protected default constructor of the DeliveryChannel class.

Public Methods

The following table shows the methods of the DeliveryChannel class and a brief description of each.

Name Description
GetControl Override to add custom server controls to the user interface (UI) for your delivery channel implementation.
GetSettings Override to get a DeliveryChannelSettings object that represents the settings for your delivery channel implementation.
Send(Microsoft.SharePoint.Portal.Alerts.NotificationSite, System.Xml.XmlDocument, String) Override to send notifications to the notification queue for a portal site.

Public Properties

The following table shows the properties of the DeliveryChannel class, the data type of each property, and a brief description of each.

Name Data type Description
ChannelId String Override to get a unique identifier for your delivery channel implementation.
DisplayName String Override to get a display name for your delivery channel implementation. This display name appears on the My Alerts page.
ExtensionId String Gets an extension identifier for your delivery channel implementation. The default implementation returns the ChannelId for the delivery channel.
SortKey String Override to get a sort key for your delivery channel implementation. The sort key determines the order in which alerts for this delivery channel appear in the UI.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread safe.

Remarks

Derive from this class to implement a new delivery channel for Microsoft Office SharePoint Portal Server 2003 alerts. Existing delivery channels include portal site and e-mail channels. Alerts that are sent to the portal site are displayed in the "My Alerts Summary" Web Part.

The following table shows exceptions you should throw in your delivery channel implementation, and the condition for the exception.

Exception Type Condition
ChannelOfflineException Thrown by the Send method when an error is encountered with the SMTP server.
CorruptedMessageException Thrown by the Send method when an error is encountered with a specific e-mail message.

The assembly that contains your delivery channel implementation must be strongly named and registered in the GAC.

Requirements

Namespace: Microsoft.SharePoint.Portal.Alerts

Platforms: Microsoft Windows Server 2003

Assembly: Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)

Security: Code Access Security