BaguettePHP/mastodon-api

View on GitHub
docs/class-Baguette.Mastodon.Service.Toot.html

Summary

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

    <title>Class Baguette\Mastodon\Service\Toot | ξ ^ω^)ξ 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="active 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.Service.AuthFactory.html">AuthFactory</a></li>
                <li><a href="class-Baguette.Mastodon.Service.Authorization.html">Authorization</a></li>
                <li><a href="class-Baguette.Mastodon.Service.Scope.html">Scope</a></li>
                <li><a href="class-Baguette.Mastodon.Service.SessionStorage.html">SessionStorage</a></li>
                <li class="active"><a href="class-Baguette.Mastodon.Service.Toot.html">Toot</a></li>
            </ul>



            <h3>Exceptions</h3>
            <ul>
                <li><a href="class-Baguette.Mastodon.Service.AuthorizationException.html">AuthorizationException</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.Service.html" title="Summary of Baguette\Mastodon\Service"><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 Toot</h1>


    <div class="description">
    <p>Toot</p>
    </div>

    <dl class="tree">
        <dd style="padding-left:0px">
<b><span>Baguette\Mastodon\Service\Toot</span></b>            
            
             uses 
                    <a href="class-Teto.Object.PrivateGetter.html"><span>Teto\Object\PrivateGetter</span></a>, 
            
                    <a href="class-Teto.Object.ReadOnly.html"><span>Teto\Object\ReadOnly</span></a>
            
        </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.Service.html">Service</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.Service.Toot.html#7-94" title="Go to source code">Service/Toot.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.Service.Toot.html#50-81" title="Go to source code">__construct</a>( <span>string[] <var>$toot_string</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>$toot_string</var></dt>
                    <dd>$scopes</dd>
                    <dt><var>$options</var></dt>
                    <dd></dd>
                </dl></div>





        </div>
        </div></td>
    </tr>
    <tr data-order="__toString" id="___toString">

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

            string
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#___toString">#</a>
        <code><a href="source-class-Baguette.Mastodon.Service.Toot.html#83-93" title="Go to source code">__toString</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 used">
    <caption>Methods used from <a href="class-Teto.Object.PrivateGetter.html#methods">Teto\Object\PrivateGetter</a></caption>
    <tr>
        <td><code>
            <a href="class-Teto.Object.PrivateGetter.html#___get">__get()</a>, 
            <a href="class-Teto.Object.PrivateGetter.html#___isset">__isset()</a>
        </code></td>
    </tr>
    </table>
    <table class="summary used">
    <caption>Methods used from <a href="class-Teto.Object.ReadOnly.html#methods">Teto\Object\ReadOnly</a></caption>
    <tr>
        <td><code>
            <a href="class-Teto.Object.ReadOnly.html#___set">__set()</a>
        </code></td>
    </tr>
    </table>






    <table class="summary constants" id="constants">
    <caption>Constants summary</caption>
    <tr data-order="VISIBILITY_DIRECT" id="VISIBILITY_DIRECT">

        <td class="attributes"><code>string</code></td>
        <td class="name">
            <code>
                <a href="source-class-Baguette.Mastodon.Service.Toot.html#25" title="Go to source code"><b>VISIBILITY_DIRECT</b></a>
            </code>

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

            <div class="description detailed hidden">
                

            </div>
        </td>
        <td class="value">
            <div>
                <a href="#VISIBILITY_DIRECT" class="anchor">#</a>
                <code><span class="php-quote">'direct'</span></code>
            </div>
        </td>
    </tr>
    <tr data-order="VISIBILITY_PRIVATE" id="VISIBILITY_PRIVATE">

        <td class="attributes"><code>string</code></td>
        <td class="name">
            <code>
                <a href="source-class-Baguette.Mastodon.Service.Toot.html#26" title="Go to source code"><b>VISIBILITY_PRIVATE</b></a>
            </code>

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

            <div class="description detailed hidden">
                

            </div>
        </td>
        <td class="value">
            <div>
                <a href="#VISIBILITY_PRIVATE" class="anchor">#</a>
                <code><span class="php-quote">'private'</span></code>
            </div>
        </td>
    </tr>
    <tr data-order="VISIBILITY_UNLISTED" id="VISIBILITY_UNLISTED">

        <td class="attributes"><code>string</code></td>
        <td class="name">
            <code>
                <a href="source-class-Baguette.Mastodon.Service.Toot.html#27" title="Go to source code"><b>VISIBILITY_UNLISTED</b></a>
            </code>

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

            <div class="description detailed hidden">
                

            </div>
        </td>
        <td class="value">
            <div>
                <a href="#VISIBILITY_UNLISTED" class="anchor">#</a>
                <code><span class="php-quote">'unlisted'</span></code>
            </div>
        </td>
    </tr>
    <tr data-order="VISIBILITY_PUBLIC" id="VISIBILITY_PUBLIC">

        <td class="attributes"><code>string</code></td>
        <td class="name">
            <code>
                <a href="source-class-Baguette.Mastodon.Service.Toot.html#28" title="Go to source code"><b>VISIBILITY_PUBLIC</b></a>
            </code>

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

            <div class="description detailed hidden">
                

            </div>
        </td>
        <td class="value">
            <div>
                <a href="#VISIBILITY_PUBLIC" class="anchor">#</a>
                <code><span class="php-quote">'public'</span></code>
            </div>
        </td>
    </tr>
    </table>







    <table class="summary properties" id="magicProperties">
    <caption>Magic properties summary</caption>
    <tr data-order="toot_string" id="m$toot_string">
        <td class="attributes"><code>
            public  read-only
            string
        </code></td>

        <td class="name">
                <a href="source-class-Baguette.Mastodon.Service.Toot.html#13" title="Go to source code"><var>$toot_string</var></a>

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

            <div class="description detailed hidden">
                

            </div>
        </td>
    </tr>
    <tr data-order="in_reply_to_id" id="m$in_reply_to_id">
        <td class="attributes"><code>
            public  read-only
            integer|null
        </code></td>

        <td class="name">
                <a href="source-class-Baguette.Mastodon.Service.Toot.html#15" title="Go to source code"><var>$in_reply_to_id</var></a>

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

            <div class="description detailed hidden">
                

            </div>
        </td>
    </tr>
    <tr data-order="visibility" id="m$visibility">
        <td class="attributes"><code>
            public  read-only
            string
        </code></td>

        <td class="name">
                <a href="source-class-Baguette.Mastodon.Service.Toot.html#16" title="Go to source code"><var>$visibility</var></a>

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

            <div class="description detailed hidden">
                

            </div>
        </td>
    </tr>
    <tr data-order="sensitive" id="m$sensitive">
        <td class="attributes"><code>
            public  read-only
            boolean|null
        </code></td>

        <td class="name">
                <a href="source-class-Baguette.Mastodon.Service.Toot.html#17" title="Go to source code"><var>$sensitive</var></a>

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

            <div class="description detailed hidden">
                

            </div>
        </td>
    </tr>
    <tr data-order="spoiler_text" id="m$spoiler_text">
        <td class="attributes"><code>
            public  read-only
            string|null
        </code></td>

        <td class="name">
                <a href="source-class-Baguette.Mastodon.Service.Toot.html#18" title="Go to source code"><var>$spoiler_text</var></a>

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

            <div class="description detailed hidden">
                

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