0 out of 1 rated this helpful - Rate this topic

OnlineIdAuthenticator.CanSignOut | canSignOut property

Indicates whether a user can sign out of the app, and whether to show the sign out link in the app.

Syntax

Public ReadOnly Property CanSignOut As Boolean

Property value

Type: Boolean [JavaScript] | System.Boolean [.NET] | Platform::Boolean [C++]

True if the user can sign out and the sign out link should be shown in the app, otherwise false.

Remarks

An app that uses the OnlineIdAuthenticator class must show an option for the user to sign out. The sign out option must appear in the Settings charm, and the app must create a new page for its user account settings in Accounts. To see an example of how to add the sign out option and the account setting page, see the Windows Account Authorization sample.

If the user has a connected account, they can sign out by visiting the Users page in PC Settings.

If this property is false, a call to SignOutUserAsync fails with the ONL_E_CONNECTED_ACCOUNT_CAN_NOT_SIGNOUT error code.

Examples


var canSignOut = onlineIdAuthenticator.canSignOut;

if (Boolean(canSignOut)){

   // Add a "sign out" link to Charm settings.
}


Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8

Namespace

Windows.Security.Authentication.OnlineId
Windows::Security::Authentication::OnlineId [C++]

Metadata

Windows.winmd

See also

OnlineIdAuthenticator
Windows Account Authorization sample

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.