Current section
Files
Jump to
Current section
Files
doc/cloudi_service_oauth1_db_pgsql.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Module cloudi_service_oauth1_db_pgsql</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>
<h1>Module cloudi_service_oauth1_db_pgsql</h1>
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
<h3><a name="CloudI_OAuth_v1.0_PostgreSQL_DB_Interface">CloudI OAuth v1.0 PostgreSQL DB Interface</a></h3>.
<p>Copyright © 2014-2017 Michael Truog</p>
<p><b>Version:</b> 1.7.1 Nov 28 2019 15:54:30
------------------------------------------------------------------------</p>
<p><b>Behaviours:</b> <a href="cloudi_service_oauth1_db.html"><tt>cloudi_service_oauth1_db</tt></a>.</p>
<p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog at protonmail dot com"><tt>mjtruog at protonmail dot com</tt></a>).</p>
<h2><a name="description">Description</a></h2>
<h3><a name="CloudI_OAuth_v1.0_PostgreSQL_DB_Interface">CloudI OAuth v1.0 PostgreSQL DB Interface</a></h3>
<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#initialize-3">initialize/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#signature_methods-5">signature_methods/5</a></td><td></td></tr>
<tr><td valign="top"><a href="#token_access_store-13">token_access_store/13</a></td><td></td></tr>
<tr><td valign="top"><a href="#token_access_verify-9">token_access_verify/9</a></td><td></td></tr>
<tr><td valign="top"><a href="#token_request_check-6">token_request_check/6</a></td><td></td></tr>
<tr><td valign="top"><a href="#token_request_delete-4">token_request_delete/4</a></td><td></td></tr>
<tr><td valign="top"><a href="#token_request_find-4">token_request_find/4</a></td><td></td></tr>
<tr><td valign="top"><a href="#token_request_store-14">token_request_store/14</a></td><td></td></tr>
<tr><td valign="top"><a href="#token_request_update-5">token_request_update/5</a></td><td></td></tr>
<tr><td valign="top"><a href="#token_request_verify-10">token_request_verify/10</a></td><td></td></tr>
<tr><td valign="top"><a href="#tokens_clean-2">tokens_clean/2</a></td><td></td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="initialize-3">initialize/3</a></h3>
<div class="spec">
<p><tt>initialize(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a>, Database::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, Debug::boolean()) -> ok | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="signature_methods-5">signature_methods/5</a></h3>
<div class="spec">
<p><tt>signature_methods(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a>, Database::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, Realm::string() | binary() | null, ConsumerKey::string() | binary(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> {ok, {PLAINTEXT::binary() | null, HMAC_SHA1::binary() | null, RSA_SHA1::binary() | null}, CallbackRegex::binary()} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="token_access_store-13">token_access_store/13</a></h3>
<div class="spec">
<p><tt>token_access_store(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a>, Database::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, Realm::string() | binary() | null, ConsumerKey::string() | binary(), SignatureMethod::string() | binary(), ClientSharedSecret::string() | binary(), Timestamp::string() | binary(), NonceRequest::string() | binary(), NonceAccess::string() | binary(), TokenAccess::string() | binary(), TokenAccessSecret::string() | binary(), ExpirationSeconds::pos_integer(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> ok | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="token_access_verify-9">token_access_verify/9</a></h3>
<div class="spec">
<p><tt>token_access_verify(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a>, Database::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, Realm::string() | binary() | null, ConsumerKey::string() | binary(), SignatureMethod::string() | binary(), Timestamp::string() | binary(), Nonce::string() | binary(), TokenAccess::string() | binary(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> {ok, ClientSharedSecret::binary(), TokenAccessSecret::binary()} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="token_request_check-6">token_request_check/6</a></h3>
<div class="spec">
<p><tt>token_request_check(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a>, Database::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, Realm::string() | binary() | null, ConsumerKey::string() | binary(), NonceRequest::string() | binary(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> ok | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="token_request_delete-4">token_request_delete/4</a></h3>
<div class="spec">
<p><tt>token_request_delete(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a>, Database::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, TokenRequest::string() | binary(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> ok | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="token_request_find-4">token_request_find/4</a></h3>
<div class="spec">
<p><tt>token_request_find(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a>, Database::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, TokenRequest::string() | binary(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> {ok, CallbackURL::binary(), CallbackQS::binary()} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="token_request_store-14">token_request_store/14</a></h3>
<div class="spec">
<p><tt>token_request_store(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a>, Database::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, Realm::string() | binary() | null, ConsumerKey::string() | binary(), SignatureMethod::string() | binary(), ClientSharedSecret::string() | binary(), Timestamp::string() | binary(), NonceRequest::string() | binary(), TokenRequest::string() | binary(), TokenRequestSecret::string() | binary(), CallbackURL::string() | binary(), CallbackQS::string() | binary(), ExpirationSeconds::pos_integer(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> ok | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="token_request_update-5">token_request_update/5</a></h3>
<div class="spec">
<p><tt>token_request_update(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a>, Database::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, TokenRequest::string() | binary(), Verifier::string() | binary(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> ok | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="token_request_verify-10">token_request_verify/10</a></h3>
<div class="spec">
<p><tt>token_request_verify(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a>, Database::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>, Realm::string() | binary() | null, ConsumerKey::string() | binary(), SignatureMethod::string() | binary(), Timestamp::string() | binary(), NonceAccess::string() | binary(), TokenRequest::string() | binary(), Verifier::string() | binary(), Timeout::<a href="deps/cloudi_core/doc/cloudi_service.html#type-timeout_milliseconds">cloudi_service:timeout_milliseconds()</a>) -> {ok, ClientSharedSecret::binary(), NonceRequest::binary(), TokenRequestSecret::binary()} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="tokens_clean-2">tokens_clean/2</a></h3>
<div class="spec">
<p><tt>tokens_clean(Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a>, Database::<a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a>) -> ok | {error, any()}</tt><br></p>
</div>
<hr>
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc</i></p>
</body>
</html>