The nodes placeholder in Weavy

Kind: instance property of authentication
Extends: weavy.nodes

Open the sign-in page. An authentication attempt is started if credentials are provided.

Kind: instance method of authentication
Emits: weavy.signed-in , weavy.authentication-error
Resolves: true - On successful sign-in
Resolves: false - On authentication error

Param	Type
[username]	string
[password]	string

Example

// Open the sign in panel and wait for the user to complete authentication
weavy.signIn().then(function(signedIn) {
    if (signedIn) {
        weavy.log("User has signed in");
    } else {
        weavy.warn("User sign-in failed");
    }
});

Sign out from Weavy regardless of authentication provider

Kind: instance method of authentication
Emits: weavy.signed-out
Resolves: When sign-out is completed
Example

// Sign out the active user
weavy.signOut().then(function() {
    // Open the sign in page
    weavy.signIn();
});

Current authentication state of the user

• "signing-in" - The user is trying to sign in. See Widget event: signing-in
• "signed-in" - The user is signed in. See Widget event: signed-in
• "signing-out" - The user has started the sign-out process. See Widget event: signing-out
• "signed-out" - The user is not authenticated. See Widget event: signed-out and authentication-error

Kind: instance property of authentication
Default: "signed-out"
Category: properties

The url to the sign in page

Kind: instance property of authentication
Category: properties

The url to the sign out page

Kind: instance property of authentication
Category: properties

Default plugin options

Kind: static property of authentication
Properties

Name	Type	Default	Description
redirect	string	"/notify"	URL to redirect to after signing in or out
frameClassName	string		Classes added to the class-property of authenticationFrame
frameName	string	"authentication"	Name used for the authentication panel

Example

Weavy.plugins.authentication.defaults = {
    redirect: '/notify',
    frameClassName: "",
    frameName: "authentication"
};