WebAuthenticationService Class

  • Article

[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
Public property DomainContext Gets or sets the domain context this service delegates authenticating, loading, and saving to.
Public property DomainContextType Gets or sets the type of the domain context.
Public property IsBusy Gets a value indicating whether an asynchronous operation is in progress. (Inherited from AuthenticationService.)
Public property IsLoadingUser Gets a value indicating whether an asynchronous LoadUser operation is in progress. (Inherited from AuthenticationService.)
Public property IsLoggingIn Gets a value indicating whether an asynchronous Login operation is in progress. (Inherited from AuthenticationService.)
Public property IsLoggingOut Gets a value indicating whether an asynchronous Logout operation is in progress. (Inherited from AuthenticationService.)
Public property IsSavingUser Gets a value indicating whether an asynchronous SaveUser operation is in progress. (Inherited from AuthenticationService.)
Protected property SupportsCancellation Gets a value that indicates whether this service supports cancellation. (Overrides AuthenticationService.SupportsCancellation.)
Public property User Gets a principal representing the authenticated user. (Inherited from AuthenticationService.)

Top

Methods

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

Top

Events

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

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate event 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.

See Also

Reference

System.ServiceModel.DomainServices.Client.ApplicationServices Namespace