Packages

feedlex

0.0.1
0.0.1

Feedly RSS reader client for Elixir (elixir-lang). Partial but functional implementation. For now it covers the following Feedly APIs: * authentication; * feed; * stream; * subscription.

HexDocs

Current section

Files

Jump to
Readme
1 Version
2 Dependencies
Dependants
Files
Activity
feedlex doc Feedlex.Auth.html
Raw

doc/Feedlex.Auth.html 

<!DOCTYPE html>

<html>

  <head>

    <title>Feedlex.Auth</title>

    <meta charset="utf-8" />

    <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />

    <link rel="stylesheet" href="css/elixir.css" type="text/css" media="screen" charset="utf-8" />

    <script type="text/javascript" charset="utf-8">

      relpath = '';

      if (relpath != '') relpath += '/';

    </script>



    <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

    <script type="text/javascript" charset="utf-8" src="js/app.js"></script>

    <script type="text/javascript" charset="utf-8" src="js/highlight.pack.js"></script>

    <script type="text/javascript" charset="utf-8">

      hljs.initHighlightingOnLoad();

      hljs.configure({languages: []}); //disable autodetect

    </script>

  </head>



  <body>

    <script type="text/javascript" charset="utf-8">

      if (window.top.frames.main) document.body.className = 'frames';

    </script>



    <section id="content">

      <div class="breadcrumbs">feedlex v0.0.1 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="Feedlex.html">Feedlex</a> &rarr; <a href="Feedlex.Auth.html">Auth</a></div>

      <h1>

        Feedlex.Auth

        

      </h1>



      <ul class="summary_links">

        

          <li><a href="#summary">Summary</a></li>

        

        

        

          <li><a href="#functions_details">Functions</a></li>

        

        

        

      </ul>



      

        <section id="moduledoc" class="docstring">

          <p>Exposes authentication and authorization functions into the Feedly API

<a href="https://developer.feedly.com/v3/auth/">https://developer.feedly.com/v3/auth/</a></p>



        </section>

      



      



      

        <h2 id="summary">Summary<span class="detail_header_links"><a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></span></h2>

        <table class="summary">

          <tr>

  <td class="summary_signature"><a href="#access_token/1">access_token(opts \\ %{})</a></td>

  

    <td class="summary_synopsis"><p>Exchanges the received Feedly authentication code for a refresh token and

an access token</p>

</td>

  

</tr>

<tr>

  <td class="summary_signature"><a href="#authenticate_uri/1">authenticate_uri(opts \\ %{})</a></td>

  

    <td class="summary_synopsis"><p>Returns the complete URI for beginning the authentication and authorization

process in the browser.

The client should redirect the user to the returned URI</p>

</td>

  

</tr>

<tr>

  <td class="summary_signature"><a href="#refresh_access_token/1">refresh_access_token(opts \\ %{})</a></td>

  

    <td class="summary_synopsis"><p>Uses the refresh token to ask for a new access token</p>

</td>

  

</tr>

<tr>

  <td class="summary_signature"><a href="#revoke_token/1">revoke_token(opts \\ %{})</a></td>

  

    <td class="summary_synopsis"><p>Logoff - revokes the access and refresh tokens</p>

</td>

  

</tr>



        </table>

      



      



      

        <section id="functions_details" class="details_list">

          <h2>Functions</h2>

          <section class="detail">

  <div class="detail_header" id="access_token/1">

    <span class="signature"><strong>access_token(opts \\ %{})</strong></span>

    <div class="detail_header_links">

      <span class="detail_type">(function)</span>

      <a href="#access_token/1" class="detail_link" title="Link to this function">#</a>

      <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>

    </div>

  </div>

  

  <section class="docstring">

    <p>Exchanges the received Feedly authentication code for a refresh token and

an access token</p>



  </section>

  

</section>

<section class="detail">

  <div class="detail_header" id="authenticate_uri/1">

    <span class="signature"><strong>authenticate_uri(opts \\ %{})</strong></span>

    <div class="detail_header_links">

      <span class="detail_type">(function)</span>

      <a href="#authenticate_uri/1" class="detail_link" title="Link to this function">#</a>

      <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>

    </div>

  </div>

  

  <section class="docstring">

    <p>Returns the complete URI for beginning the authentication and authorization

process in the browser.

The client should redirect the user to the returned URI</p>



  </section>

  

</section>

<section class="detail">

  <div class="detail_header" id="refresh_access_token/1">

    <span class="signature"><strong>refresh_access_token(opts \\ %{})</strong></span>

    <div class="detail_header_links">

      <span class="detail_type">(function)</span>

      <a href="#refresh_access_token/1" class="detail_link" title="Link to this function">#</a>

      <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>

    </div>

  </div>

  

  <section class="docstring">

    <p>Uses the refresh token to ask for a new access token</p>



  </section>

  

</section>

<section class="detail">

  <div class="detail_header" id="revoke_token/1">

    <span class="signature"><strong>revoke_token(opts \\ %{})</strong></span>

    <div class="detail_header_links">

      <span class="detail_type">(function)</span>

      <a href="#revoke_token/1" class="detail_link" title="Link to this function">#</a>

      <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>

    </div>

  </div>

  

  <section class="docstring">

    <p>  Logoff - revokes the access and refresh tokens</p>



  </section>

  

</section>



        </section>

      



      



      

    </section>

  </body>

</html>