.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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::Amazon::Response 3pm"
.TH Net::Amazon::Response 3pm "2021-01-02" "perl v5.32.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::Amazon::Response \- Baseclass for responses from Amazon's web service
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    $resp = $ua\->request($request);
\&
\&    if($resp\->is_success()) { 
\&        print $resp\->as_string();
\&    }
\&
\&    if($resp\->is_error()) {
\&        print $resp\->message();
\&    }
\&
\&    if($resp\->is_success()) { 
\&        for my $property ($resp\->properties) {
\&            print $property\->as_string(), "\en";
\&        }
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Net::Amazon::Response\*(C'\fR is the baseclass for responses coming back 
from the useragent's \f(CW\*(C`request\*(C'\fR method. Responses are typically
not of type \f(CW\*(C`Net::Amazon::Response\*(C'\fR but one of its subclasses
\&\f(CW\*(C`Net::Amazon::Response::*\*(C'\fR. However, for basic error handling and
dumping content, \f(CW\*(C`Net::Amazon::Response\*(C'\fR's methods are typically used,
because we typically don't know what type of object we're 
actually dealing with.
.SS "\s-1METHODS\s0"
.IX Subsection "METHODS"
.IP "\fBis_success()\fR" 4
.IX Item "is_success()"
Returns true if the request was successful. This doesn't mean any objects
have been found, it just indicates a successful roundtrip.
.IP "\fBis_error()\fR" 4
.IX Item "is_error()"
Returns true if an error occurred. Use \f(CW\*(C`message()\*(C'\fR to determine what 
kind of error.
.IP "\fBproperties()\fR" 4
.IX Item "properties()"
Returns the list of \f(CW\*(C`Net::Amazon::Property\*(C'\fR objects which were found
by the query.
.IP "\fBas_string()\fR" 4
.IX Item "as_string()"
Dumps the content of the response.
.IP "\fBmessage()\fR" 4
.IX Item "message()"
Returns the error message as a string in case an error occurred. In case
several errors occurred, they're stringed together. Look up \f(CW\*(C`messages()\*(C'\fR
if you need them separated.
.IP "\fBmessages()\fR" 4
.IX Item "messages()"
Returns all error messages for a response as a reference to an array
of string messages.
.SH "AUTHOR"
.IX Header "AUTHOR"
Mike Schilli, <m@perlmeister.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2003 by Mike Schilli <m@perlmeister.com>
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.