Packages

indieweb

0.0.35
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.

HexDocs

Current section

Files

Jump to
Readme
58 Versions
2 Dependencies
Dependants
Files
Activity
indieweb priv dist doc api-reference.html
Raw

priv/dist/doc/api-reference.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>API Reference — IndieWeb v0.0.31</title>

    <link rel="stylesheet" href="dist/html-399e30b9b028e3059575.css" />

      <link rel="canonical" href="https://hexdocs.pm/indieweb/api-reference.html" />

    <script src="dist/sidebar_items-23b3c70799.js"></script>

    <script async src="dist/html-399e30b9b028e3059575.js"></script>

    

  </head>

  <body data-type="extras">

    <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>

  API Reference

</h1>



  <section class="details-list">

    <h2 id="modules" class="section-heading">

  <a href="#modules" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>

  Modules

</h2>



    <div class="summary">

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.html">IndieWeb</a>

  </div>

    <div class="summary-synopsis"><p>The IndieWeb is a people-focused alternative to the &quot;corporate web&quot;</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Auth.html">IndieWeb.Auth</a>

  </div>

    <div class="summary-synopsis"><p>Provides logic for handling <a href="https://indieauth.spec.indieweb.org">IndieAuth</a> interactions</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Auth.Adapter.html">IndieWeb.Auth.Adapter</a>

  </div>

    <div class="summary-synopsis"><p>Provides an abstraction regarding stateful actions in IndieAuth</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Auth.Adapters.Default.html">IndieWeb.Auth.Adapters.Default</a>

  </div>

    <div class="summary-synopsis"><p>Provides a default implementation of IndieAuth stateful activity</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Auth.Code.html">IndieWeb.Auth.Code</a>

  </div>

    <div class="summary-synopsis"><p>Handles authentication codes for the IndieAuth flow</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Auth.Scope.html">IndieWeb.Auth.Scope</a>

  </div>

    <div class="summary-synopsis"><p>Handles scope information and referencing for the IndieAuth flow</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Auth.Token.html">IndieWeb.Auth.Token</a>

  </div>

    <div class="summary-synopsis"><p>Manages the token lifecycle for IndieAuth</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Cache.html">IndieWeb.Cache</a>

  </div>

    <div class="summary-synopsis"><p>Provides the generic interface for handling caching logic in Koype</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Cache.Adapter.html">IndieWeb.Cache.Adapter</a>

  </div>

    <div class="summary-synopsis"><p>This provides the interface that adapters should implement if they&#39;d like

IndieWeb to use it for caching values. Check <a href="IndieWeb.html"><code class="inline">IndieWeb</code></a> for more information

and <a href="IndieWeb.Cache.Adapters.Cachex.html"><code class="inline">IndieWeb.Cache.Adapters.Cachex</code></a> for more information</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Cache.Adapters.Cachex.html">IndieWeb.Cache.Adapters.Cachex</a>

  </div>

    <div class="summary-synopsis"><p>Wraps logic for using <a href="https://hexdocs.pm/cachex/3.1.3/Cachex.html"><code class="inline">Cachex</code></a> as the caching mechanism in <a href="IndieWeb.html"><code class="inline">IndieWeb</code></a></p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.HCard.html">IndieWeb.HCard</a>

  </div>

    <div class="summary-synopsis"><p>Extracts the representative <a href="http://indieweb.org/h-card">h-card</a> of the provided URI</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Http.html">IndieWeb.Http</a>

  </div>

    <div class="summary-synopsis"><p>Provides a facade for handling HTTP actions</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Http.Adapter.html">IndieWeb.Http.Adapter</a>

  </div>

    <div class="summary-synopsis"><p>Provides an abstraction on handling HTTP actions</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Http.Adapters.HTTPotion.html">IndieWeb.Http.Adapters.HTTPotion</a>

  </div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Http.Error.html">IndieWeb.Http.Error</a>

  </div>

    <div class="summary-synopsis"><p>Defines an error obtained when making a network request</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Http.Response.html">IndieWeb.Http.Response</a>

  </div>

    <div class="summary-synopsis"><p>Defines a response obtained when making a network request</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.LinkRel.html">IndieWeb.LinkRel</a>

  </div>

    <div class="summary-synopsis"><p>Provides a normalizer for link information</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Post.html">IndieWeb.Post</a>

  </div>

    <div class="summary-synopsis"><p>Post-specific logic for the IndieWeb</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Webmention.html">IndieWeb.Webmention</a>

  </div>

    <div class="summary-synopsis"><p>Handles Webmention interoperability for a site</p>

</div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Webmention.SendResponse.html">IndieWeb.Webmention.SendResponse</a>

  </div>

</div>

<div class="summary-row">

  <div class="summary-signature">

    <a href="IndieWeb.Webmention.URIAdapter.html">IndieWeb.Webmention.URIAdapter</a>

  </div>

    <div class="summary-synopsis"><p>Facility for handling URI generation of Webmention logic</p>

</div>

</div>

    </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>