.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "AnyEvent::XMPP::Error::Stanza 3"
.TH AnyEvent::XMPP::Error::Stanza 3 2024-07-13 "perl v5.38.2" "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
AnyEvent::XMPP::Error::Stanza \- Stanza errors
.PP
Subclass of AnyEvent::XMPP::Error
.SS METHODS
.IX Subsection "METHODS"
.IP "\fBxml_node ()\fR" 4
.IX Item "xml_node ()"
Returns the AnyEvent::XMPP::Node object for this Stanza error.
This method returns undef if the Stanza timeouted.
.Sp
In the case of a timeout the \f(CW\*(C`condition\*(C'\fR method returns \f(CW\*(C`client\-timeout\*(C'\fR,
\&\f(CW\*(C`type\*(C'\fR returns 'cancel' and \f(CW\*(C`code\*(C'\fR undef.
.IP "\fBtype ()\fR" 4
.IX Item "type ()"
This method returns one of:
.Sp
.Vb 1
\&   \*(Aqcancel\*(Aq, \*(Aqcontinue\*(Aq, \*(Aqmodify\*(Aq, \*(Aqauth\*(Aq and \*(Aqwait\*(Aq
.Ve
.IP "\fBcode ()\fR" 4
.IX Item "code ()"
This method returns the error code if one was found.
.IP "\fBcondition ()\fR" 4
.IX Item "condition ()"
Returns the error condition string if one was found when receiving the Stanza error.
It can be undef or one of:
.Sp
.Vb 10
\&   bad\-request
\&   conflict
\&   feature\-not\-implemented
\&   forbidden
\&   gone
\&   internal\-server\-error
\&   item\-not\-found
\&   jid\-malformed
\&   not\-acceptable
\&   not\-allowed
\&   not\-authorized
\&   payment\-required
\&   recipient\-unavailable
\&   redirect
\&   registration\-required
\&   remote\-server\-not\-found
\&   remote\-server\-timeout
\&   resource\-constraint
\&   service\-unavailable
\&   subscription\-required
\&   undefined\-condition
\&   unexpected\-request
.Ve
.IP "\fBcondition_node ()\fR" 4
.IX Item "condition_node ()"
Returns the error condition node if one was found when receiving the Stanza error.
This is mostly for debugging purposes.
.IP "\fBtext ()\fR" 4
.IX Item "text ()"
The humand readable error portion. Might be undef if none was received.
.SH AUTHOR
.IX Header "AUTHOR"
Robin Redeker, \f(CW\*(C`<elmex at ta\-sa.org>\*(C'\fR, JID: \f(CW\*(C`<elmex at jabber.org>\*(C'\fR
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2007, 2008 Robin Redeker, all rights reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.