BaguettePHP/mastodon-api

View on GitHub
docs/class-Baguette.Mastodon.Grant.Grant.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">

    <title>Class Baguette\Mastodon\Grant\Grant | ξ ^ω^)ξ 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><a href="class-Baguette.Mastodon.Grant.CodeGrant.html">CodeGrant</a></li>
                <li class="active"><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 Grant</h1>


    <div class="description">
    <p>Mastodon grant request class</p>
    </div>



    <div>
        <h4>Direct known subclasses</h4>
            <a href="class-Baguette.Mastodon.Grant.CodeGrant.html">Baguette\Mastodon\Grant\CodeGrant</a>, 
            <a href="class-Baguette.Mastodon.Grant.NoopGrant.html">Baguette\Mastodon\Grant\NoopGrant</a>, 
            <a href="class-Baguette.Mastodon.Grant.PasswordCredential.html">Baguette\Mastodon\Grant\PasswordCredential</a>
    </div>






    <div class="info">
        <b>Abstract</b><br>
        
        <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="&#x6d;&#97;&#105;&#x6c;&#x74;&#111;:&#x74;&#97;&#100;&#x73;&#x61;&#110;&#64;&#x7a;&#111;&#110;&#x75;&#x2e;&#109;&#101;">&#x74;&#97;&#100;&#x73;&#x61;&#110;&#64;&#x7a;&#111;&#110;&#x75;&#x2e;&#109;&#101;</a><br>
            <b>Located at</b> <a href="source-class-Baguette.Mastodon.Grant.Grant.html#10-53" title="Go to source code">Grant/Grant.php</a>
        <br>
    </div>



    <table class="summary methods" id="methods">
    <caption>Methods summary</caption>
    <tr data-order="auth" id="_auth">

        <td class="attributes"><code>
            abstract public 

            
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#_auth">#</a>
        <code><a href="source-class-Baguette.Mastodon.Grant.Grant.html#19-24" 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> )</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>





        </div>
        </div></td>
    </tr>
    <tr data-order="getPathToOAuthToken" id="_getPathToOAuthToken">

        <td class="attributes"><code>
             protected static

            string
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#_getPathToOAuthToken">#</a>
        <code><a href="source-class-Baguette.Mastodon.Grant.Grant.html#26-32" title="Go to source code">getPathToOAuthToken</a>( <span><code><a href="class-Baguette.Mastodon.Client.html">Baguette\Mastodon\Client</a></code> <var>$client</var></span> )</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="getFormParams" id="_getFormParams">

        <td class="attributes"><code>
             protected static

            array
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#_getFormParams">#</a>
        <code><a href="source-class-Baguette.Mastodon.Grant.Grant.html#34-42" title="Go to source code">getFormParams</a>( <span><code><a href="class-Baguette.Mastodon.Service.AuthFactory.html">Baguette\Mastodon\Service\AuthFactory</a></code> <var>$factory</var></span> )</code>

        <div class="description short">
            
        </div>

        <div class="description detailed hidden">
            



                <h4>Returns</h4>
                <div class="list">
                    array
                </div>




        </div>
        </div></td>
    </tr>
    <tr data-order="getFormParamsWithSecret" id="_getFormParamsWithSecret">

        <td class="attributes"><code>
             protected static

            array
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#_getFormParamsWithSecret">#</a>
        <code><a href="source-class-Baguette.Mastodon.Grant.Grant.html#44-52" title="Go to source code">getFormParamsWithSecret</a>( <span><code><a href="class-Baguette.Mastodon.Service.AuthFactory.html">Baguette\Mastodon\Service\AuthFactory</a></code> <var>$factory</var></span> )</code>

        <div class="description short">
            
        </div>

        <div class="description detailed hidden">
            



                <h4>Returns</h4>
                <div class="list">
                    array
                </div>




        </div>
        </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>