.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Net::Twitter::Error 3pm"
.TH Net::Twitter::Error 3pm "2018-01-18" "perl v5.26.1" "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::Error \- A Net::Twitter exception object
.SH "VERSION"
.IX Header "VERSION"
version 4.01043
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use Scalar::Util qw/blessed/;
\&    use Try::Tiny;
\&
\&    my $nt = Net::Twitter\->new(@options);
\&
\&    my $followers = try {
\&        $nt\->followers;
\&    }
\&    catch {
\&        die $_ unless blessed($_) && $_\->isa(\*(AqNet::Twitter::Error\*(Aq);
\&
\&        warn "HTTP Response Code: ", $_\->code, "\en",
\&             "HTTP Message......: ", $_\->message, "\en",
\&             "Twitter error.....: ", $_\->error, "\en",
\&             "Stack Trace.......: ", $_\->stack_trace\->as_string, "\en";
\&    };
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBNet::Twitter::Error\fR encapsulates the \f(CW\*(C`HTTP::Response\*(C'\fR and Twitter
error \s-1HASH\s0 (if any) resulting from a failed \s-1API\s0 call.
.SH "METHODS"
.IX Header "METHODS"
.IP "new" 4
.IX Item "new"
Constructs a \f(CW\*(C`Net::Twitter::Error\*(C'\fR object.  It accepts the following parameters:
.RS 4
.IP "http_response" 4
.IX Item "http_response"
An \f(CW\*(C`HTTP::Response\*(C'\fR object, required.
.IP "twitter_error" 4
.IX Item "twitter_error"
The error returned by Twitter as a \s-1HASH\s0 ref.  Optional, since some \s-1API\s0 errors do
not include a response from Twitter.  They may, instead, be the result of network
timeouts, proxy errors, or some other problem that prevents an \s-1API\s0 response.
.RE
.RS 4
.RE
.IP "twitter_error" 4
.IX Item "twitter_error"
Get or set the Twitter error \s-1HASH.\s0
.IP "http_response" 4
.IX Item "http_response"
Get or set the \f(CW\*(C`HTTP::Response\*(C'\fR object.
.IP "code" 4
.IX Item "code"
Returns the \s-1HTTP\s0 response code.
.IP "message" 4
.IX Item "message"
Returns the \s-1HTTP\s0 response message.
.IP "has_twitter_error" 4
.IX Item "has_twitter_error"
Returns true if the object contains a Twitter error \s-1HASH.\s0
.IP "error" 4
.IX Item "error"
Returns the \f(CW\*(C`error\*(C'\fR value from the \f(CW\*(C`twitter_error\*(C'\fR \s-1HASH\s0 ref if there is one.
Otherwise, it returns the string \*(L"[unknown]\*(R". Includes a stack trace.
.IP "twitter_error_text" 4
.IX Item "twitter_error_text"
Returns the \f(CW\*(C`error\*(C'\fR value from the \f(CW\*(C`twitter_error\*(C'\fR \s-1HASH\s0 ref if there is one.
Otherwise, returns an empty string
.IP "twitter_error_code" 4
.IX Item "twitter_error_code"
Returns the first numeric twitter error code from the \s-1JSON\s0 response body, if
there is one. Otherwise, it returns 0 so the result should always be safe use
in a numeric test.
.Sp
See Twitter Error Codes <https://dev.twitter.com/docs/error-codes-responses>
for a list of defined error codes.
.IP "stack_trace" 4
.IX Item "stack_trace"
Returns a Devel::StackTrace object.
.IP "stack_frame($i)" 4
.IX Item "stack_frame($i)"
Returns the \f(CW$i\fRth stack frame as a Devel::StackTrace::Frame object.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "Net::Twitter" 4
.IX Item "Net::Twitter"
.SH "AUTHOR"
.IX Header "AUTHOR"
Marc Mims <marc@questright.com>
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (c) 2016 Marc Mims
.PP
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
\&\s-1BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE \*(L"AS IS\*(R" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.\s0
.PP
\&\s-1IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE\s0 (\s-1INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE\s0), \s-1EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.\s0