docs/class-Baguette.Mastodon.Grant.CodeGrant.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class Baguette\Mastodon\Grant\CodeGrant | ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK</title>
<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active">
<a href="namespace-Baguette.html">
Baguette<span></span>
</a>
<ul>
<li class="active">
<a href="namespace-Baguette.Mastodon.html">
Mastodon<span></span>
</a>
<ul>
<li class="main">
<a href="namespace-Baguette.Mastodon.Config.html">
Config </a>
</li>
<li class="main">
<a href="namespace-Baguette.Mastodon.Entity.html">
Entity </a>
</li>
<li class="active main">
<a href="namespace-Baguette.Mastodon.Grant.html">
Grant </a>
</li>
<li class="main">
<a href="namespace-Baguette.Mastodon.Service.html">
Service </a>
</li>
</ul></li></ul></li>
<li>
<a href="namespace-GuzzleHttp.html">
GuzzleHttp<span></span>
</a>
<ul>
<li>
<a href="namespace-GuzzleHttp.Cookie.html">
Cookie </a>
</li>
<li>
<a href="namespace-GuzzleHttp.Exception.html">
Exception </a>
</li>
<li>
<a href="namespace-GuzzleHttp.Handler.html">
Handler </a>
</li>
<li>
<a href="namespace-GuzzleHttp.Promise.html">
Promise </a>
</li>
</ul></li>
<li>
<a href="namespace-Psr.html">
Psr<span></span>
</a>
<ul>
<li>
<a href="namespace-Psr.Http.html">
Http<span></span>
</a>
<ul>
<li>
<a href="namespace-Psr.Http.Message.html">
Message </a>
</li>
</ul></li></ul></li>
<li>
<a href="namespace-Teto.html">
Teto<span></span>
</a>
<ul>
<li>
<a href="namespace-Teto.Object.html">
Object </a>
</li>
</ul></li>
</ul>
</div>
<hr>
<div id="elements">
<h3>Classes</h3>
<ul>
<li class="active"><a href="class-Baguette.Mastodon.Grant.CodeGrant.html">CodeGrant</a></li>
<li><a href="class-Baguette.Mastodon.Grant.Grant.html">Grant</a></li>
<li><a href="class-Baguette.Mastodon.Grant.NoopGrant.html">NoopGrant</a></li>
<li><a href="class-Baguette.Mastodon.Grant.PasswordCredential.html">PasswordCredential</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" class="text" placeholder="Search">
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-Baguette.Mastodon.Grant.html" title="Summary of Baguette\Mastodon\Grant"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class CodeGrant</h1>
<div class="description">
<p>Mastodon Authorization Code grant</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Baguette.Mastodon.Grant.Grant.html"><span>Baguette\Mastodon\Grant\Grant</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by">
<b><span>Baguette\Mastodon\Grant\CodeGrant</span></b>
</dd>
</dl>
<div class="info">
<b>Namespace:</b> <a href="namespace-Baguette.html">Baguette</a>\<a href="namespace-Baguette.Mastodon.html">Mastodon</a>\<a href="namespace-Baguette.Mastodon.Grant.html">Grant</a><br>
<b>Copyright:</b>
2017 Baguette HQ<br>
<b>License:</b>
<a href="https://www.gnu.org/licenses/gpl-3.0.html">GPL-3.0</a><br>
<b>Author:</b>
USAMI Kenta <a href="mailto:tadsan@zonu.me">tadsan@zonu.me</a><br>
<b>See:</b>
https://tools.ietf.org/html/draft-ietf-oauth-v2-22#section-4.1<br>
<b>Located at</b> <a href="source-class-Baguette.Mastodon.Grant.CodeGrant.html#11-77" title="Go to source code">Grant/CodeGrant.php</a>
<br>
</div>
<table class="summary methods" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Baguette.Mastodon.Grant.CodeGrant.html#26-34" title="Go to source code">__construct</a>( <span>string <var>$code</var></span>, <span>string <var>$redirect_uri</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$code</var></dt>
<dd></dd>
<dt><var>$redirect_uri</var></dt>
<dd></dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="getRedirectUrl" id="_getRedirectUrl">
<td class="attributes"><code>
public static
string
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getRedirectUrl">#</a>
<code><a href="source-class-Baguette.Mastodon.Grant.CodeGrant.html#36-59" title="Go to source code">getRedirectUrl</a>( <span><code><a href="class-Baguette.Mastodon.Client.html">Baguette\Mastodon\Client</a></code> <var>$client</var></span>, <span><code><a href="class-Baguette.Mastodon.Service.AuthFactory.html">Baguette\Mastodon\Service\AuthFactory</a></code> <var>$auth</var></span>, <span><code><a href="class-Baguette.Mastodon.Service.Scope.html">Baguette\Mastodon\Service\Scope</a></code> <var>$scope</var></span>, <span>string <var>$callback_uri</var></span>, <span>string <var>$state</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$client</var></dt>
<dd></dd>
<dt><var>$auth</var></dt>
<dd></dd>
<dt><var>$scope</var></dt>
<dd></dd>
<dt><var>$callback_uri</var></dt>
<dd></dd>
<dt><var>$state</var></dt>
<dd></dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
string
</div>
</div>
</div></td>
</tr>
<tr data-order="auth" id="_auth">
<td class="attributes"><code>
public
<code><a href="class-Psr.Http.Message.ResponseInterface.html">Psr\Http\Message\ResponseInterface</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_auth">#</a>
<code><a href="source-class-Baguette.Mastodon.Grant.CodeGrant.html#61-76" title="Go to source code">auth</a>( <span><code><a href="class-GuzzleHttp.ClientInterface.html">GuzzleHttp\ClientInterface</a></code> <var>$http</var></span>, <span><code><a href="class-Baguette.Mastodon.Service.AuthFactory.html">Baguette\Mastodon\Service\AuthFactory</a></code> <var>$factory</var></span>, <span><code><a href="class-Baguette.Mastodon.Service.Scope.html">Baguette\Mastodon\Service\Scope</a></code> <var>$scope</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$http</var></dt>
<dd></dd>
<dt><var>$factory</var></dt>
<dd></dd>
<dt><var>$scope</var></dt>
<dd></dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><a href="class-Psr.Http.Message.ResponseInterface.html">Psr\Http\Message\ResponseInterface</a></code>
</div>
</div>
</div></td>
</tr>
</table>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Baguette.Mastodon.Grant.Grant.html#methods">Baguette\Mastodon\Grant\Grant</a></caption>
<tr>
<td><code>
<a href="class-Baguette.Mastodon.Grant.Grant.html#_getFormParams">getFormParams()</a>,
<a href="class-Baguette.Mastodon.Grant.Grant.html#_getFormParamsWithSecret">getFormParamsWithSecret()</a>,
<a href="class-Baguette.Mastodon.Grant.Grant.html#_getPathToOAuthToken">getPathToOAuthToken()</a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK API documentation generated by <a href="http://apigen.org">ApiGen</a>
</div>
</div>
</div>
<script src="resources/combined.js"></script>
<script src="elementlist.js"></script>
</body>
</html>