doc/JavaDoc/ch/epfl/sdp/peakar/user/services/AuthService.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_242-release) on Fri Jun 04 18:15:41 CEST 2021 -->
<title>AuthService</title>
<meta name="date" content="2021-06-04">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AuthService";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":17,"i5":6,"i6":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../ch/epfl/sdp/peakar/user/services/AuthProvider.html" title="enum in ch.epfl.sdp.peakar.user.services"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../../ch/epfl/sdp/peakar/user/services/FirebaseAuthService.html" title="class in ch.epfl.sdp.peakar.user.services"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?ch/epfl/sdp/peakar/user/services/AuthService.html" target="_top">Frames</a></li>
<li><a href="AuthService.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">ch.epfl.sdp.peakar.user.services</div>
<h2 title="Interface AuthService" class="title">Interface AuthService</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../ch/epfl/sdp/peakar/user/services/FirebaseAuthService.html" title="class in ch.epfl.sdp.peakar.user.services">FirebaseAuthService</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">AuthService</span></pre>
<div class="block">This class represents an auth service.
Extend this class with the specific implementation from a provider.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../../ch/epfl/sdp/peakar/general/remote/RemoteOutcome.html" title="enum in ch.epfl.sdp.peakar.general.remote">RemoteOutcome</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/services/AuthService.html#authAnonymously--">authAnonymously</a></span>()</code>
<div class="block">Perform the authentication for an anonymous user.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../ch/epfl/sdp/peakar/general/remote/RemoteOutcome.html" title="enum in ch.epfl.sdp.peakar.general.remote">RemoteOutcome</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/services/AuthService.html#authWithProvider-ch.epfl.sdp.peakar.user.services.AuthProvider-java.lang.String-">authWithProvider</a></span>(<a href="../../../../../../ch/epfl/sdp/peakar/user/services/AuthProvider.html" title="enum in ch.epfl.sdp.peakar.user.services">AuthProvider</a> authProvider,
java.lang.String token)</code>
<div class="block">Perform the authentication with a certain provider.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../ch/epfl/sdp/peakar/user/services/AuthAccount.html" title="class in ch.epfl.sdp.peakar.user.services">AuthAccount</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/services/AuthService.html#getAuthAccount--">getAuthAccount</a></span>()</code>
<div class="block">Get the authenticated account or a null reference if no auth has been performed.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/services/AuthService.html#getID--">getID</a></span>()</code>
<div class="block">Retrieve the ID of the authenticated account, or "null" if no auth has been performed.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../ch/epfl/sdp/peakar/user/services/AuthService.html" title="interface in ch.epfl.sdp.peakar.user.services">AuthService</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/services/AuthService.html#getInstance--">getInstance</a></span>()</code>
<div class="block">Get the reference to the Authentication object.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>android.net.Uri</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/services/AuthService.html#getPhotoUrl--">getPhotoUrl</a></span>()</code>
<div class="block">Retrieve the photo url of the authenticated account, or Uri.EMPTY if no auth has been performed.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../ch/epfl/sdp/peakar/user/services/AuthService.html#signOut-android.content.Context-">signOut</a></span>(android.content.Context context)</code>
<div class="block">Sign the current authenticated user out, or do nothing if no auth has been performed.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInstance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>static <a href="../../../../../../ch/epfl/sdp/peakar/user/services/AuthService.html" title="interface in ch.epfl.sdp.peakar.user.services">AuthService</a> getInstance()</pre>
<div class="block">Get the reference to the Authentication object.</div>
</li>
</ul>
<a name="authWithProvider-ch.epfl.sdp.peakar.user.services.AuthProvider-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>authWithProvider</h4>
<pre><a href="../../../../../../ch/epfl/sdp/peakar/general/remote/RemoteOutcome.html" title="enum in ch.epfl.sdp.peakar.general.remote">RemoteOutcome</a> authWithProvider(<a href="../../../../../../ch/epfl/sdp/peakar/user/services/AuthProvider.html" title="enum in ch.epfl.sdp.peakar.user.services">AuthProvider</a> authProvider,
java.lang.String token)</pre>
<div class="block">Perform the authentication with a certain provider. This method blocks the caller until the outcome is obtained.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authProvider</code> - provider for the authentication.</dd>
<dd><code>token</code> - token from the provider.</dd>
</dl>
</li>
</ul>
<a name="authAnonymously--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>authAnonymously</h4>
<pre><a href="../../../../../../ch/epfl/sdp/peakar/general/remote/RemoteOutcome.html" title="enum in ch.epfl.sdp.peakar.general.remote">RemoteOutcome</a> authAnonymously()</pre>
<div class="block">Perform the authentication for an anonymous user. This method blocks the caller until the outcome is obtained.</div>
</li>
</ul>
<a name="getAuthAccount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuthAccount</h4>
<pre><a href="../../../../../../ch/epfl/sdp/peakar/user/services/AuthAccount.html" title="class in ch.epfl.sdp.peakar.user.services">AuthAccount</a> getAuthAccount()</pre>
<div class="block">Get the authenticated account or a null reference if no auth has been performed.</div>
</li>
</ul>
<a name="signOut-android.content.Context-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>signOut</h4>
<pre>void signOut(android.content.Context context)</pre>
<div class="block">Sign the current authenticated user out, or do nothing if no auth has been performed. This method blocks the caller until the sign out is over.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - context of the application</dd>
</dl>
</li>
</ul>
<a name="getID--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getID</h4>
<pre>java.lang.String getID()</pre>
<div class="block">Retrieve the ID of the authenticated account, or "null" if no auth has been performed.</div>
</li>
</ul>
<a name="getPhotoUrl--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPhotoUrl</h4>
<pre>android.net.Uri getPhotoUrl()</pre>
<div class="block">Retrieve the photo url of the authenticated account, or Uri.EMPTY if no auth has been performed.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../ch/epfl/sdp/peakar/user/services/AuthProvider.html" title="enum in ch.epfl.sdp.peakar.user.services"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../../ch/epfl/sdp/peakar/user/services/FirebaseAuthService.html" title="class in ch.epfl.sdp.peakar.user.services"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?ch/epfl/sdp/peakar/user/services/AuthService.html" target="_top">Frames</a></li>
<li><a href="AuthService.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>