docs/function-Baguette.Mastodon.request.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Function Baguette\Mastodon\request | ξ ^ω^)ξ 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><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 class="active"><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>Function</span> </li>
</ul>
<ul>
</ul>
<ul>
</ul>
</div>
<div id="content" class="function">
<h1>Function request</h1>
<div class="description">
<p>Manually API Request</p>
</div>
<div class="info">
<b>Namespace:</b> <a href="namespace-Baguette.html">Baguette</a>\<a href="namespace-Baguette.Mastodon.html">Mastodon</a><br>
<b>Located at</b>
<a href="source-function-Baguette.Mastodon.request.html#133-152" title="Go to source code">
functions.php
</a><br>
</div>
<table class="summary" id="parameters">
<caption>Parameters summary</caption>
<tr id="$service">
<td class="name"><code><code><a href="class-Baguette.Mastodon.Mastodon.html">Baguette\Mastodon\Mastodon</a></code></code></td>
<td class="value"><code><var>$service</var></code></td>
<td>A instance object of Mastodon class</td>
</tr>
<tr id="$method">
<td class="name"><code>string</code></td>
<td class="value"><code><var>$method</var></code></td>
<td>HTTP Method (GET, POST, PUT, DELETE, ...)</td>
</tr>
<tr id="$path">
<td class="name"><code>string</code></td>
<td class="value"><code><var>$path</var></code></td>
<td>API Path (URL)</td>
</tr>
<tr id="$options">
<td class="name"><code>array</code></td>
<td class="value"><code><var>$options</var></code></td>
<td>Options for GuzzleHttp</td>
</tr>
<tr id="$class">
<td class="name"><code>string|string[]</code></td>
<td class="value"><code><var>$class</var> = <span class="php-keyword1">null</span></code></td>
<td>A class name of return value</td>
</tr>
</table>
<table class="summary" id="returns">
<caption>Return value summary</caption>
<tr>
<td class="name"><code>
<code><a href="class-Psr.Http.Message.ResponseInterface.html">Psr\Http\Message\ResponseInterface</a></code>|<code><a href="class-Baguette.Mastodon.Entity.Entity.html">Baguette\Mastodon\Entity\Entity</a></code>|<code><a href="class-Baguette.Mastodon.Entity.Entity.html">Baguette\Mastodon\Entity\Entity</a>[]</code>|mixed
</code></td>
<td>
Returns ResponseInterface if $class is NULL.
</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?a0a1caea7753954992695e0e57bff2e63fa15823"></script>
<script src="elementlist.js?bfca39af442ee2772f4953470c68e31ee57b2cd9"></script>
</body>
</html>