AccountsSettingsPane Class

Definition

Provides methods to show the accounts pane and also to enable the app to register callbacks when the accounts flyout is about to be displayed.

public ref class AccountsSettingsPane sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.None)]
/// [Windows.Foundation.Metadata.Muse(Version=100859904)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.ApplicationSettings.IAccountsSettingsPaneStatics, 65536, Windows.Foundation.UniversalApiContract)]
class AccountsSettingsPane sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.None)]
/// [Windows.Foundation.Metadata.Muse(Version=100859904)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.ApplicationSettings.IAccountsSettingsPaneStatics, 65536, "Windows.Foundation.UniversalApiContract")]
class AccountsSettingsPane sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.None)]
/// [Windows.Foundation.Metadata.Muse(Version=100859904)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.ApplicationSettings.IAccountsSettingsPaneStatics, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.DualApiPartition(version=167772162)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.ApplicationSettings.IAccountsSettingsPaneStatics2, 196608, "Windows.Foundation.UniversalApiContract")]
class AccountsSettingsPane sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.None)]
/// [Windows.Foundation.Metadata.Muse(Version=100859904)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.ApplicationSettings.IAccountsSettingsPaneStatics, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.DualApiPartition(version=167772162)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.ApplicationSettings.IAccountsSettingsPaneStatics2, 196608, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.ApplicationSettings.IAccountsSettingsPaneStatics3, 393216, "Windows.Foundation.UniversalApiContract")]
class AccountsSettingsPane sealed
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.None)]
[Windows.Foundation.Metadata.Muse(Version=100859904)]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.ApplicationSettings.IAccountsSettingsPaneStatics), 65536, typeof(Windows.Foundation.UniversalApiContract))]
public sealed class AccountsSettingsPane
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.None)]
[Windows.Foundation.Metadata.Muse(Version=100859904)]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.ApplicationSettings.IAccountsSettingsPaneStatics), 65536, "Windows.Foundation.UniversalApiContract")]
public sealed class AccountsSettingsPane
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.None)]
[Windows.Foundation.Metadata.Muse(Version=100859904)]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.ApplicationSettings.IAccountsSettingsPaneStatics), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.DualApiPartition(version=167772162)]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.ApplicationSettings.IAccountsSettingsPaneStatics2), 196608, "Windows.Foundation.UniversalApiContract")]
public sealed class AccountsSettingsPane
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.None)]
[Windows.Foundation.Metadata.Muse(Version=100859904)]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.ApplicationSettings.IAccountsSettingsPaneStatics), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.DualApiPartition(version=167772162)]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.ApplicationSettings.IAccountsSettingsPaneStatics2), 196608, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.ApplicationSettings.IAccountsSettingsPaneStatics3), 393216, "Windows.Foundation.UniversalApiContract")]
public sealed class AccountsSettingsPane
Public NotInheritable Class AccountsSettingsPane
Inheritance
AccountsSettingsPane
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced in 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

The app provides the callbacks with account metadata for all of the web account providers, web accounts, global account commands, and credential locker credentials that the app displays. Examples of account providers are Facebook, LinkedIn, and Twitter.

The account and credential command classes in the Windows.UI.ApplicationSettings namespace correspond with data objects in the Windows.UI.ApplicationSettings namespace:

Data Object (@"Windows.Security.Credentials?text=Windows.Security.Credentials" )UI object (@"Windows.UI.ApplicationSettings?text=Windows.UI.ApplicationSettings" )
@"Windows.Security.Credentials.WebAccount?text=WebAccount" @"Windows.UI.ApplicationSettings.WebAccountCommand?text=WebAccountCommand"
@"Windows.Security.Credentials.WebAccountProvider?text=WebAccountProvider" @"Windows.UI.ApplicationSettings.WebAccountProviderCommand?text=WebAccountProviderCommand"
@"Windows.Security.Credentials.PasswordCredential?text=PasswordCredential" @"Windows.UI.ApplicationSettings.CredentialCommand?text=CredentialCommand"

Version history

Windows version SDK version Value added
1607 14393 ShowAddAccountAsync
1607 14393 ShowManageAccountsAsync
1803 17134 ShowAddAccountForUserAsync
1803 17134 ShowManageAccountsForUserAsync

Methods

GetForCurrentView()

Gets an AccountsSettingsPane object that is associated with the current app view (that is, with CoreWindow ).

Show()

Displays the account settings pane.

ShowAddAccountAsync()

Displays the add accounts screen.

ShowAddAccountForUserAsync(User)

Displays the add accounts screen for the specified user.

ShowManageAccountsAsync()

Displays the manage accounts screen.

ShowManageAccountsForUserAsync(User)

Displays the manage accounts screen for the specified user.

Events

AccountCommandsRequested

Occurs when the user opens the accounts pane. Handling this event lets the app initialize the accounts commands and pause its UI until the user closes the pane.

Applies to

See also