ExtremeSwank OpenID
OpenIdDesktopClient Class
NamespacesExtremeSwank.OpenIdOpenIdDesktopClient
Provides OpenID client support for desktop applications.
Declaration Syntax
C#Visual BasicVisual C++
public class OpenIdDesktopClient : IDisposable
Public Class OpenIdDesktopClient _
	Implements IDisposable
public ref class OpenIdDesktopClient : IDisposable
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
OpenIdDesktopClient(String, Int32, String, Int32)
Create a new instance of OpenIdDesktopClient.

OpenIdDesktopClient(String, Int32, String)
Create a new instance of OpenIdDesktopClient.

OpenIdDesktopClient(String, Int32)
Create a new instance of OpenIdDesktopClient.

OpenIdDesktopClient(String, Int32, String, Int32, Int32)
Create a new instance of OpenIdDesktopClient.

AuthenticationCanceled
Authentication was cancelled at the OpenID Provider.

AuthenticationFailed
Authentication failed.

AuthenticationResponseReceived
Authentication response has been received.

AuthenticationResponseTimedOut
Authentication response has timed out.

AuthenticationSuccessful
Authentication was successful.

BeginAuthentication()()()
Start listening for an authentication response, and return the redirect URL that the web browser will be pointed to.

CancelAuthentication()()()
Stop listening for the authentication response.

Consumer
The OpenIdClient object used for processing.

Dispose()()()
Dispose all resources.

Dispose(Boolean)
Dispose all resources.

EnableDirectedIdentity(Uri)
Enable Directed Identity mode for a specific OpenID Provider.

EnableStatefulMode(IAssociationPersistence, ISessionPersistence)
Enable Stateful authentication using supplied persistence objects.

EnableStatefulMode()()()
Enable Stateful authentication using default (volatile) persistence objects.

Equals(Object) (Inherited from Object.)
Error
Current error status.

Finalize()()() (Inherited from Object.)
GetHashCode()()() (Inherited from Object.)
GetType()()() (Inherited from Object.)
MemberwiseClone()()() (Inherited from Object.)
RetrieveAuthenticationResponse()()()
Wait until an authentication response has been received, and return the result.

ToString()()() (Inherited from Object.)
Remarks

The user's web browser will need to be launched to perform authentication. All data will be passed back to the application through an embedded web server that will only start as needed to receive the authentication response.

Use BeginAuthentication() to asynchronously start the temporary HTTP server and return the redirect URL. This URL should be passed to the client host and launched in its web browser. Use GetAuthenticationResponse() to wait for the authentication response, or subscribe to the available events if blocking is not desired.

In either case, the HTTP server will be closed if the timeout has expired.

Inheritance Hierarchy
Object
OpenIdDesktopClient

Assembly: ExtremeSwank.OpenId (Module: ExtremeSwank.OpenId) Version: 4.0.0.1 (4.0.0.1)