Microsoft.Live.Controls.SignInButton class

Article
03/30/2015

A button that can be placed in an app to initiate the process of connecting the app to the user's Microsoft account.

The button can be in one of two states:

Sign in: Either there is no user signed in, or the signed-in user has not given permission to the app. The button shows a localized string that indicates to the user that they can sign in.
Sign out: There is a connected user. The button shows a localized string that indicates to the user that they can sign out.

Note

This member is available only for Windows Phone. For Windows Store apps, use LiveAuthClient.LoginAsync to build a sign-in control.

Syntax

public class SignInButton

Public Class SignInButton

Members

The SignInButton class has these types of members:

Constructors

The SignInButton class has these constructors.

Constructor	Description
SignInButton() constructor	Creates a new instance of the SignInButton class.

Events

The SignInButton class has these events.

Event	Description
SessionChanged event	Raises change notifications when the value of the Session property is changed.

Methods

The SignInButton class has these methods. It also inherits methods from the Object class.

Method	Description
InitializeComponent() method	Reserved for system use. Do not use.

Properties

The SignInButton class has these properties.

Property	Access type	Description
Branding property	Read/write	Specifies the type of branding to display on the sign-in button.
BrandingProperty property	Read/write	A dependency property identifier that indicates the type of branding to display on the sign-in button, as specified by the value of the Branding property.
ButtonTextTypeProperty property	Read/write	A dependency property identifier that indicates the type of text displayed on the sign-in button, as specified by the value of the TextType property.
ClientId property	Read/write	Specifies the client ID for the registered app.
ClientIdProperty property	Read/write	A dependency property identifier that indicates the client ID for the registered app, as specified by the value of the ClientId property.
Scopes property	Read/write	A list of OAuth scopes that is used in Live sign in. The value of this property cannot include the value offline_access.
ScopesProperty property	Read/write	A dependency property identifier that indicates the OAuth scopes that are used in Live sign in, as specified by the value of the Scopes property.
Session property	Read-only	Identifies the session and specified scope for an authenticated user who is signed in from a particular app.
SignInText property	Read/write	The text to display on the sign-in button before the user signs in. This property is used only if the value of TextType is set to Custom; otherwise, it is ignored.
SignInTextProperty property	Read/write	A dependency property identifier that indicates the text to display on the sign-in button before the user signs in, as specified by the value of the SignInText property.
SignOutText property	Read/write	The text to display on the sign-in button after the user has signed out. This property is used only if the value of TextType is set to Custom; otherwise, it is ignored.
SignOutTextProperty property	Read/write	A dependency property identifier that indicates the text to display on the sign-in button after the user has signed out, as specified by the value of the SignOutText property.
TextType property	Read/write	Specifies the sign-in button text. For each TextType value specified, there is a separate sign-in text and sign-out text.

Requirements

Minimum supported client	None supported [Windows Store apps only]
Minimum supported server	None supported [Windows Store apps only]
Minimum supported phone	Windows Phone 8
Namespace	Microsoft.Live.Controls
Assembly	Microsoft.Live.Controls.dll

Share via