{
    "mode": "perldoc",
    "parameter": "Net::Twitter::API",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/Net%3A%3ATwitter%3A%3AAPI/json",
    "generated": "2026-06-15T14:11:21Z",
    "synopsis": "package My::Twitter::API;\nuse Moose::Role;\nuse Net::Twitter::API;\nuse namespace::autoclean;\nhas apiurl => ( isa => 'Str', is => 'rw', default => 'http://twitter.com' );\nbaseurl 'apiurl';\ntwitterapimethod friendstimeline => (\ndescription => <<'',\nReturns the 20 most recent statuses posted by the authenticating user\nand that user's friends. This is the equivalent of /home on the Web.\naliases   => [qw/followingtimeline/],\npath      => 'statuses/friendstimeline',\nmethod    => 'GET',\nparams    => [qw/sinceid maxid count page/],\nrequired  => [],\nreturns   => 'ArrayRef[Status]',\n);\n1;",
    "sections": {
        "NAME": {
            "content": "Net::Twitter::API - Moose sugar for defining Twitter API methods\n",
            "subsections": []
        },
        "VERSION": {
            "content": "version 4.01043\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "package My::Twitter::API;\nuse Moose::Role;\nuse Net::Twitter::API;\n\nuse namespace::autoclean;\n\nhas apiurl => ( isa => 'Str', is => 'rw', default => 'http://twitter.com' );\n\nbaseurl 'apiurl';\n\ntwitterapimethod friendstimeline => (\ndescription => <<'',\nReturns the 20 most recent statuses posted by the authenticating user\nand that user's friends. This is the equivalent of /home on the Web.\n\naliases   => [qw/followingtimeline/],\npath      => 'statuses/friendstimeline',\nmethod    => 'GET',\nparams    => [qw/sinceid maxid count page/],\nrequired  => [],\nreturns   => 'ArrayRef[Status]',\n);\n\n1;\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "This module provides some Moose sugar for defining Twitter API methods. It is part of the\nNet-Twitter distribution on CPAN and is used by \"Net::Twitter::API::RESTv11\",\n\"Net::Twitter::API::Search\", and perhaps others.\n\nIt's intent is to make maintaining \"Net::Twitter\" as easy as possible.\n",
            "subsections": []
        },
        "METHODS": {
            "content": "baseurl\nSpecifies, by name, the attribute which contains the base URL for the defined API.\n\ntwitterapimethod\nDefines a Twitter API method. Valid arguments are:\n\nauthenticate\nSpecifies whether, by default, API methods calls should authenticate.\n\ndatetimeparser\nSpecifies the Date::Time::Format derived parser to use for parsing and formatting date\nstrings for the API being defined.\n\ndescription\nA string describing the method, suitable for documentation.\n\naliases\nAn ARRAY ref of strings containing alternate names for the method.\n\npath\nA string containing the path part of the API URL\n\npathsuffix\nA string containing an additional suffix to append to the path (for legacy reasons). If\nyou want to suffix appended, pass the empty string. Defaults to \".json\".\n\nmethod\nA string containing the HTTP method for the call. Defaults to \"GET\".\n\naddsource\nA boolean, indicating whether or not the \"source\" parameter should be added to the API\ncall. (The source value is assigned by Twitter for registered applications.) Defaults to\n0.\n\nparams\nAn ARRAY ref of strings naming all of the valid parameters. Defaults to an empty ARRAY\nref.\n\nrequired\nAn ARRAY ref of strings naming all of the required parameters. Defaults to an empty\nARRAY ref.\n\nreturns\nA string describing the return type of the API method call.\n\ndeprecated\nA boolean indicating whether or not this API is deprecated. If set to 1, code for the\nmethod will be created. This option is optional, and is used by the \"Net-Twitter\"\ndistribution when generating documentation. It defaults to 0.\n",
            "subsections": []
        },
        "AUTHOR": {
            "content": "Marc Mims <marc@questright.com>\n",
            "subsections": []
        },
        "LICENSE": {
            "content": "Copyright (c) 2016 Marc Mims\n\nThe Twitter API itself, and the description text used in this module is:\n\nCopyright (c) 2009 Twitter\n\nThis library is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself.\n",
            "subsections": []
        },
        "DISCLAIMER OF WARRANTY": {
            "content": "BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE\nEXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER\nEXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY\nAND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE\nSOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY\nSERVICING, REPAIR, OR CORRECTION.\n\nIN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER,\nOR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE\nLICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR\nCONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT\nLIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR\nOTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.\n",
            "subsections": []
        }
    },
    "summary": "Net::Twitter::API - Moose sugar for defining Twitter API methods",
    "flags": [],
    "examples": [],
    "see_also": []
}