Packages

pocketex

0.1.0
0.1.0

Pocketex is an Elixir client for the Pocket read later service (getpocket.com)

HexDocs

Current section

Files

Jump to
Readme
1 Version
2 Dependencies
Dependants
Files
Activity
pocketex doc Pocketex.Auth.html
Raw

doc/Pocketex.Auth.html 

<!DOCTYPE html>

<html>

  <head>

    <title>Pocketex.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">pocketex v0.1.0 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="Pocketex.html">Pocketex</a> &rarr; <a href="Pocketex.Auth.html">Auth</a></div>

      <h1>

        Pocketex.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>Wrapper functions around the Pocket auth API</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="#authorize/2">authorize(consumer_key, request_token)</a></td>

  

    <td class="summary_synopsis"><p>Makes an authorization request to convert the request token into a Pocket access token</p>

</td>

  

</tr>

<tr>

  <td class="summary_signature"><a href="#autorization_uri/2">autorization_uri(request_token, callback_uri)</a></td>

  

    <td class="summary_synopsis"><p>Returns the authorization URI for the Pocket API

The web client integrating this wrapper needs to redirect there</p>

</td>

  

</tr>

<tr>

  <td class="summary_signature"><a href="#get_request_token/2">get_request_token(consumer_key, redirect_uri)</a></td>

  

    <td class="summary_synopsis"><p>Obtain a request token.

To begin the Pocket authorization process, the application must obtain a

request token from the Pocket servers by making a POST request</p>

</td>

  

</tr>



        </table>

      



      



      

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

          <h2>Functions</h2>

          <section class="detail">

  <div class="detail_header" id="authorize/2">

    <span class="signature"><strong>authorize(consumer_key, request_token)</strong></span>

    <div class="detail_header_links">

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

      <a href="#authorize/2" 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>Makes an authorization request to convert the request token into a Pocket access token.</p>



  </section>

  

</section>

<section class="detail">

  <div class="detail_header" id="autorization_uri/2">

    <span class="signature"><strong>autorization_uri(request_token, callback_uri)</strong></span>

    <div class="detail_header_links">

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

      <a href="#autorization_uri/2" 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 authorization URI for the Pocket API

The web client integrating this wrapper needs to redirect there</p>



  </section>

  

</section>

<section class="detail">

  <div class="detail_header" id="get_request_token/2">

    <span class="signature"><strong>get_request_token(consumer_key, redirect_uri)</strong></span>

    <div class="detail_header_links">

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

      <a href="#get_request_token/2" 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>Obtain a request token.

To begin the Pocket authorization process, the application must obtain a

request token from the Pocket servers by making a POST request.</p>



  </section>

  

</section>



        </section>

      



      



      

    </section>

  </body>

</html>