Packages
indieweb
0.0.41
0.0.66
0.0.65
0.0.64
0.0.63
0.0.62
0.0.61
0.0.60
0.0.59
0.0.58
0.0.56
0.0.55
0.0.54
0.0.53
0.0.51
0.0.50
0.0.49
0.0.48
0.0.47
0.0.46
0.0.42
0.0.41
0.0.40
0.0.39
0.0.38
0.0.37
0.0.36
0.0.35
0.0.34
0.0.33
0.0.32
0.0.31
0.0.30
0.0.29
0.0.28
0.0.27
0.0.26
0.0.25
0.0.24
0.0.23
0.0.22
0.0.21
0.0.20
0.0.19
0.0.17
0.0.16
0.0.15
0.0.14
0.0.13
0.0.12
0.0.10
0.0.9
0.0.8
0.0.7
0.0.6
0.0.5
0.0.3
0.0.2
0.0.1
Collection of common IndieWeb utilites like authorship resolution, Webmention, post type discovery and IndieAuth.
Current section
Files
Jump to
Current section
Files
priv/dist/doc/IndieWeb.Auth.Adapter.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.19.3">
<title>IndieWeb.Auth.Adapter — IndieWeb v0.0.31</title>
<link rel="stylesheet" href="dist/html-399e30b9b028e3059575.css" />
<link rel="canonical" href="https://hexdocs.pm/indieweb/IndieWeb.Auth.Adapter.html" />
<script src="dist/sidebar_items-23b3c70799.js"></script>
<script async src="dist/html-399e30b9b028e3059575.js"></script>
</head>
<body data-type="modules">
<script>try { if(localStorage.getItem('night-mode')) document.body.className += ' night-mode'; } catch (e) { }</script>
<div class="main">
<button class="sidebar-button sidebar-toggle">
<span class="icon-menu" aria-hidden="true"></span>
<span class="sr-only">Toggle Sidebar</span>
</button>
<button class="sidebar-button night-mode-toggle">
<span class="icon-theme" aria-hidden="true"></span>
<span class="sr-only">Toggle Theme</span>
</button>
<section class="sidebar">
<a href="https://indieweb.org/" class="sidebar-projectLink">
<div class="sidebar-projectDetails">
<h1 class="sidebar-projectName">
IndieWeb </h1>
<h2 class="sidebar-projectVersion">
v0.0.31
</h2>
</div>
<img src="assets/logo.png" alt="IndieWeb" class="sidebar-projectImage">
</a>
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button">
<span class="icon-search" aria-hidden="true"></span>
</button>
<input name="q" type="text" id="search-list" class="search-input" placeholder="Search" aria-label="Search" autocomplete="off" />
</form>
<ul class="sidebar-listNav">
<li><a id="extras-list" href="#full-list">Pages</a></li>
<li><a id="modules-list" href="#full-list">Modules</a></li>
</ul>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<small class="visible-xs">IndieWeb v0.0.31</small>
IndieWeb.Auth.Adapter <small>behaviour</small>
<a href="https://git.jacky.wtf/indieweb/elixir" title="View Source" class="view-source" rel="help">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</h1>
<section id="moduledoc">
<p>Provides an abstraction regarding stateful actions in IndieAuth.</p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Summary
</h1>
<div class="summary-callbacks summary">
<h2>
<a href="#callbacks">Callbacks</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:code_destroy/3">code_destroy(client_id, redirect_uri, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:code_generate/3">code_generate(client_id, redirect_uri, data)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:code_persist/4">code_persist(code, client_id, redirect_uri, args)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:code_verify/4">code_verify(binary, binary, binary, map)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:scope_get/1">scope_get(code)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:scope_persist/2">scope_persist(code, scope)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:token_generate/2">token_generate(binary, binary)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:token_info/1">token_info(binary)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:token_revoke/1">token_revoke(binary)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#c:valid_user?/1">valid_user?(uri)</a>
</div>
</div>
</div>
</section>
<section id="callbacks" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#callbacks">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Callbacks </h1>
<div class="callbacks-list">
<section class="detail" id="c:code_destroy/3">
<div class="detail-header">
<a href="#c:code_destroy/3" class="detail-link" title="Link to this callback">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature">code_destroy(client_id, redirect_uri, args)</span>
<a href="https://git.jacky.wtf/indieweb/elixir" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
<div class="specs">
<pre>code_destroy(client_id :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(), redirect_uri :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(), args :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()) ::
:ok</pre>
</div>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="c:code_generate/3">
<div class="detail-header">
<a href="#c:code_generate/3" class="detail-link" title="Link to this callback">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature">code_generate(client_id, redirect_uri, data)</span>
<a href="https://git.jacky.wtf/indieweb/elixir" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
<div class="specs">
<pre>code_generate(client_id :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(), redirect_uri :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(), data :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()) ::
<a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>()</pre>
</div>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="c:code_persist/4">
<div class="detail-header">
<a href="#c:code_persist/4" class="detail-link" title="Link to this callback">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature">code_persist(code, client_id, redirect_uri, args)</span>
<a href="https://git.jacky.wtf/indieweb/elixir" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
<div class="specs">
<pre>code_persist(
code :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(),
client_id :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(),
redirect_uri :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(),
args :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()
) :: :ok | {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()}</pre>
</div>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="c:code_verify/4">
<div class="detail-header">
<a href="#c:code_verify/4" class="detail-link" title="Link to this callback">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature">code_verify(binary, binary, binary, map)</span>
<a href="https://git.jacky.wtf/indieweb/elixir" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
<div class="specs">
<pre>code_verify(<a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()) :: :ok | {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()}</pre>
</div>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="c:scope_get/1">
<div class="detail-header">
<a href="#c:scope_get/1" class="detail-link" title="Link to this callback">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature">scope_get(code)</span>
<a href="https://git.jacky.wtf/indieweb/elixir" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
<div class="specs">
<pre>scope_get(code :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>() | nil</pre>
</div>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="c:scope_persist/2">
<div class="detail-header">
<a href="#c:scope_persist/2" class="detail-link" title="Link to this callback">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature">scope_persist(code, scope)</span>
<a href="https://git.jacky.wtf/indieweb/elixir" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
<div class="specs">
<pre>scope_persist(code :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(), scope :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>()) :: :ok | {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()}</pre>
</div>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="c:token_generate/2">
<div class="detail-header">
<a href="#c:token_generate/2" class="detail-link" title="Link to this callback">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature">token_generate(binary, binary)</span>
<a href="https://git.jacky.wtf/indieweb/elixir" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
<div class="specs">
<pre>token_generate(<a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>()</pre>
</div>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="c:token_info/1">
<div class="detail-header">
<a href="#c:token_info/1" class="detail-link" title="Link to this callback">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature">token_info(binary)</span>
<a href="https://git.jacky.wtf/indieweb/elixir" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
<div class="specs">
<pre>token_info(<a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>()) :: nil | {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()} | <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()</pre>
</div>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="c:token_revoke/1">
<div class="detail-header">
<a href="#c:token_revoke/1" class="detail-link" title="Link to this callback">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature">token_revoke(binary)</span>
<a href="https://git.jacky.wtf/indieweb/elixir" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
<div class="specs">
<pre>token_revoke(<a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>()) :: :ok</pre>
</div>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="c:valid_user?/1">
<div class="detail-header">
<a href="#c:valid_user?/1" class="detail-link" title="Link to this callback">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this callback</span>
</a>
<h1 class="signature">valid_user?(uri)</span>
<a href="https://git.jacky.wtf/indieweb/elixir" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
<div class="specs">
<pre>valid_user?(uri :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>()</pre>
</div>
</div>
<section class="docstring">
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener">ExDoc</a> (v0.19.3),
</span>
<span class="line">
designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" rel="noopener" title="@dignifiedquire">Friedel Ziegelmayer</a>.
</span>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>