Interface ISignInProperties

'Properties' object passed into the WL.ui method when 'name' is set to 'signin'.

Hierarchy

Index

Properties

Properties

optional public brand?: string

Defines the brand, or type of icon, to be used with the Live Connect sign-in button.

default

"windows"

public element: string

The value of the id attribute of the

tag to display the button in.

public name: string

Specifies the type of button to display. Specify "signin" to display the Live Connect sign-in button. Specify "skydrivepicker" to display the SkyDrive button.

optional public onerror?: Function

Specifies the function to call whenever there is any error while the sign-in control is initializing or while the user is signing in.

optional public onloggedin?: Function

Specifies the function to call after the user completes the sign-in process.

optional public onloggedout?: Function

Specifies the function to call after the user completes the sign-out process.

optional public sign_in_text?: string

If the value of the type property is set to "custom", this value specifies the sign-in text to be displayed in the button.

optional public sign_out_text?: string

If the value of the type property is "custom", this value specifies the sign-out text to be displayed in the button.

optional public state?: string

Windows Store apps using JavaScript: not applicable. Web apps: Optional. If the name property is set to "signin", the WL.init function's response_type property is set to "code", and the app uses server-flow authentication, the state object here can be used to track the web app's calling state on the web app server side. For more info, see the description of the state query parameter in the Server-side scenarios topic's "Getting an authorization code" section. http://msdn.microsoft.com/en-us/library/live/hh243649.aspx

optional public theme?: string

Defines the color pallette used for the sign-in button. For Windows Store apps using JavaScript, valid values are "dark" and "light". For web apps, valid values are "blue" and "white".

optional public type?: string

Defines the type of button.

default

"signin"