Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

SignInButton class

[This member may be altered or unavailable beginning with Live SDK v5.3, for Windows Store apps. Instead, use LiveAuthClient.LoginAsync to build a sign-in control. Note that this member is still available for Windows Phone.]

A button that can be placed in an app to initiate the process of connecting the app and 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.

Syntax


public class SignInButton

Members

The SignInButton class has these types of members:

Constructors

The SignInButton class has these constructors.

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

 

Events

The SignInButton class has these events.

EventDescription
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.

MethodDescription
InitializeComponent() method Reserved for system use. Do not use.

 

Properties

The SignInButton class has these properties.

PropertyAccess typeDescription

Branding property

Read/writeSpecifies the type of branding to display on the sign-in button.

BrandingProperty property

Read/writeA 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/writeA 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/writeSpecifies the client ID for the registered app.

ClientIdProperty property

Read/writeA dependency property identifier that indicates the client ID for the registered app, as specified by the value of the ClientId property.

Scopes property

Read/writeA 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/writeA 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-onlyIdentifies the session and specified scope for an authenticated user who is signed in from a particular app.

SignInText property

Read/writeThe 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/writeA 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/writeThe 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/writeA 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/writeSpecifies 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

 

 

Show:
© 2017 Microsoft