{
    "content": [
        {
            "type": "text",
            "text": "# Net::Twitter::WrappedResult (perldoc)\n\n## NAME\n\nNet::Twitter::WrappedResult - Wrap an HTTP response and Twitter result\n\n## SYNOPSIS\n\nuse Net::Twitter;\nmy $nt = Net::Twitter->new(\ntraits => [ qw/API::RESTv11 WrapResult/ ],\n%othernewoptions,\n);\nmy $r = $nt->verifycredentials;\nmy $httpresponse        = $r->httpresponse;\nmy $twitterresult       = $r->result;\nmy $ratelimitremaining = $r->ratelimitremaining;\n\n## DESCRIPTION\n\nOften, the result of a Twitter API call, inflated from the JSON body of the HTTP response does\nnot contain all the information you need. Twitter includes meta data, such as rate limiting\ninformation, in HTTP response headers. This object wraps both the inflated Twitter result and\nthe HTTP response giving the caller full access to all the meta data. It also provides accessors\nfor the rate limit information.\n\n## Sections\n\n- **NAME**\n- **VERSION**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **METHODS** (1 subsections)\n- **AUTHOR**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Net::Twitter::WrappedResult",
        "section": "",
        "mode": "perldoc",
        "summary": "Net::Twitter::WrappedResult - Wrap an HTTP response and Twitter result",
        "synopsis": "use Net::Twitter;\nmy $nt = Net::Twitter->new(\ntraits => [ qw/API::RESTv11 WrapResult/ ],\n%othernewoptions,\n);\nmy $r = $nt->verifycredentials;\nmy $httpresponse        = $r->httpresponse;\nmy $twitterresult       = $r->result;\nmy $ratelimitremaining = $r->ratelimitremaining;",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "VERSION",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 13,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 6,
                "subsections": []
            },
            {
                "name": "METHODS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "new",
                        "lines": 21
                    }
                ]
            },
            {
                "name": "AUTHOR",
                "lines": 8,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Net::Twitter::WrappedResult - Wrap an HTTP response and Twitter result\n",
                "subsections": []
            },
            "VERSION": {
                "content": "version 4.01043\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "use Net::Twitter;\n\nmy $nt = Net::Twitter->new(\ntraits => [ qw/API::RESTv11 WrapResult/ ],\n%othernewoptions,\n);\n\nmy $r = $nt->verifycredentials;\n\nmy $httpresponse        = $r->httpresponse;\nmy $twitterresult       = $r->result;\nmy $ratelimitremaining = $r->ratelimitremaining;\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "Often, the result of a Twitter API call, inflated from the JSON body of the HTTP response does\nnot contain all the information you need. Twitter includes meta data, such as rate limiting\ninformation, in HTTP response headers. This object wraps both the inflated Twitter result and\nthe HTTP response giving the caller full access to all the meta data. It also provides accessors\nfor the rate limit information.\n",
                "subsections": []
            },
            "METHODS": {
                "content": "",
                "subsections": [
                    {
                        "name": "new",
                        "content": "Constructs an object wrapping the Twitter result and HTTP response.\n\nresult\nReturns the Twitter API result, i.e., the decode JSON response body.\n\nhttpresponse\nReturns the HTTP::Response object for the API call.\n\nratelimit\nReturns the rate limit, per 15 minute window, for the API endpoint called. Returns undef if\nno suitable rate limit header is available.\n\nratelimitremaining\nReturns the calls remaining in the current 15 minute window for the API endpoint called.\nReturns undef if no suitable header is available.\n\nratelimitreset\nReturns the Unix epoch time time of the next 15 minute window, i.e., when the rate limit\nwill be reset, for the API endpoint called. Returns undef if no suitable header is\navailable.\n"
                    }
                ]
            },
            "AUTHOR": {
                "content": "Marc Mims <marc@questright.com>\n\nCOPYRIGHT & LICENSE\nCopyright (c) 2016 Marc Mims\n\nThis program is free software; you can redistribute it and/or modify it under the same terms as\nperl itself.\n",
                "subsections": []
            }
        }
    }
}