Packages

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

Current section

Files

Jump to
pocketex doc overview.html
Raw

doc/overview.html

<!DOCTYPE html>
<html>
<head>
<title>Overview</title>
<meta charset="utf-8">
<link rel="stylesheet" href="css/style.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>
</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></div>
<h1>pocketex v0.1.0</h1>
<ul class="summary_links">
<li><a href="#modules_summary">Modules</a></li>
</ul>
<h2 id="modules_summary">Modules summary <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></h2>
<table class="summary">
<tr>
<td class="summary_signature"><a href="Pocketex.html">Pocketex</a></td>
<td class="summary_synopsis"><p>Provides functionality for interacting with the Pocket API
<a href="http://getpocket.com/developer/docs">http://getpocket.com/developer/docs</a></p>
</td>
</tr>
<tr>
<td class="summary_signature"><a href="Pocketex.Auth.html">Pocketex.Auth</a></td>
<td class="summary_synopsis"><p>Wrapper functions around the Pocket auth API</p>
</td>
</tr>
<tr>
<td class="summary_signature"><a href="Pocketex.Error.html">Pocketex.Error</a></td>
<td class="summary_synopsis"><p>Handles various errors that can be returned by requests</p>
</td>
</tr>
<tr>
<td class="summary_signature"><a href="Pocketex.Item.html">Pocketex.Item</a></td>
<td class="summary_synopsis"><p>Wrapper functions for working with items (articles, images, videos) through the Pocket API</p>
</td>
</tr>
<tr>
<td class="summary_signature"><a href="Pocketex.Response.html">Pocketex.Response</a></td>
<td class="summary_synopsis"><p>Wrapper around Pocket API responses</p>
</td>
</tr>
<tr>
<td class="summary_signature"><a href="Pocketex.Utils.html">Pocketex.Utils</a></td>
<td class="summary_synopsis"><p>Generic utility functions for Pocketex</p>
</td>
</tr>
</table>
</section>
</body>
</html>