<!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>Firebase Authentication — FirebaseAuth • 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="Firebase Authentication — FirebaseAuth"><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>Firebase Authentication</h1>
    <small class="dont-index">Source: <a href="https://github.com/JohnCoene/firebase/blob/HEAD/R/class-auth.R" class="external-link"><code>R/class-auth.R</code></a></small>
    <div class="hidden name"><code>FirebaseAuth.Rd</code></div>
    </div>

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


    <div id="super-class">
    <h2>Super class</h2>
    <p><code><a href="Firebase.html">firebase::Firebase</a></code> -&gt; <code>FirebaseAuth</code></p>
    </div>
    <div id="active-bindings">
    <h2>Active bindings</h2>
    <p></p><div class="r6-active-bindings"><dl><dt><code>signed_in</code></dt>
<dd><p>Read the signed in user.</p></dd>


<dt><code>signed_up</code></dt>
<dd><p>Read the signed in user.</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-FirebaseAuth-new"><code>FirebaseAuth$new()</code></a></p></li>
<li><p><a href="#method-FirebaseAuth-print"><code>FirebaseAuth$print()</code></a></p></li>
<li><p><a href="#method-FirebaseAuth-sign_out"><code>FirebaseAuth$sign_out()</code></a></p></li>
<li><p><a href="#method-FirebaseAuth-get_sign_out"><code>FirebaseAuth$get_sign_out()</code></a></p></li>
<li><p><a href="#method-FirebaseAuth-get_signed_in"><code>FirebaseAuth$get_signed_in()</code></a></p></li>
<li><p><a href="#method-FirebaseAuth-get_signed_up"><code>FirebaseAuth$get_signed_up()</code></a></p></li>
<li><p><a href="#method-FirebaseAuth-is_signed_in"><code>FirebaseAuth$is_signed_in()</code></a></p></li>
<li><p><a href="#method-FirebaseAuth-req_sign_in"><code>FirebaseAuth$req_sign_in()</code></a></p></li>
<li><p><a href="#method-FirebaseAuth-req_sign_out"><code>FirebaseAuth$req_sign_out()</code></a></p></li>
<li><p><a href="#method-FirebaseAuth-set_language_code"><code>FirebaseAuth$set_language_code()</code></a></p></li>
<li><p><a href="#method-FirebaseAuth-delete_user"><code>FirebaseAuth$delete_user()</code></a></p></li>
<li><p><a href="#method-FirebaseAuth-get_delete_user"><code>FirebaseAuth$get_delete_user()</code></a></p></li>
<li><p><a href="#method-FirebaseAuth-expose_auth"><code>FirebaseAuth$expose_auth()</code></a></p></li>
<li><p><a href="#method-FirebaseAuth-get_access_token"><code>FirebaseAuth$get_access_token()</code></a></p></li>
<li><p><a href="#method-FirebaseAuth-clear"><code>FirebaseAuth$clear()</code></a></p></li>
<li><p><a href="#method-FirebaseAuth-request_id_token"><code>FirebaseAuth$request_id_token()</code></a></p></li>
<li><p><a href="#method-FirebaseAuth-get_id_token"><code>FirebaseAuth$get_id_token()</code></a></p></li>
<li><p><a href="#method-FirebaseAuth-clone"><code>FirebaseAuth$clone()</code></a></p></li>
</ul></div><p><details open><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>
</ul></details></p><hr><a id="method-FirebaseAuth-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/FirebaseAuth.html">FirebaseAuth</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>Initialise firebase authentication</p>
</div>


</div><p></p><hr><a id="method-FirebaseAuth-print"></a><div class="section">
<h3 id="method-print-">Method <code><a href="https://rdrr.io/r/base/print.html" class="external-link">print()</a></code><a class="anchor" aria-label="anchor" href="#method-print-"></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">FirebaseAuth</span><span class="op">$</span><span class="fu">print</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="details-1">Details<a class="anchor" aria-label="anchor" href="#details-1"></a></h4>
<p>Print the class</p>
</div>


</div><p></p><hr><a id="method-FirebaseAuth-sign_out"></a><div class="section">
<h3 id="method-sign-out-">Method <code>sign_out()</code><a class="anchor" aria-label="anchor" href="#method-sign-out-"></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">FirebaseAuth</span><span class="op">$</span><span class="fu">sign_out</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="details-2">Details<a class="anchor" aria-label="anchor" href="#details-2"></a></h4>
<p>Signs out user</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-FirebaseAuth-get_sign_out"></a><div class="section">
<h3 id="method-get-sign-out-">Method <code>get_sign_out()</code><a class="anchor" aria-label="anchor" href="#method-get-sign-out-"></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">FirebaseAuth</span><span class="op">$</span><span class="fu">get_sign_out</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="details-3">Details<a class="anchor" aria-label="anchor" href="#details-3"></a></h4>
<p>Get signed out results</p>
</div>

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

</div><p></p><hr><a id="method-FirebaseAuth-get_signed_in"></a><div class="section">
<h3 id="method-get-signed-in-">Method <code>get_signed_in()</code><a class="anchor" aria-label="anchor" href="#method-get-signed-in-"></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">FirebaseAuth</span><span class="op">$</span><span class="fu">get_signed_in</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="details-4">Details<a class="anchor" aria-label="anchor" href="#details-4"></a></h4>
<p>Signed in user details triggered when auth states changes</p>
</div>

<div class="section">
<h4 id="returns-2">Returns<a class="anchor" aria-label="anchor" href="#returns-2"></a></h4>
<p>A list of length 2 containing <code>success</code> a boolean
indicating wherther signing in was successful and <code>response</code>
containing the user object or <code>NULL</code> if signing in failed.</p>
</div>

</div><p></p><hr><a id="method-FirebaseAuth-get_signed_up"></a><div class="section">
<h3 id="method-get-signed-up-">Method <code>get_signed_up()</code><a class="anchor" aria-label="anchor" href="#method-get-signed-up-"></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">FirebaseAuth</span><span class="op">$</span><span class="fu">get_signed_up</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="details-5">Details<a class="anchor" aria-label="anchor" href="#details-5"></a></h4>
<p>Get results of a sign up</p>
</div>

<div class="section">
<h4 id="returns-3">Returns<a class="anchor" aria-label="anchor" href="#returns-3"></a></h4>
<p>A list of length 2 containing <code>success</code> a boolean
indicating wherther signing in was successful and <code>response</code>
containing the user object or <code>NULL</code> if signing in failed.</p>
</div>

</div><p></p><hr><a id="method-FirebaseAuth-is_signed_in"></a><div class="section">
<h3 id="method-is-signed-in-">Method <code>is_signed_in()</code><a class="anchor" aria-label="anchor" href="#method-is-signed-in-"></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">FirebaseAuth</span><span class="op">$</span><span class="fu">is_signed_in</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>Check whether use is signed in</p>
</div>

<div class="section">
<h4 id="returns-4">Returns<a class="anchor" aria-label="anchor" href="#returns-4"></a></h4>
<p>A boolean indicating whether user has successfully signed in.</p>
</div>

</div><p></p><hr><a id="method-FirebaseAuth-req_sign_in"></a><div class="section">
<h3 id="method-req-sign-in-">Method <code>req_sign_in()</code><a class="anchor" aria-label="anchor" href="#method-req-sign-in-"></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">FirebaseAuth</span><span class="op">$</span><span class="fu">req_sign_in</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>Makes Shiny output, observer, or reactive require the user to be signed in</p>
</div>


</div><p></p><hr><a id="method-FirebaseAuth-req_sign_out"></a><div class="section">
<h3 id="method-req-sign-out-">Method <code>req_sign_out()</code><a class="anchor" aria-label="anchor" href="#method-req-sign-out-"></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">FirebaseAuth</span><span class="op">$</span><span class="fu">req_sign_out</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>Makes Shiny output, observer, or reactive require the user to be signed out</p>
</div>


</div><p></p><hr><a id="method-FirebaseAuth-set_language_code"></a><div class="section">
<h3 id="method-set-language-code-">Method <code>set_language_code()</code><a class="anchor" aria-label="anchor" href="#method-set-language-code-"></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">FirebaseAuth</span><span class="op">$</span><span class="fu">set_language_code</span><span class="op">(</span><span class="va">code</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>code</code></dt>
<dd><p>iso639-1 language code.</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 language code for auth provider</p>
</div>

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

</div><p></p><hr><a id="method-FirebaseAuth-delete_user"></a><div class="section">
<h3 id="method-delete-user-">Method <code>delete_user()</code><a class="anchor" aria-label="anchor" href="#method-delete-user-"></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">FirebaseAuth</span><span class="op">$</span><span class="fu">delete_user</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>Delete the user</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-FirebaseAuth-get_delete_user"></a><div class="section">
<h3 id="method-get-delete-user-">Method <code>get_delete_user()</code><a class="anchor" aria-label="anchor" href="#method-get-delete-user-"></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">FirebaseAuth</span><span class="op">$</span><span class="fu">get_delete_user</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="details-11">Details<a class="anchor" aria-label="anchor" href="#details-11"></a></h4>
<p>Get result of user deletion</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 wherther deletion was successful and <code>response</code>
containing either <code>successful</code> string or the error if signing in failed.</p>
</div>

</div><p></p><hr><a id="method-FirebaseAuth-expose_auth"></a><div class="section">
<h3 id="method-expose-auth-">Method <code>expose_auth()</code><a class="anchor" aria-label="anchor" href="#method-expose-auth-"></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">FirebaseAuth</span><span class="op">$</span><span class="fu">expose_auth</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>Expose Auth</p>
<p>Expose the <code>firebaseAuth</code> object the product of the authentication
attaching it to the <code>window</code>: access it with <code>window.firebaseAuth</code>.</p>
</div>


</div><p></p><hr><a id="method-FirebaseAuth-get_access_token"></a><div class="section">
<h3 id="method-get-access-token-">Method <code>get_access_token()</code><a class="anchor" aria-label="anchor" href="#method-get-access-token-"></a></h3>

<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">FirebaseAuth</span><span class="op">$</span><span class="fu">get_access_token</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div>
</div>

<div class="section">
<h4 id="details-13">Details<a class="anchor" aria-label="anchor" href="#details-13"></a></h4>
<p>Get user access token</p>
</div>

<div class="section">
<h4 id="returns-8">Returns<a class="anchor" aria-label="anchor" href="#returns-8"></a></h4>
<p>User's access token</p>
</div>

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

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

<div class="section">
<h4 id="details-14">Details<a class="anchor" aria-label="anchor" href="#details-14"></a></h4>
<p>Clear user session</p>
<p>This clears the login internally and will retrigger a JWT
token check, only useful if you are running really long
sessions.</p>
</div>


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

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

<div class="section">
<h4 id="details-15">Details<a class="anchor" aria-label="anchor" href="#details-15"></a></h4>
<p>Request the users' ID Token</p>
<p>Used to retrieved the user's ID token useful to connect
with other Google APIs and make request on the user's behalf.
This executes the request for the id token, this request
can only be made once the user is signed in.</p>
<p>The actual id token is obtained with the <code>get_id_token</code>
method.</p>
</div>


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

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

<div class="section">
<h4 id="details-16">Details<a class="anchor" aria-label="anchor" href="#details-16"></a></h4>
<p>Retrieve the users' ID Token</p>
<p>Also see <code>request_id_token</code>.</p>
</div>

<div class="section">
<h4 id="returns-9">Returns<a class="anchor" aria-label="anchor" href="#returns-9"></a></h4>
<p>the id token (invisibly).</p>
</div>

</div><p></p><hr><a id="method-FirebaseAuth-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-17">Usage<a class="anchor" aria-label="anchor" href="#usage-17"></a></h4>
<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">FirebaseAuth</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-2">Arguments<a class="anchor" aria-label="anchor" href="#arguments-2"></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>
  <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>

