NAME¶
Net::Twitter::Error - A Net::Twitter exception object
VERSION¶
version 4.01005
SYNOPSIS¶
my $nt = Net::Twitter->new(username => $username, password => $password);
my $followers = eval { $nt->followers };
if ( my $err = $@ ) {
die $@ unless blessed $err and $err->isa('Net::Twitter::Error');
warn "HTTP Response Code: ", $err->code, "\n",
"HTTP Message......: ", $err->message, "\n",
"Twitter error.....: ", $err->error, "\n";
}
DESCRIPTION¶
Net::Twitter::Error encapsulates the "HTTP::Response" and
Twitter error HASH (if any) resulting from a failed API call.
METHODS¶
- new
- Constructs a "Net::Twitter::Error" object. It accepts the
following parameters:
- http_response
- An "HTTP::Response" object, required.
- twitter_error
- The error returned by Twitter as a HASH ref. Optional, since some API
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 API response.
- twitter_error
- Get or set the Twitter error HASH.
- http_response
- Get or set the "HTTP::Response" object.
- code
- Returns the HTTP response code.
- message
- Returns the HTTP response message.
- has_twitter_error
- Returns true if the object contains a Twitter error HASH.
- error
- Returns the "error" value from the "twitter_error"
HASH ref if there is one. Otherwise, it returns the string
"[unknown]". Includes a stack trace.
- twitter_error_text
- Returns the "error" value from the "twitter_error"
HASH ref if there is one. Otherwise, returns an empty string
- twitter_error_code
- Returns the first numeric twitter error code from the JSON response body,
if there is one. Otherwise, it returns 0 so the result should always be
safe use in a numeric test.
See Twitter Error Codes
<https://dev.twitter.com/docs/error-codes-responses> for a list of
defined error codes.
SEE ALSO¶
- Net::Twitter
AUTHOR¶
Marc Mims <marc@questright.com>
LICENSE¶
Copyright (c) 2009 Marc Mims
This library is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
DISCLAIMER OF WARRANTY¶
BECAUSE 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 "AS IS" 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.
IN 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 (INCLUDING 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), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.