buildfire.auth

Some plugins require the user to be authenticated before continuing on to a particular feature. BuildFire provides easy to use out of the box authentication solution. Log in, register, log out, manage sessions and more.

Methods

login()

buildfire.auth.login(options, callback)

This method will check if the current user is logged in or not. If not, buildfire.js will open the login UI for user to log in or register a new account.

buildfire.auth.login({}, (err, user) => {

console.log(err, user);

});

options

Name	Type	Required	Description	Default
allowCancel	boolean	no	A flag to show or hide the cancel link on the login screen	true
showMenu	boolean	no	A flag to show or hide the menu link on the login screen	true

callback(err, user)

Called when the data is retrieved from the datastore. The callback function is called after login or registration is successful.

Name	Type	Description
err	string	error string, null when operation is successfull
user	object	Currently logged in user containing users public properties

user

User object with users public properties

Name	Type	Description
_id	string	Unique id
createdOn	string	Date and time when user profile was created in ISOString format
lastUpdated	string	Date and time when user profile was last updated in ISOString format
email	string	Users email address
firstName	string	Users first name
lastName	string	Users last name
displayName	string	Users display name name
username	string	Users username
imageUrl	string	Users profile image url
userProfile	object	Object containing custom user profile public fields
tags	object	Users tag object, see more here
oauthProfile	object	Custom object from an OAuth provider if used in login see more here

More Examples

buildfire.auth.login(

{

allowCancel: false,

showMenu: false,

},

(err, user) => {

console.log(err, user);

}

);

---

onLogin()

buildfire.auth.onLogin(callback, allowMultipleHandlers)

Allows you to pass a listener function that is called whenever the user logs in. Returns an object with clear function that can be used to clear the listener.

buildfire.auth.onLogin((user) => {

console.log(user, "logged in!");

}, true);

callback(user)

Function that gets called whenever the user logs in.

Name	Type	Description
user	object	Currently logged in user containing users public properties

allowMultipleHandlers

Name	Type	Required	Description	Default
allowMultipleHandlers	boolean	no	Tells the method to override all other handlers, or allow multiple handlers to exist at the same time.	false

More Examples

let onLogin = buildfire.auth.onLogin((user) => {

console.log(user, "logged in!");

}, true);

// Clears the listener

onLogin.clear();

---

logout()

buildfire.auth.logout()

Log user out from buildfire.

buildfire.auth.logout();

note

This method does not accept any arguments

---

onLogout()

buildfire.auth.onLogout(callback, allowMultipleHandlers)

Allows you to pass a listener function that is called whenever the user logs out. Returns an object with clear function that can be used to clear the listener.

buildfire.auth.onLogout(() => {

console.log("User logged out!");

}, false);

callback()

Function that gets called whenever the user logs out.

allowMultipleHandlers

Name	Type	Required	Description	Default
allowMultipleHandlers	boolean	no	Tells the method to override all other handlers, or allow multiple handlers to exist at the same time.	false

let onLogout = buildfire.auth.onLogout(() => {

console.log("User logged out!");

}, false);

// Clears the listener

onLogout.clear();

---

getCurrentUser()

buildfire.auth.getCurrentUser(callback)

Retrieves currently logged in user

buildfire.auth.getCurrentUser((err, user) => {

if (err) return console.error(err);

console.log(user);

});

callback(err, user)

Called with the current logged in user if exists.

Name	Type	Description
err	string	error string, null when operation is successfull
user	object	Currently logged in user containing users public properties

---

getUserProfile()

buildfire.auth.getUserProfile(options, callback)

Pulls a public profile for a user if you have the userId.

buildfire.auth.getUserProfile({ userId: "USER_ID_HERE" }, (err, user) => {

if (err) return console.error(err);

console.log(user);

});

options

Name	Type	Required	Description	Default
userId	string	yes	The user id for which to pull a profile

callback(err, user)

Called with the current logged in user if exists.

Name	Type	Description
err	string	error string, null when operation is successfull
user	object	Currently logged in user containing users public properties

---

getUserPictureUrl()

buildfire.auth.getUserPictureUrl(options)

Returns user picture url by userId or email.

let userPictureUrl = buildfire.auth.getUserPictureUrl({

userId: "USER_ID_HERE",

});

options

Called with the current logged in user if exists.

Name	Type	Required	Description	Default
userId	string	required if there is no email	Users unique id
email	string	required if there is no userId	Users email

More Examples

let userPictureUrl = buildfire.auth.getUserPictureUrl({

email: "email@example.com",

});

---

openProfile()

buildfire.auth.openProfile(userId)

Redirects the app to view user profile page.

let userPictureUrl = buildfire.auth.openProfile("USER_ID_HERE");

userId

Name	Type	Required	Description	Default
userId	string	yes	Users unique id

More examplses

Opens profile of currently logged in user

buildfire.auth.getCurrentUser((err, user) => {

if (err) return console.err(err);

if (!user) return console.log("No logged in user");

buildfire.auth.openProfile(user._id);

});

---

assignUserTags()

buildfire.auth.assignUserTags([tags], options, callback)

Assigns a user tag to the currently logged-in user.

buildfire.auth.assignUserTags(["$$vip"], null, (err, result) => {

if (err) {

console.log("Error while adding tags", err);

} else {

console.error("Successfully added user tags");

}

});

[tags]

An array of tag strings to be assigned to currently logged in user. Tags must match the following cirteria:

• Begin with $$
• At least 5 character in length including $$
• May not contain commas (,)
• Should not contain spaces, spaces will be converted to dashes (-)

options

Reserved for future usage. can be passed as null.

callback(err, result)

Called with the current logged in user if exists.

Name	Type	Description
err	string	error string, null when operation is successfull
result	boolean	true when tags are added successfully

---

keepSessionAlive()

buildfire.auth.keepSessionAlive(options, callback)

Resets counting idle time for user sessions. To be used when Session Expiration is enabled on Control Panel and the plugin needs to keep the session alive even if there are no clicks applied to the plugin widget. A good example would be if the user is listening to an audio or watching a video.

buildfire.auth.keepSessionAlive(null, (err, result) => {

console.log(err, result);

});

options

Reserved for future usage. can be passed as null.

callback(err, user)

Called with the current logged in user if exists.

Name	Type	Description
err	string	error string, null when operation is successfull
result	boolean	true when tags are added successfully