This documentation is archived and is not being maintained.

IInteractiveChannelInitializer Interface

Defines the methods that enable a client application to display a user interface to collect identity information prior to creating the channel.

Namespace:  System.ServiceModel.Dispatcher
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

public interface IInteractiveChannelInitializer

The IInteractiveChannelInitializer type exposes the following members.

  NameDescription
Public methodBeginDisplayInitializationUIAn asynchronous call to begin using a user interface to obtain credential information.
Public methodEndDisplayInitializationUICalled when the BeginDisplayInitializationUI has finished.
Top

Implement the IInteractiveChannelInitializer interface to enable a client application to display a user interface that enables the user of the application to create or select the credentials prior to opening a channel.

To implement IInteractiveChannelInitializer, perform the following steps in IInteractiveChannelInitializer.BeginDisplayInitializationUI:

  1. Prompt the user and obtain an appropriate System.Net.NetworkCredential.

  2. Add a custom channel parameter object to the collection returned by the IChannel.GetProperty<T> method on the IClientChannel object with a type parameter of System.ServiceModel.Channels.ChannelParameterCollection. This channel parameter object is used by the custom System.ServiceModel.ClientCredentialsSecurityTokenManager to establish the security tokens for the channel.

  3. Return.

To insert IInteractiveChannelInitializer:

  1. Override the IEndpointBehavior.ApplyClientBehavior method on the System.ServiceModel.Description.ClientCredentials class.

  2. In that method, determine whether the endpoint requires an IInteractiveChannelInitializer and if so, add the IInteractiveChannelInitializer to the ClientRuntime.InteractiveChannelInitializers collection.

There are two ways application developers can make use of an inserted IInteractiveChannelInitializer. The client application can call either ClientBase<TChannel>.DisplayInitializationUI or IClientChannel.DisplayInitializationUI (or an asynchronous version) prior to opening the channel (the explicit approach) or simply call the first operation (the implicit approach).

If using the implicit approach, the application must call the first operation on an ClientBase<TChannel> or IClientChannel extension. If it calls anything other than the first operation, an exception is thrown.

If using the explicit approach, the application must perform the following steps in order:

  1. Call either ClientBase<TChannel>.DisplayInitializationUI or IClientChannel.DisplayInitializationUI (or an asynchronous version).

  2. When the initializers have returned, call either the Open method on the IClientChannel object or on the IClientChannel object returned from the ClientBase<TChannel>.InnerChannel property.

  3. Call operations.

It is recommended that production-quality applications control of the user-interface process by adopting the explicit approach.

Applications that use the implicit approach invoke the user-interface initializers, but if the user of the application fails to respond within the send timeout period of the binding, an exception is thrown when the user interface returns.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: