UserAuthenticationOperation UserAuthenticationOperation UserAuthenticationOperation UserAuthenticationOperation Class

Asynchronously gets the user's identity and corresponding tickets and properties.

Note

If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager.

Syntax

Declaration

public sealed class UserAuthenticationOperationpublic sealed class UserAuthenticationOperationPublic NotInheritable Class UserAuthenticationOperationpublic sealed class UserAuthenticationOperation

Properties summary

Gets or sets a handler that's called when the operation completes.

Note

If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager.

Gets the error code should the operation fail.

Note

If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager.

Gets a unique identifier that represents the operation.

Note

If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager.

Gets the current status of the operation.

Note

If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager.

Methods summary

Requests the cancellation of the operation.

Note

If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager.

Requests that work associated with the operation should terminate.

Note

If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager.

Returns a UserIdentity object that contains information about the user.

Note

If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager.

Properties

  • Completed
    Completed
    Completed
    Completed

    Gets or sets a handler that's called when the operation completes.

    Note

    If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager.

    public AsyncOperationCompletedHandler<UserIdentity> Completed { get; set; }public AsyncOperationCompletedHandler<UserIdentity> Completed { get; set; }Public ReadWrite Property Completed As AsyncOperationCompletedHandler<UserIdentity>public AsyncOperationCompletedHandler<UserIdentity> Completed { get; set; }

    Property Value

    • The method or function that is called when the operation completes.

  • ErrorCode
    ErrorCode
    ErrorCode
    ErrorCode

    Gets the error code should the operation fail.

    Note

    If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager.

    public HResult ErrorCode { get; }public Exception ErrorCode { get; }Public ReadOnly Property ErrorCode As Exceptionpublic HResult ErrorCode { get; }

    Property Value

  • Id
    Id
    Id
    Id

    Gets a unique identifier that represents the operation.

    Note

    If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager.

    public uint Id { get; }public uint Id { get; }Public ReadOnly Property Id As uintpublic uint Id { get; }

    Property Value

    • uint
      uint
      uint
      uint

      The operation's unique ID as defined in the package manifest.

  • Status
    Status
    Status
    Status

    Gets the current status of the operation.

    Note

    If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager.

    public AsyncStatus Status { get; }public AsyncStatus Status { get; }Public ReadOnly Property Status As AsyncStatuspublic AsyncStatus Status { get; }

    Property Value

Methods

  • Cancel()
    Cancel()
    Cancel()
    Cancel()

    Requests the cancellation of the operation.

    Note

    If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager.

    public void Cancel()public void Cancel()Public Function Cancel() As voidpublic void Cancel()
  • Close()
    Close()
    Close()
    Close()

    Requests that work associated with the operation should terminate.

    Note

    If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager.

    public void Close()public void Close()Public Function Close() As voidpublic void Close()
  • GetResults()
    GetResults()
    GetResults()
    GetResults()

    Returns a UserIdentity object that contains information about the user.

    Note

    If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager.

    public UserIdentity GetResults()public UserIdentity GetResults()Public Function GetResults() As UserIdentitypublic UserIdentity GetResults()

    Returns

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute

Details

Assembly

Windows.Security.Authentication.OnlineId.dll