<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Prebuilt UI — FirebaseUI • firebase</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Prebuilt UI — FirebaseUI"><meta property="og:description" content="Use firebase to manage authentications."><meta property="og:image" content="/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--></head><body data-spy="scroll" data-target="#toc">
    

    <div class="container template-reference-topic">
      <header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <span class="navbar-brand">
        <a class="navbar-link" href="../index.html">firebase</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">1.0.1.9000</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav"><li>
  <a href="../reference/index.html">Reference</a>
</li>
<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
    Articles
     
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu"><li>
      <a href="../articles/analytics.html">Storage</a>
    </li>
    <li>
      <a href="../articles/demo.html">Demo</a>
    </li>
    <li>
      <a href="../articles/email-link.html">Email Link</a>
    </li>
    <li>
      <a href="../articles/email-password.html">Email &amp; Password</a>
    </li>
    <li>
      <a href="../articles/flow.html">flow</a>
    </li>
    <li>
      <a href="../articles/get-started.html">Get Started</a>
    </li>
    <li>
      <a href="../articles/manage.html">Manage Users</a>
    </li>
    <li>
      <a href="../articles/oauth-providers.html">Oauth Providers</a>
    </li>
    <li>
      <a href="../articles/phone.html">phone</a>
    </li>
    <li>
      <a href="../articles/social.html">Social Sites</a>
    </li>
    <li>
      <a href="../articles/state-persistence.html">state-persistence</a>
    </li>
    <li>
      <a href="../articles/storage.html">Storage</a>
    </li>
    <li>
      <a href="../articles/ui.html">Prebuilt UI</a>
    </li>
  </ul></li>
<li>
  <a href="../news/index.html">Changelog</a>
</li>
      </ul><ul class="nav navbar-nav navbar-right"><li>
  <a href="https://github.com/JohnCoene/firebase/" class="external-link">
    <span class="fab fa-github fa-lg"></span>
     
  </a>
</li>
      </ul></div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      

      </header><div class="row">
  <div class="col-md-9 contents">
    <div class="page-header">
    <h1>Prebuilt UI</h1>
    <small class="dont-index">Source: <a href="https://github.com/JohnCoene/firebase/blob/HEAD/R/class-ui.R" class="external-link"><code>R/class-ui.R</code></a></small>
    <div class="hidden name"><code>FirebaseUI.Rd</code></div>
    </div>

    <div class="ref-description">
    <p>Use firebase to manage authentications.</p>
    </div>


    <div id="super-classes">
    <h2>Super classes</h2>
    <p><code><a href="Firebase.html">firebase::Firebase</a></code> -&gt; <code><a href="FirebaseAuth.html">firebase::FirebaseAuth</a></code> -&gt; <code>FirebaseUI</code></p>
    </div>
    <div id="public-fields">
    <h2>Public fields</h2>
    <p></p><div class="r6-fields"><dl><dt><code>tos_url</code></dt>
<dd><p>URL to the Terms of Service page.</p></dd>


<dt><code>privacy_policy_url</code></dt>
<dd><p>The URL to the Privacy Policy page.</p></dd>


</dl><p></p></div>
    </div>
    <div id="methods">
    <h2>Methods</h2>
    
<div class="section">
<h3 id="public-methods">Public methods<a class="anchor" aria-label="anchor" href="#public-methods"></a></h3>

<ul><li><p><a href="#method-FirebaseUI-new"><code>FirebaseUI$new()</code></a></p></li>
<li><p><a href="#method-FirebaseUI-set_providers"><code>FirebaseUI$set_providers()</code></a></p></li>
<li><p><a href="#method-FirebaseUI-set_tos_url"><code>FirebaseUI$set_tos_url()</code></a></p></li>
<li><p><a href="#method-FirebaseUI-set_privacy_policy_url"><code>FirebaseUI$set_privacy_policy_url()</code></a></p></li>
<li><p><a href="#method-FirebaseUI-launch"><code>FirebaseUI$launch()</code></a></p></li>
<li><p><a href="#method-FirebaseUI-reset_password"><code>FirebaseUI$reset_password()</code></a></p></li>
<li><p><a href="#method-FirebaseUI-get_reset"><code>FirebaseUI$get_reset()</code></a></p></li>
<li><p><a href="#method-FirebaseUI-send_verification_email"><code>FirebaseUI$send_verification_email()</code></a></p></li>
<li><p><a href="#method-FirebaseUI-get_verification_email"><code>FirebaseUI$get_verification_email()</code></a></p></li>
<li><p><a href="#method-FirebaseUI-set_password"><code>FirebaseUI$set_password()</code></a></p></li>
<li><p><a href="#method-FirebaseUI-get_password"><code>FirebaseUI$get_password()</code></a></p></li>
<li><p><a href="#method-FirebaseUI-re_authenticate"><code>FirebaseUI$re_authenticate()</code></a></p></li>
<li><p><a href="#method-FirebaseUI-get_re_authenticated"><code>FirebaseUI$get_re_authenticated()</code></a></p></li>
<li><p><a href="#method-FirebaseUI-clone"><code>FirebaseUI$clone()</code></a></p></li>
</ul></div><p><details><summary>Inherited methods</summary><ul><li><span class="pkg-link" data-pkg="firebase" data-topic="Firebase" data-id="expose_app"><a href="Firebase.html#method-expose_app"><code>firebase::Firebase$expose_app()</code></a></span></li>
<li><span class="pkg-link" data-pkg="firebase" data-topic="FirebaseAuth" data-id="clear"><a href="FirebaseAuth.html#method-clear"><code>firebase::FirebaseAuth$clear()</code></a></span></li>
<li><span class="pkg-link" data-pkg="firebase" data-topic="FirebaseAuth" data-id="delete_user"><a href="FirebaseAuth.html#method-delete_user"><code>firebase::FirebaseAuth$delete_user()</code></a></span></li>
<li><span class="pkg-link" data-pkg="firebase" data-topic="FirebaseAuth" data-id="expose_auth"><a href="FirebaseAuth.html#method-expose_auth"><code>firebase::FirebaseAuth$expose_auth()</code></a></span></li>
<li><span class="pkg-link" data-pkg="firebase" data-topic="FirebaseAuth" data-id="get_access_token"><a href="FirebaseAuth.html#method-get_access_token"><code>firebase::FirebaseAuth$get_access_token()</code></a></span></li>
<li><span class="pkg-link" data-pkg="firebase" data-topic="FirebaseAuth" data-id="get_delete_user"><a href="FirebaseAuth.html#method-get_delete_user"><code>firebase::FirebaseAuth$get_delete_user()</code></a></span></li>
<li><span class="pkg-link" data-pkg="firebase" data-topic="FirebaseAuth" data-id="get_id_token"><a href="FirebaseAuth.html#method-get_id_token"><code>firebase::FirebaseAuth$get_id_token()</code></a></span></li>
<li><span class="pkg-link" data-pkg="firebase" data-topic="FirebaseAuth" data-id="get_sign_out"><a href="FirebaseAuth.html#method-get_sign_out"><code>firebase::FirebaseAuth$get_sign_out()</code></a></span></li>
<li><span class="pkg-link" data-pkg="firebase" data-topic="FirebaseAuth" data-id="get_signed_in"><a href="FirebaseAuth.html#method-get_signed_in"><code>firebase::FirebaseAuth$get_signed_in()</code></a></span></li>
<li><span class="pkg-link" data-pkg="firebase" data-topic="FirebaseAuth" data-id="get_signed_up"><a href="FirebaseAuth.html#method-get_signed_up"><code>firebase::FirebaseAuth$get_signed_up()</code></a></span></li>
<li><span class="pkg-link" data-pkg="firebase" data-topic="FirebaseAuth" data-id="is_signed_in"><a href="FirebaseAuth.html#method-is_signed_in"><code>firebase::FirebaseAuth$is_signed_in()</code></a></span></li>
<li><span class="pkg-link" data-pkg="firebase" data-topic="FirebaseAuth" data-id="print"><a href="FirebaseAuth.html#method-print"><code>firebase::FirebaseAuth$print()</code></a></span></li>
<li><span class="pkg-link" data-pkg="firebase" data-topic="FirebaseAuth" data-id="req_sign_in"><a href="FirebaseAuth.html#method-req_sign_in"><code>firebase::FirebaseAuth$req_sign_in()</code></a></span></li>
<li><span class="pkg-link" data-pkg="firebase" data-topic="FirebaseAuth" data-id="req_sign_out"><a href="FirebaseAuth.html#method-req_sign_out"><code>firebase::FirebaseAuth$req_sign_out()</code></a></span></li>
<li><span class="pkg-link" data-pkg="firebase" data-topic="FirebaseAuth" data-id="request_id_token"><a href="FirebaseAuth.html#method-request_id_token"><code>firebase::FirebaseAuth$request_id_token()</code></a></span></li>
<li><span class="pkg-link" data-pkg="firebase" data-topic="FirebaseAuth" data-id="set_language_code"><a href="FirebaseAuth.html#method-set_language_code"><code>firebase::FirebaseAuth$set_language_code()</code></a></span></li>
<li><span class="pkg-link" data-pkg="firebase" data-topic="FirebaseAuth" data-id="sign_out"><a href="FirebaseAuth.html#method-sign_out"><code>firebase::FirebaseAuth$sign_out()</code></a></span></li>
</ul></details></p><hr><a id="method-FirebaseUI-new"></a><div class="section">
<h3 id="method-new-">Method <code><a href="https://rdrr.io/r/methods/new.html" class="external-link">new()</a></code><a class="anchor" aria-label="anchor" href="#method-new-"></a></h3>

<div class="section">
<h4 id="usage">Usage<a class="anchor" aria-label="anchor" href="#usage"></a></h4>
<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va"><a href="../reference/FirebaseUI.html">FirebaseUI</a></span><span class="op">$</span><span class="fu">new</span><span class="op">(</span></span>
<span>  persistence <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"session"</span>, <span class="st">"local"</span>, <span class="st">"memory"</span><span class="op">)</span>,</span>
<span>  config_path <span class="op">=</span> <span class="st">"firebase.rds"</span>,</span>
<span>  language_code <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  session <span class="op">=</span> <span class="fu">shiny</span><span class="fu">::</span><span class="fu"><a href="https://rdrr.io/pkg/shiny/man/domains.html" class="external-link">getDefaultReactiveDomain</a></span><span class="op">(</span><span class="op">)</span></span>
<span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h4>
<p></p><div class="arguments"><dl><dt><code>persistence</code></dt>
<dd><p>How the auth should persit: <code>none</code>, the user has to sign in at every visit,
<code>session</code> will only persist in current tab, <code>local</code> persist even when window is closed.</p></dd>


<dt><code>config_path</code></dt>
<dd><p>Path to the configuration file as created by <code><a href="config.html">firebase_config</a></code>.</p></dd>


<dt><code>language_code</code></dt>
<dd><p>Sets the language to use for the UI.
Supported languages are listed <a href="https://github.com/firebase/firebaseui-web/blob/master/LANGUAGES.md" class="external-link">here</a>.
Set to <code>browser</code> to use the default browser language of the user.</p></dd>


<dt><code>session</code></dt>
<dd><p>A valid shiny session.</p></dd>


</dl><p></p></div>
</div>
<div class="section">
<h4 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h4>
<p>Initialiases Firebase UI</p>
<p>Initialises the Firebase application client-side.</p>
</div>


</div><p></p><hr><a id="method-FirebaseUI-set_providers"></a><div class="section">
<h3 id="method-set-providers-">Method <code>set_providers()</code><a class="anchor" aria-label="anchor" href="#method-set-providers-"></a></h3>

<div class="section">
<h4 id="usage-1">Usage<a class="anchor" aria-label="anchor" href="#usage-1"></a></h4>
<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">FirebaseUI</span><span class="op">$</span><span class="fu">set_providers</span><span class="op">(</span></span>
<span>  google <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  facebook <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  twitter <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  github <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  email <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  email_link <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  microsoft <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  apple <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  yahoo <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  phone <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  anonymous <span class="op">=</span> <span class="cn">FALSE</span></span>
<span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="arguments-1">Arguments<a class="anchor" aria-label="anchor" href="#arguments-1"></a></h4>
<p></p><div class="arguments"><dl><dt><code>google, facebook, twitter, github, email, email_link, microsoft, apple, yahoo, phone, anonymous</code></dt>
<dd><p>Set to <code>TRUE</code> the providers you want to use, at least one.</p></dd>


</dl><p></p></div>
</div>
<div class="section">
<h4 id="details-1">Details<a class="anchor" aria-label="anchor" href="#details-1"></a></h4>
<p>Define signin and login providers.</p>
</div>

<div class="section">
<h4 id="returns">Returns<a class="anchor" aria-label="anchor" href="#returns"></a></h4>
<p>self</p>
</div>

</div><p></p><hr><a id="method-FirebaseUI-set_tos_url"></a><div class="section">
<h3 id="method-set-tos-url-">Method <code>set_tos_url()</code><a class="anchor" aria-label="anchor" href="#method-set-tos-url-"></a></h3>

<div class="section">
<h4 id="usage-2">Usage<a class="anchor" aria-label="anchor" href="#usage-2"></a></h4>
<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">FirebaseUI</span><span class="op">$</span><span class="fu">set_tos_url</span><span class="op">(</span><span class="va">url</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="arguments-2">Arguments<a class="anchor" aria-label="anchor" href="#arguments-2"></a></h4>
<p></p><div class="arguments"><dl><dt><code>url</code></dt>
<dd><p>URL to use.</p></dd>


</dl><p></p></div>
</div>
<div class="section">
<h4 id="details-2">Details<a class="anchor" aria-label="anchor" href="#details-2"></a></h4>
<p>Defines Tterms of Services URL</p>
</div>

<div class="section">
<h4 id="returns-1">Returns<a class="anchor" aria-label="anchor" href="#returns-1"></a></h4>
<p>self</p>
</div>

</div><p></p><hr><a id="method-FirebaseUI-set_privacy_policy_url"></a><div class="section">
<h3 id="method-set-privacy-policy-url-">Method <code>set_privacy_policy_url()</code><a class="anchor" aria-label="anchor" href="#method-set-privacy-policy-url-"></a></h3>

<div class="section">
<h4 id="usage-3">Usage<a class="anchor" aria-label="anchor" href="#usage-3"></a></h4>
<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">FirebaseUI</span><span class="op">$</span><span class="fu">set_privacy_policy_url</span><span class="op">(</span><span class="va">url</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="arguments-3">Arguments<a class="anchor" aria-label="anchor" href="#arguments-3"></a></h4>
<p></p><div class="arguments"><dl><dt><code>url</code></dt>
<dd><p>URL to use.</p></dd>


</dl><p></p></div>
</div>
<div class="section">
<h4 id="details-3">Details<a class="anchor" aria-label="anchor" href="#details-3"></a></h4>
<p>Defines Privacy Policy URL</p>
</div>

<div class="section">
<h4 id="returns-2">Returns<a class="anchor" aria-label="anchor" href="#returns-2"></a></h4>
<p>self</p>
</div>

</div><p></p><hr><a id="method-FirebaseUI-launch"></a><div class="section">
<h3 id="method-launch-">Method <code>launch()</code><a class="anchor" aria-label="anchor" href="#method-launch-"></a></h3>

<div class="section">
<h4 id="usage-4">Usage<a class="anchor" aria-label="anchor" href="#usage-4"></a></h4>
<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">FirebaseUI</span><span class="op">$</span><span class="fu">launch</span><span class="op">(</span>flow <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"popup"</span>, <span class="st">"redirect"</span><span class="op">)</span>, account_helper <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="arguments-4">Arguments<a class="anchor" aria-label="anchor" href="#arguments-4"></a></h4>
<p></p><div class="arguments"><dl><dt><code>flow</code></dt>
<dd><p>The signin flow to use, popup or redirect.</p></dd>


<dt><code>account_helper</code></dt>
<dd><p>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.</p></dd>


<dt><code>...</code></dt>
<dd><p>Any other option to pass to Firebase UI.</p></dd>


</dl><p></p></div>
</div>
<div class="section">
<h4 id="details-4">Details<a class="anchor" aria-label="anchor" href="#details-4"></a></h4>
<p>Setup the signin form.</p>
</div>

<div class="section">
<h4 id="returns-3">Returns<a class="anchor" aria-label="anchor" href="#returns-3"></a></h4>
<p>self</p>
</div>

</div><p></p><hr><a id="method-FirebaseUI-reset_password"></a><div class="section">
<h3 id="method-reset-password-">Method <code>reset_password()</code><a class="anchor" aria-label="anchor" href="#method-reset-password-"></a></h3>

<div class="section">
<h4 id="usage-5">Usage<a class="anchor" aria-label="anchor" href="#usage-5"></a></h4>
<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">FirebaseUI</span><span class="op">$</span><span class="fu">reset_password</span><span class="op">(</span>email <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="arguments-5">Arguments<a class="anchor" aria-label="anchor" href="#arguments-5"></a></h4>
<p></p><div class="arguments"><dl><dt><code>email</code></dt>
<dd><p>Email to send reset link to, if missing looks for current logged in user's email</p></dd>


</dl><p></p></div>
</div>
<div class="section">
<h4 id="details-5">Details<a class="anchor" aria-label="anchor" href="#details-5"></a></h4>
<p>Reset user password</p>
</div>

<div class="section">
<h4 id="returns-4">Returns<a class="anchor" aria-label="anchor" href="#returns-4"></a></h4>
<p>self</p>
</div>

</div><p></p><hr><a id="method-FirebaseUI-get_reset"></a><div class="section">
<h3 id="method-get-reset-">Method <code>get_reset()</code><a class="anchor" aria-label="anchor" href="#method-get-reset-"></a></h3>

<div class="section">
<h4 id="usage-6">Usage<a class="anchor" aria-label="anchor" href="#usage-6"></a></h4>
<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">FirebaseUI</span><span class="op">$</span><span class="fu">get_reset</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="details-6">Details<a class="anchor" aria-label="anchor" href="#details-6"></a></h4>
<p>Get whether password reset email was successfully sent</p>
</div>

<div class="section">
<h4 id="returns-5">Returns<a class="anchor" aria-label="anchor" href="#returns-5"></a></h4>
<p>A list of length 2 containing <code>success</code> a boolean
indicating whether email reset was successful and <code>response</code>
containing <code>successful</code> or the error.</p>
</div>

</div><p></p><hr><a id="method-FirebaseUI-send_verification_email"></a><div class="section">
<h3 id="method-send-verification-email-">Method <code>send_verification_email()</code><a class="anchor" aria-label="anchor" href="#method-send-verification-email-"></a></h3>

<div class="section">
<h4 id="usage-7">Usage<a class="anchor" aria-label="anchor" href="#usage-7"></a></h4>
<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">FirebaseUI</span><span class="op">$</span><span class="fu">send_verification_email</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="details-7">Details<a class="anchor" aria-label="anchor" href="#details-7"></a></h4>
<p>Send the user a verification email</p>
</div>

<div class="section">
<h4 id="returns-6">Returns<a class="anchor" aria-label="anchor" href="#returns-6"></a></h4>
<p>self</p>
</div>

</div><p></p><hr><a id="method-FirebaseUI-get_verification_email"></a><div class="section">
<h3 id="method-get-verification-email-">Method <code>get_verification_email()</code><a class="anchor" aria-label="anchor" href="#method-get-verification-email-"></a></h3>

<div class="section">
<h4 id="usage-8">Usage<a class="anchor" aria-label="anchor" href="#usage-8"></a></h4>
<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">FirebaseUI</span><span class="op">$</span><span class="fu">get_verification_email</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="details-8">Details<a class="anchor" aria-label="anchor" href="#details-8"></a></h4>
<p>Get result of verification email sending procedure</p>
</div>

<div class="section">
<h4 id="returns-7">Returns<a class="anchor" aria-label="anchor" href="#returns-7"></a></h4>
<p>A list of length 2 containing <code>success</code> a boolean
indicating whether email verification was successfully sent and <code>response</code>
containing <code>successful</code> or the error.</p>
</div>

</div><p></p><hr><a id="method-FirebaseUI-set_password"></a><div class="section">
<h3 id="method-set-password-">Method <code>set_password()</code><a class="anchor" aria-label="anchor" href="#method-set-password-"></a></h3>

<div class="section">
<h4 id="usage-9">Usage<a class="anchor" aria-label="anchor" href="#usage-9"></a></h4>
<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">FirebaseUI</span><span class="op">$</span><span class="fu">set_password</span><span class="op">(</span><span class="va">password</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="arguments-6">Arguments<a class="anchor" aria-label="anchor" href="#arguments-6"></a></h4>
<p></p><div class="arguments"><dl><dt><code>password</code></dt>
<dd><p>The authenticated user password, the user should be prompted
to enter it.</p></dd>


</dl><p></p></div>
</div>
<div class="section">
<h4 id="details-9">Details<a class="anchor" aria-label="anchor" href="#details-9"></a></h4>
<p>Set user password</p>
<p>Useful to provide ability to change password.</p>
</div>

<div class="section">
<h4 id="returns-8">Returns<a class="anchor" aria-label="anchor" href="#returns-8"></a></h4>
<p>self</p>
</div>

</div><p></p><hr><a id="method-FirebaseUI-get_password"></a><div class="section">
<h3 id="method-get-password-">Method <code>get_password()</code><a class="anchor" aria-label="anchor" href="#method-get-password-"></a></h3>

<div class="section">
<h4 id="usage-10">Usage<a class="anchor" aria-label="anchor" href="#usage-10"></a></h4>
<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">FirebaseUI</span><span class="op">$</span><span class="fu">get_password</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="details-10">Details<a class="anchor" aria-label="anchor" href="#details-10"></a></h4>
<p>Get response from set_password</p>
</div>

<div class="section">
<h4 id="returns-9">Returns<a class="anchor" aria-label="anchor" href="#returns-9"></a></h4>
<p>A list of length 2 containing <code>success</code> a boolean
indicating whether setting password was successfully set and <code>response</code>
containing <code>successful</code> as string or the error.</p>
</div>

</div><p></p><hr><a id="method-FirebaseUI-re_authenticate"></a><div class="section">
<h3 id="method-re-authenticate-">Method <code>re_authenticate()</code><a class="anchor" aria-label="anchor" href="#method-re-authenticate-"></a></h3>

<div class="section">
<h4 id="usage-11">Usage<a class="anchor" aria-label="anchor" href="#usage-11"></a></h4>
<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">FirebaseUI</span><span class="op">$</span><span class="fu">re_authenticate</span><span class="op">(</span><span class="va">password</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="arguments-7">Arguments<a class="anchor" aria-label="anchor" href="#arguments-7"></a></h4>
<p></p><div class="arguments"><dl><dt><code>password</code></dt>
<dd><p>The authenticated user password, the user should be prompted
to enter it.</p></dd>


</dl><p></p></div>
</div>
<div class="section">
<h4 id="details-11">Details<a class="anchor" aria-label="anchor" href="#details-11"></a></h4>
<p>Re-authenticate the user.</p>
<p>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.</p>
</div>


</div><p></p><hr><a id="method-FirebaseUI-get_re_authenticated"></a><div class="section">
<h3 id="method-get-re-authenticated-">Method <code>get_re_authenticated()</code><a class="anchor" aria-label="anchor" href="#method-get-re-authenticated-"></a></h3>

<div class="section">
<h4 id="usage-12">Usage<a class="anchor" aria-label="anchor" href="#usage-12"></a></h4>
<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">FirebaseUI</span><span class="op">$</span><span class="fu">get_re_authenticated</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="details-12">Details<a class="anchor" aria-label="anchor" href="#details-12"></a></h4>
<p>Get response from re_authenticate</p>
</div>

<div class="section">
<h4 id="returns-10">Returns<a class="anchor" aria-label="anchor" href="#returns-10"></a></h4>
<p>A list of length 2 containing <code>success</code> a boolean
indicating whether re-authentication was successful and <code>response</code>
containing <code>successful</code> as string or the error.</p>
</div>

</div><p></p><hr><a id="method-FirebaseUI-clone"></a><div class="section">
<h3 id="method-clone-">Method <code>clone()</code><a class="anchor" aria-label="anchor" href="#method-clone-"></a></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section">
<h4 id="usage-13">Usage<a class="anchor" aria-label="anchor" href="#usage-13"></a></h4>
<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">FirebaseUI</span><span class="op">$</span><span class="fu">clone</span><span class="op">(</span>deep <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="arguments-8">Arguments<a class="anchor" aria-label="anchor" href="#arguments-8"></a></h4>
<p></p><div class="arguments"><dl><dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></p></div>
</div>

</div>

    </div>

    <div id="ref-examples">
    <h2>Examples</h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://shiny.rstudio.com/" class="external-link">shiny</a></span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://firebase.john-coene.com/" class="external-link">firebase</a></span><span class="op">)</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="va">ui</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/pkg/shiny/man/fluidPage.html" class="external-link">fluidPage</a></span><span class="op">(</span></span></span>
<span class="r-in"><span>  <span class="fu"><a href="dependencies.html">useFirebase</a></span><span class="op">(</span><span class="op">)</span>, <span class="co"># import dependencies</span></span></span>
<span class="r-in"><span>  <span class="fu"><a href="dependencies.html">firebaseUIContainer</a></span><span class="op">(</span><span class="op">)</span> <span class="co"># import UI</span></span></span>
<span class="r-in"><span><span class="op">)</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="va">server</span> <span class="op">&lt;-</span> <span class="kw">function</span><span class="op">(</span><span class="va">input</span>, <span class="va">output</span><span class="op">)</span><span class="op">{</span></span></span>
<span class="r-in"><span>  <span class="va">f</span> <span class="op">&lt;-</span> <span class="va">FirebaseUI</span><span class="op">$</span></span></span>
<span class="r-in"><span>    <span class="fu">new</span><span class="op">(</span><span class="op">)</span><span class="op">$</span> <span class="co"># instantiate</span></span></span>
<span class="r-in"><span>    <span class="fu">set_providers</span><span class="op">(</span> <span class="co"># define providers</span></span></span>
<span class="r-in"><span>      email <span class="op">=</span> <span class="cn">TRUE</span>, </span></span>
<span class="r-in"><span>      google <span class="op">=</span> <span class="cn">TRUE</span></span></span>
<span class="r-in"><span>    <span class="op">)</span></span></span>
<span class="r-in"><span><span class="op">}</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu"><a href="https://rdrr.io/pkg/shiny/man/shinyApp.html" class="external-link">shinyApp</a></span><span class="op">(</span><span class="va">ui</span>, <span class="va">server</span><span class="op">)</span></span></span>
<span class="r-in"><span></span></span>
</code></pre></div>
    </div>
  </div>
  <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
    <nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
    </nav></div>
</div>


      <footer><div class="copyright">
  <p></p><p>Developed by John Coene.</p>
</div>

<div class="pkgdown">
  <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
</div>

      </footer></div>

  


  

  </body></html>

