LightboxBroker Class
Authenticate users with a lightbox
Constructor
LightboxBroker
-
clientId
-
[options={}]
Parameters:
-
clientId
String- the OAuth client ID for the relier
-
[options={}]
Object optional- configuration
-
[contentHost]
String optionalFirefox Accounts Content Server host
-
[oauthHost]
String optionalFirefox Accounts OAuth Server host
-
[window]
Object optionalwindow override, used for unit tests
-
[lightbox]
Object optionallightbox override, used for unit tests
-
[channel]
Object optionalchannel override, used for unit tests
Item Index
Methods
Methods
bestChoice
-
config
Best choice auth strategy, has no action set
Parameters:
-
config
Object- configuration
-
state
StringCSRF/State token
-
redirectUri
StringURI to redirect to when complete
-
scope
StringOAuth scope
-
[email]
String optionalEmail address used to pre-fill into the account form, but the user is free to change it.
forceAuth
-
config
Force a user to sign in as an existing user.
Parameters:
-
config
Object- configuration
-
state
StringCSRF/State token
-
redirectUri
StringURI to redirect to when complete
-
scope
StringOAuth scope
-
email
StringEmail address the user must sign in with. The user is unable to modify the email address and is unable to sign up if the address is not registered.
-
[ui]
String optionalUI to present -
lightbox
orredirect
- defaults toredirect
openFxa
-
fxaUrl
-
}
Open Firefox Accounts to authenticate the user. Must be overridden to provide API specific functionality.
Parameters:
-
fxaUrl
String- URL to open for authentication
-
}
Options=options
setContext
-
context
Set the context
field to be passed to the content server. If not
set, no context will be sent. Should be called by sub-classes if
a context is needed.
Parameters:
-
context
String
signIn
-
config
Sign in an existing user
Parameters:
-
config
Object- configuration
-
state
StringCSRF/State token
-
redirectUri
StringURI to redirect to when complete
-
scope
StringOAuth scope
-
[email]
String optionalEmail address used to pre-fill into the account form, but the user is free to change it. Set to the string literal
blank
to ignore any previously signed in email. Default is the last email address used to sign in.
signUp
-
config
Sign up a new user
Parameters:
-
config
Object- configuration
-
state
StringCSRF/State token
-
redirectUri
StringURI to redirect to when complete
-
scope
StringOAuth scope
-
[email]
String optionalEmail address used to pre-fill into the account form, but the user is free to change it.
unload
()
Unload the lightbox