FirebaseUI {firebase}

Prebuilt UI

Description

Use firebase to manage authentications.

Value

An object of class FirebaseUI.

Super classes

firebase::Firebase -> firebase::FirebaseAuth -> FirebaseUI

Public fields

tos_url

URL to the Terms of Service page.

privacy_policy_url

The URL to the Privacy Policy page.

Methods

Public methods

• FirebaseUI$new()

• FirebaseUI$set_providers()

• FirebaseUI$set_tos_url()

• FirebaseUI$set_privacy_policy_url()

• FirebaseUI$launch()

• FirebaseUI$reset_password()

• FirebaseUI$get_reset()

• FirebaseUI$send_verification_email()

• FirebaseUI$get_verification_email()

• FirebaseUI$set_password()

• FirebaseUI$get_password()

• FirebaseUI$re_authenticate()

• FirebaseUI$get_re_authenticated()

• FirebaseUI$clone()

Inherited methods

• firebase::Firebase$expose_app()
• firebase::FirebaseAuth$clear()
• firebase::FirebaseAuth$delete_user()
• firebase::FirebaseAuth$expose_auth()
• firebase::FirebaseAuth$get_access_token()
• firebase::FirebaseAuth$get_delete_user()
• firebase::FirebaseAuth$get_id_token()
• firebase::FirebaseAuth$get_sign_out()
• firebase::FirebaseAuth$get_signed_in()
• firebase::FirebaseAuth$get_signed_up()
• firebase::FirebaseAuth$is_signed_in()
• firebase::FirebaseAuth$print()
• firebase::FirebaseAuth$req_sign_in()
• firebase::FirebaseAuth$req_sign_out()
• firebase::FirebaseAuth$request_id_token()
• firebase::FirebaseAuth$set_language_code()
• firebase::FirebaseAuth$sign_out()

Method new()

Usage

FirebaseUI$new(
  persistence = c("session", "local", "memory"),
  config_path = "firebase.rds",
  language_code = NULL,
  session = shiny::getDefaultReactiveDomain()
)

Arguments

persistence

How the auth should persit: none, the user has to sign in at every visit, session will only persist in current tab, local persist even when window is closed.

config_path

Path to the configuration file as created by firebase_config.

language_code

Sets the language to use for the UI. Supported languages are listed here. Set to browser to use the default browser language of the user.

session

A valid shiny session.

Details

Initialiases Firebase UI

Initialises the Firebase application client-side.

Method set_providers()

Usage

FirebaseUI$set_providers(
  google = FALSE,
  facebook = FALSE,
  twitter = FALSE,
  github = FALSE,
  email = FALSE,
  email_link = FALSE,
  microsoft = FALSE,
  apple = FALSE,
  yahoo = FALSE,
  phone = FALSE,
  anonymous = FALSE
)

Arguments

google, facebook, twitter, github, email, email_link, microsoft, apple, yahoo, phone, anonymous

Set to TRUE the providers you want to use, at least one.

Details

Define signin and login providers.

Returns

self

Method set_tos_url()

Usage

FirebaseUI$set_tos_url(url)

Arguments

url

URL to use.

Details

Defines Tterms of Services URL

Returns

self

Method set_privacy_policy_url()

Usage

FirebaseUI$set_privacy_policy_url(url)

Arguments

url

URL to use.

Details

Defines Privacy Policy URL

Returns

self

Method launch()

Usage

FirebaseUI$launch(flow = c("popup", "redirect"), account_helper = FALSE)

Arguments

flow

The signin flow to use, popup or redirect.

account_helper

Wether to use accountchooser.com upon signing in or signing up with email, the user will be redirected to the accountchooser.com website and will be able to select one of their saved accounts. You can disable it by specifying the value below.

...

Any other option to pass to Firebase UI.

Details

Setup the signin form.

Returns

self

Method reset_password()

Usage

FirebaseUI$reset_password(email = NULL)

Arguments

email

Email to send reset link to, if missing looks for current logged in user's email

Details

Reset user password

Returns

self

Method get_reset()

Usage

FirebaseUI$get_reset()

Details

Get whether password reset email was successfully sent

Returns

A list of length 2 containing success a boolean indicating whether email reset was successful and response containing successful or the error.

Method send_verification_email()

Usage

FirebaseUI$send_verification_email()

Details

Send the user a verification email

Returns

self

Method get_verification_email()

Usage

FirebaseUI$get_verification_email()

Details

Get result of verification email sending procedure

Returns

A list of length 2 containing success a boolean indicating whether email verification was successfully sent and response containing successful or the error.

Method set_password()

Usage

FirebaseUI$set_password(password)

Arguments

password

The authenticated user password, the user should be prompted to enter it.

Details

Set user password

Useful to provide ability to change password.

Returns

self

Method get_password()

Usage

FirebaseUI$get_password()

Details

Get response from set_password

Returns

A list of length 2 containing success a boolean indicating whether setting password was successfully set and response containing successful as string or the error.

Method re_authenticate()

Usage

FirebaseUI$re_authenticate(password)

Arguments

password

The authenticated user password, the user should be prompted to enter it.

Details

Re-authenticate the user.

Some security-sensitive actions—such as deleting an account, setting a primary email address, and changing a password—require that the user has recently signed in. If you perform one of these actions, and the user signed in too long ago, the action fails with an error.

Method get_re_authenticated()

Usage

FirebaseUI$get_re_authenticated()

Details

Get response from re_authenticate

Returns

A list of length 2 containing success a boolean indicating whether re-authentication was successful and response containing successful as string or the error.

Method clone()

The objects of this class are cloneable with this method.

Usage

FirebaseUI$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

library(shiny)
library(firebase)

ui <- fluidPage(
  useFirebase(), # import dependencies
  firebaseUIContainer() # import UI
)

server <- function(input, output){
  f <- FirebaseUI$
    new()$ # instantiate
    set_providers( # define providers
      email = TRUE, 
      google = TRUE
    )
}

## Not run: shinyApp(ui, server)