WebAuthenticationService Class

Article
01/27/2012

[WCF RIA Services Version 1 Service Pack 2 is compatible with either .NET framework 4 or .NET Framework 4.5, and with either Silverlight 4 or Silverlight 5.]

Provides an abstract extension of the AuthenticationService that interacts with a DomainContext generated from a domain service implementing IAuthentication<T>.

Inheritance Hierarchy

System.Object
  System.ServiceModel.DomainServices.Client.ApplicationServices.AuthenticationService
    System.ServiceModel.DomainServices.Client.ApplicationServices.WebAuthenticationService
      System.ServiceModel.DomainServices.Client.ApplicationServices.FormsAuthentication
      System.ServiceModel.DomainServices.Client.ApplicationServices.WindowsAuthentication

Namespace: System.ServiceModel.DomainServices.Client.ApplicationServices
Assembly: System.ServiceModel.DomainServices.Client.Web (in System.ServiceModel.DomainServices.Client.Web.dll)

Syntax

'Declaration
Public MustInherit Class WebAuthenticationService _
    Inherits AuthenticationService

'Usage
Dim instance As WebAuthenticationService

public abstract class WebAuthenticationService : AuthenticationService

public ref class WebAuthenticationService abstract : public AuthenticationService

[<AbstractClassAttribute>]
type WebAuthenticationService =  
    class
        inherit AuthenticationService
    end

public abstract class WebAuthenticationService extends AuthenticationService

The WebAuthenticationService type exposes the following members.

Properties

	Name	Description
	DomainContext	Gets or sets the domain context this service delegates authenticating, loading, and saving to.
	DomainContextType	Gets or sets the type of the domain context.
	IsBusy	Gets a value indicating whether an asynchronous operation is in progress. (Inherited from AuthenticationService.)
	IsLoadingUser	Gets a value indicating whether an asynchronous LoadUser operation is in progress. (Inherited from AuthenticationService.)
	IsLoggingIn	Gets a value indicating whether an asynchronous Login operation is in progress. (Inherited from AuthenticationService.)
	IsLoggingOut	Gets a value indicating whether an asynchronous Logout operation is in progress. (Inherited from AuthenticationService.)
	IsSavingUser	Gets a value indicating whether an asynchronous SaveUser operation is in progress. (Inherited from AuthenticationService.)
	SupportsCancellation	Gets a value that indicates whether this service supports cancellation. (Overrides AuthenticationService.SupportsCancellation.)
	User	Gets a principal representing the authenticated user. (Inherited from AuthenticationService.)

Top

Methods

	Name	Description
	BeginLoadUser	Begins an asynchronous LoadUser operation. (Overrides AuthenticationService.BeginLoadUser(AsyncCallback, Object).)
	BeginLogin	Begins an asynchronous Login operation. (Overrides AuthenticationService.BeginLogin(LoginParameters, AsyncCallback, Object).)
	BeginLogout	Begins an asynchronous Logout operation. (Overrides AuthenticationService.BeginLogout(AsyncCallback, Object).)
	BeginSaveUser	Begins an asynchronous SaveUser operation. (Overrides AuthenticationService.BeginSaveUser(IPrincipal, AsyncCallback, Object).)
	CancelLoadUser	Cancels an asynchronous LoadUser operation. (Overrides AuthenticationService.CancelLoadUser(IAsyncResult).)
	CancelLogin	Cancels an asynchronous Login operation. (Overrides AuthenticationService.CancelLogin(IAsyncResult).)
	CancelLogout	Cancels an asynchronous Logout operation. (Overrides AuthenticationService.CancelLogout(IAsyncResult).)
	CancelSaveUser	Cancels an asynchronous SaveUser operation. (Overrides AuthenticationService.CancelSaveUser(IAsyncResult).)
	CreateDefaultUser	Creates a default user. (Overrides AuthenticationService.CreateDefaultUser().)
	EndLoadUser	Ends an asynchronous LoadUser operation. (Overrides AuthenticationService.EndLoadUser(IAsyncResult).)
	EndLogin	Ends an asynchronous Login operation. (Overrides AuthenticationService.EndLogin(IAsyncResult).)
	EndLogout	Ends an asynchronous Logout operation. (Overrides AuthenticationService.EndLogout(IAsyncResult).)
	EndSaveUser	Ends an asynchronous SaveUser operation. (Overrides AuthenticationService.EndSaveUser(IAsyncResult).)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Initialize	Initializes this authentication service.
	LoadUser()	Asynchronously loads the authenticated user from the server. (Inherited from AuthenticationService.)
	LoadUser(Action<LoadUserOperation>, Object)	Asynchronously loads the authenticated user from the server with specified callback method and user state. (Inherited from AuthenticationService.)
	Login(LoginParameters)	Asynchronously authenticates and logs in to the server with the specified parameters. (Inherited from AuthenticationService.)
	Login(String, String)	Asynchronously authenticates and logs in to the server with the specified user name and password. (Inherited from AuthenticationService.)
	Login(LoginParameters, Action<LoginOperation>, Object)	Asynchronously authenticates and logs in to the server with the specified parameters, callback method, and user state. (Inherited from AuthenticationService.)
	Logout(Boolean)	Asynchronously logs out an authenticated user from the server with the specified value indicating whether an exception is thrown for errors. (Inherited from AuthenticationService.)
	Logout(Action<LogoutOperation>, Object)	Asynchronously logs out an authenticated user from the server with the specified callback method and user state. (Inherited from AuthenticationService.)
	MemberwiseClone	(Inherited from Object.)
	OnPropertyChanged	Raises a PropertyChanged event. (Inherited from AuthenticationService.)
	RaisePropertyChanged	Raises a PropertyChanged event for the specified property. (Inherited from AuthenticationService.)
	SaveUser(Boolean)	Asynchronously saves the authenticated user to the server with the specified value indicating whether an exception is thrown for errors. (Inherited from AuthenticationService.)
	SaveUser(Action<SaveUserOperation>, Object)	Asynchronously saves the authenticated user to the server with the specified callback method and user state. (Inherited from AuthenticationService.)
	ToString	(Inherited from Object.)

Top

Events

	Name	Description
	LoggedIn	Occurs when a new user is successfully logged in. (Inherited from AuthenticationService.)
	LoggedOut	Occurs when a user is successfully logged out. (Inherited from AuthenticationService.)

Top

Explicit Interface Implementations

	Name	Description
	INotifyPropertyChanged.PropertyChanged	Occurs every time a property value changes. (Inherited from AuthenticationService.)

Top

Thread Safety

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

Share via