Learn R Programming

firebase (version 0.1.0)

Firebase: Fireblaze

Description

Use fireblaze to manage authentications.

Arguments

Public fields

session

A valid Shiny session.

Active bindings

signed_in

Read the signed in user.

signed_up

Read the signed in user.

Methods

Public methods

Method new()

Usage

Firebase$new(
  persistence = c("none", "session", "local"),
  config_path = "firebase.rds",
  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 create_config.

session

A valid shiny session.

Details

Initialise Fireblaze

Method sign_out()

Usage

Firebase$sign_out()

Details

Signs out user

Returns

self

Method get_sign_out()

Usage

Firebase$get_sign_out()

Details

Get signed out results

Returns

A list of length 2 containing success a boolean indicating wherther signing out was successful and response containing sucessful or the error.

Method get_signed_in()

Usage

Firebase$get_signed_in()

Details

Signed in user details triggered when auth states changes

Returns

A list of length 2 containing success a boolean indicating wherther signing in was successful and response containing the user object or NULL if signing in failed.

Method get_signed_up()

Usage

Firebase$get_signed_up()

Details

Get results of a sign up

Returns

A list of length 2 containing success a boolean indicating wherther signing in was successful and response containing the user object or NULL if signing in failed.

Method is_signed_in()

Usage

Firebase$is_signed_in()

Details

Check whether use is signed in

Returns

A boolean indicating whether user has successfully signed in.

Method req_sign_in()

Usage

Firebase$req_sign_in()

Details

Makes Shiny output, observer, or reactive require the user to be signed in

Method req_sign_out()

Usage

Firebase$req_sign_out()

Details

Makes Shiny output, observer, or reactive require the user to be signed out

Method set_language_code()

Usage

Firebase$set_language_code(code)

Arguments

code

iso639-1 language code.

Details

Set language code for auth provider

Returns

self

Method delete_user()

Usage

Firebase$delete_user()

Details

Delete the user

Returns

self

Method get_delete_user()

Usage

Firebase$get_delete_user()

Details

Get result of user deletion

Get results of a sign up

Returns

A list of length 2 containing success a boolean indicating wherther deletion was successful and response containing either successful string or the error if signing in failed.

Method clone()

The objects of this class are cloneable with this method.

Usage

Firebase$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.