docs/class-Baguette.Mastodon.Client.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class Baguette\Mastodon\Client | ξ ^ω^)ξ 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="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.Client.html">Client</a></li>
<li><a href="class-Baguette.Mastodon.EntityCaster.html">EntityCaster</a></li>
<li><a href="class-Baguette.Mastodon.Mastodon.html">Mastodon</a></li>
<li><a href="class-Baguette.Mastodon.Requester.html">Requester</a></li>
</ul>
<h3>Functions</h3>
<ul>
<li><a href="function-Baguette.Mastodon.authorization.html">authorization</a></li>
<li><a href="function-Baguette.Mastodon.credential.html" class="deprecated">credential</a></li>
<li><a href="function-Baguette.Mastodon.grant.html">grant</a></li>
<li><a href="function-Baguette.Mastodon.http.html">http</a></li>
<li><a href="function-Baguette.Mastodon.request.html">request</a></li>
<li><a href="function-Baguette.Mastodon.scope.html">scope</a></li>
<li><a href="function-Baguette.Mastodon.session.html">session</a></li>
<li><a href="function-Baguette.Mastodon.toot.html">toot</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.html" title="Summary of Baguette\Mastodon"><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 Client</h1>
<div class="description">
<p>Mastodon API Client</p>
</div>
<div class="info">
<b>Final</b><br>
<b>Namespace:</b> <a href="namespace-Baguette.html">Baguette</a>\<a href="namespace-Baguette.Mastodon.html">Mastodon</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>Located at</b> <a href="source-class-Baguette.Mastodon.Client.html#9-116" title="Go to source code">Client.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.Client.html#29-40" title="Go to source code">__construct</a>( <span>string <var>$instance</var></span>, <span>array <var>$options</var> = []</span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$instance</var></dt>
<dd></dd>
<dt><var>$options</var></dt>
<dd></dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="requestAPI" id="_requestAPI">
<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="#_requestAPI">#</a>
<code><a href="source-class-Baguette.Mastodon.Client.html#42-54" title="Go to source code">requestAPI</a>( <span>string <var>$method</var></span>, <span>string <var>$path</var></span>, <span>array <var>$options</var></span>, <span><code><a href="class-Baguette.Mastodon.Service.SessionStorage.html">Baguette\Mastodon\Service\SessionStorage</a></code> <var>$session</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$method</var></dt>
<dd>"GET"|"POST"</dd>
<dt><var>$path</var></dt>
<dd></dd>
<dt><var>$options</var></dt>
<dd></dd>
<dt><var>$session</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>
<tr data-order="setAPIHttpClient" id="_setAPIHttpClient">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_setAPIHttpClient">#</a>
<code><a href="source-class-Baguette.Mastodon.Client.html#56-62" title="Go to source code">setAPIHttpClient</a>( <span><code><a href="class-GuzzleHttp.Client.html">GuzzleHttp\Client</a></code> <var>$client</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="getScheme" id="_getScheme">
<td class="attributes"><code>
public
string
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getScheme">#</a>
<code><a href="source-class-Baguette.Mastodon.Client.html#98-104" title="Go to source code">getScheme</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Returns</h4>
<div class="list">
string
</div>
</div>
</div></td>
</tr>
<tr data-order="getHostname" id="_getHostname">
<td class="attributes"><code>
public
string
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getHostname">#</a>
<code><a href="source-class-Baguette.Mastodon.Client.html#106-115" title="Go to source code">getHostname</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Returns</h4>
<div class="list">
string
</div>
</div>
</div></td>
</tr>
</table>
<table class="summary constants" id="constants">
<caption>Constants summary</caption>
<tr data-order="USER_AGENT" id="USER_AGENT">
<td class="attributes"><code>string</code></td>
<td class="name">
<code>
<a href="source-class-Baguette.Mastodon.Client.html#18" title="Go to source code"><b>USER_AGENT</b></a>
</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#USER_AGENT" class="anchor">#</a>
<code><span class="php-quote">'PhpMastodon/0.0.1(+https://github.com/zonuexe/php-mastodon-client)'</span></code>
</div>
</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>