import FacebookAuth from 'node-user-accounts-boilerplate/node-user-accounts-boilerplate-nahid/auth/FacebookAuth.js'

public class | source

FacebookAuth

Extends:

Auth → FacebookAuth

OAuth login using facebook login provider

Requires passport-facebook package.

Constructor Summary

Public Constructor
public	constructor(options: object)

Member Summary

Public Members
public	facebookClientID: * OAuth 2 Client ID
public	facebookClientSecret: * OAuth 2 Client Secret
public	proxy: * Should it construct urls based on proxy headers.

Method Summary

Public Methods
public	createUserFromProfile(profile: ):
public	install(app: , prefix: , passport: *)

Inherited Summary

From class Auth
public	authenticateOptions: * Additional settings given to passport.authenticate.
public	custom: object Custom fields
public	defaultErrorMsg: string Default error message to return instead of actual errors (security).
public	defaultRoles: object Default roles new registered users should assume.
public	description: * This is a standard descriptor of this authentication mechanism that is publicly shared.
public	method: * Authentication method name.
public	users: CachedCollection Users collection.
public	async createProfileFromCredential(id: , extra: {}): helper method that creates a profile object from a credential address
public	createUserFromProfile(profile: Profile): User Helper method that creates an User object from a Profile
public	findUser(value: string): User \| false Helper method that finds an user based on a credential.
public	generateId(): *
public	handleUserLoginByProfile(username: string, profile: Profile, done: Function, req: Request) Helper method for SSO type logins.
public abstract	install(app: ExpressApplication, prefix: string, passport: Passport) Must be overridden to provide implementation of said authentication method.
public	loggedIn(redirect: boolean): ExpressMiddleware Helper method that produces a middleware to handle successful logged in case.

Public Constructors

public constructor(options: object) source

Override:

Auth#constructor

Params:

Name	Type	Attribute	Description
options	object		see Auth class + additional options for email configuration.

Public Members

public facebookClientID: * source

OAuth 2 Client ID

public facebookClientSecret: * source

OAuth 2 Client Secret

public proxy: * source

Should it construct urls based on proxy headers.

Public Methods

public createUserFromProfile(profile: ): source

Helper method that creates an User object from a Profile

Override:

Auth#createUserFromProfile

Params:

Name	Type	Attribute	Description
profile	*

Return:

public install(app: , prefix: , passport: *) source

Must be overridden to provide implementation of said authentication method.

Override:

Auth#install

Params:

Name	Type	Attribute	Description
app	*
prefix	*
passport	*

FacebookAuth

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(options: object) source

Override:

Params:

Public Members

public facebookClientID: * source

public facebookClientSecret: * source

public proxy: * source

Public Methods

public createUserFromProfile(profile: *): * source

Override:

Params:

Return:

public install(app: *, prefix: *, passport: *) source

Override:

Params:

public createUserFromProfile(profile: ): source

public install(app: , prefix: , passport: *) source