SignOutUserOperation SignOutUserOperation SignOutUserOperation SignOutUserOperation Class

Allows users to sign out of your app.

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 SignOutUserOperationpublic sealed class SignOutUserOperationPublic NotInheritable Class SignOutUserOperationpublic sealed class SignOutUserOperation

Remarks

Examples

This example shows how to sign out of an app.

function signOut() {
    if (sdkSample.canSignOut) {
        sdkSample.displayStatus("Signing out...");
        authenticator.signOutUserAsync().done(function () {
            sdkSample.accessToken = null;
            sdkSample.authenticatedSafeCustomerId = "";
            sdkSample.isSignedIn = false;
            sdkSample.displayStatus("Signed out.");
        },
            function (status) {
            if (status && (status.name !== "Canceled")) {
                showErrorMessage("Sign out action failed: " + status.message);
            } else {
                sdkSample.displayStatus("");
            }
        });
    }
}

Properties summary

Gets or sets a handler that is 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 the results of the operation. For this class, there are no results to return if the operation succeeds.

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

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 the results of the operation. For this class, there are no results to return if the operation succeeds.

    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 GetResults()public void GetResults()Public Function GetResults() As voidpublic void GetResults()

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