.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::Twitter::Role::WrapResult 3pm"
.TH Net::Twitter::Role::WrapResult 3pm "2022-06-16" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::Twitter::Role::WrapResult \- Wrap Twitter API response and HTTP Response
.SH "VERSION"
.IX Header "VERSION"
version 4.01043
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Net::Twitter;
\&
\&    my $nt = Net::Twitter\->new(
\&        traits => [ qw/API::RESTv1_1 WrapResult/ ],
\&        %other_new_options,
\&    );
\&
\&    my $r = $nt\->verify_credentials;
\&
\&    my $http_response        = $r\->http_response;
\&    my $twitter_result       = $r\->result;
\&    my $rate_limit_remaining = $r\->rate_limit_remaining;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Normally, Net::Twitter \s-1API\s0 methods return the decoded \s-1JSON\s0 body from the \s-1HTTP\s0 response. Some useful information, notably rate limit information, is included in \s-1HTTP\s0 response headers. With this role applied, \s-1API\s0 methods will return a Net::Twitter::WrappedResult object that includes both the \s-1HTTP\s0 response and the decoded \s-1JSON\s0 response body. See Net::Twitter::WrappedResult for details.
.SH "AUTHOR"
.IX Header "AUTHOR"
Marc Mims <marc@questright.com>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2016 Marc Mims
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software and may be distributed under the same terms as perl itself.