Interface IInitProperties

'Properties' object passed into the WL.init method.

Index

Properties

Properties

optional public client_id?: string

Web apps: Required. Specifies your app's OAuth client ID for web apps.

Windows Store apps using JavaScript: not needed.

optional public logging?: boolean

If set to "true", the library logs error info to the web browser console and notifies your app by means of the wl.log event.

default

true

optional public redirect_uri?: string

Contains the default redirect URI to be used for OAuth authentication. For web apps, the OAuth server redirects to this URI during the OAuth flow.

For Windows Store apps using JavaScript, specifying this value will enable the library to return the authentication token.

optional public response_type?: string

Web apps: optional. Windows Store apps using JavaScript: not applicable. Specifies the OAuth response type value. If set to "token", the client receives the access token directly. If set to "code", the client receives an authorization code, and the app server that serves the redirect_uri page should retrieve the access_token from the OAuth server by using the authorization code and client secret.

You can only set response_type to "code" for web apps.

default

"token"

optional public scope?: any

The scope values used to determine which portions of user data the app has access to, if the user consents.

For a single scope, use this format: scope: "wl.signin". For multiple scopes, use this format: scope: ["wl.signin", "wl.basic"].

optional public secure_cookie?: string

Web apps: optional. Windows Store apps using JavaScript: not applicable. If set to "true", the library specifies a secure attribute when writing a cookie on an HTTPS page.

default

"false"

optional public status?: boolean

Web apps: optional. Windows Store apps using JavaScript: not applicable. If set to "true", the library attempts to retrieve the user's sign-in status from Live Connect.

default

true