Instance.DeliveryChannels Property

  • Article

Gets the collection of delivery channels for the Notification Services instance.

Namespace: Microsoft.SqlServer.Management.Nmo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public ReadOnly Property DeliveryChannels As DeliveryChannelCollection

public DeliveryChannelCollection DeliveryChannels { get; }

public:
property DeliveryChannelCollection^ DeliveryChannels {
    DeliveryChannelCollection^ get ();
}

/** @property */
public DeliveryChannelCollection get_DeliveryChannels ()

public function get DeliveryChannels () : DeliveryChannelCollection

Property Value

The DeliveryChannelCollection for the Instance.

Remarks

A delivery channel represents a specific delivery endpoint, such as an Simple Mail Transfer Protocol (SMTP) server. Each delivery channel is based on a delivery protocol, either standard or custom, and defines an instance of the use of a delivery protocol to deliver notifications.

Delivery channels are associated with subscriptions by using a subscriber device. For example, when a subscriber selects to receive notifications on a cell phone, the cell phone subscriber device has an associated delivery channel that is configured to use the short message service (SMS) delivery protocol.

You must have at least one delivery channel for each delivery protocol your applications use to deliver notifications. This includes the standard SMTP and File delivery protocols and any custom protocols.

Example

The following examples show how to define a standard delivery channel for an instance of Notification Services and then add the delivery channel to the instance using this property:

// Define a delivery channel that uses the built-in File protocol
DeliveryChannel fileChannel = 
    new DeliveryChannel(myInstance, "FileChannel");
fileChannel.ProtocolName = "File";

// Define and add arguments for the file delivery channel
DeliveryChannelArgument fileNameArg = 
    new DeliveryChannelArgument(fileChannel, "FileName");
fileNameArg.Value = sampleDirectory + 
    @"\Notifications\FileNotifications.txt";
fileChannel.DeliveryChannelArguments.Add(fileNameArg);

// Add the file delivery channel to the instance
myInstance.DeliveryChannels.Add(fileChannel);

' Define a delivery channel using the built-in File protocol
Dim fileChannel As DeliveryChannel = _
    New DeliveryChannel(myInstance, "FileChannel")
fileChannel.ProtocolName = "File"

' Define and add arguments for the file delivery channel
Dim fileNameArg As DeliveryChannelArgument = _
    New DeliveryChannelArgument(fileChannel, "FileName")
fileNameArg.Value = sampleDirectory + _
    "\Notifications\FileNotifications.txt"
fileChannel.DeliveryChannelArguments.Add(fileNameArg)

' Add the file delivery channel to the instance
myInstance.DeliveryChannels.Add(fileChannel)

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

Instance Class
Instance Members
Microsoft.SqlServer.Management.Nmo Namespace

Other Resources

Configuring Instances of Notification Services
DeliveryChannels Element (ICF)