.\" -*- 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::MUC 3"
.TH AnyEvent::XMPP::Error::MUC 3 2023-07-25 "perl v5.38.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
AnyEvent::XMPP::Error::MUC \- MUC error
.PP
Subclass of AnyEvent::XMPP::Error
.SS METHODS
.IX Subsection "METHODS"
.IP \fBtype\fR 4
.IX Item "type"
This method returns either:
.RS 4
.IP join_timeout 4
.IX Item "join_timeout"
If the joining of the room took too long.
.IP no_config_form 4
.IX Item "no_config_form"
If the room we requested the configuration from didn't provide a
data form.
.IP subject_change_forbidden 4
.IX Item "subject_change_forbidden"
If changing the subject of a room is not allowed.
.IP message_error 4
.IX Item "message_error"
If this is an unidentified message error.
.RE
.RS 4
.Sp
If we got a presence error the method \f(CW\*(C`presence_error\*(C'\fR returns a
AnyEvent::XMPP::Error::Presence object with further details. However, this class
tries to provide a mapping for you (the developer) to ease the load of figuring
out which error means what. To make identification of the errors with XEP\-0045
more clear I included the error codes and condition names.
.Sp
Here are the more descriptive types:
.IP password_required 4
.IX Item "password_required"
Entering a room Inform user that a password is required.
.Sp
(Condition: not-authorized, Code: 401)
.IP banned 4
.IX Item "banned"
Entering a room Inform user that he or she is banned from the room
.Sp
(Condition: forbidden, Code: 403)
.IP room_locked 4
.IX Item "room_locked"
Entering a room Inform user that the room does not exist and someone
is currently creating it.
.Sp
(Condition: item-not-found, Code: 404)
.IP room_not_creatable 4
.IX Item "room_not_creatable"
Entering a room Inform user that room creation is restricted
.Sp
(Condition: not-allowed, Code: 405)
.IP use_reserved_nick 4
.IX Item "use_reserved_nick"
Entering a room Inform user that the reserved roomnick must be used
.Sp
(Condition: not-acceptable, Code: 406)
.IP not_on_memberlist 4
.IX Item "not_on_memberlist"
Entering a room Inform user that he or she is not on the member list
.Sp
(Condition: registration-required, Code: 407)
.IP nickname_in_use 4
.IX Item "nickname_in_use"
Entering a room Inform user that his or her desired room nickname is in use or registered by another user
.Sp
(Condition: conflict, Code: 409)
.IP room_full 4
.IX Item "room_full"
Entering a room Inform user that the maximum number of users has been reached
.Sp
(Condition: service-unavailable, Code: 503)
.RE
.RS 4
.Sp
The condition and code are also available through the AnyEvent::XMPP::Error::Presence
object returned by \f(CW\*(C`presence_error\*(C'\fR, see below.
.RE
.IP \fBtext\fR 4
.IX Item "text"
This method returns a human readable text
if one is available.
.IP \fBpresence_error\fR 4
.IX Item "presence_error"
Returns a AnyEvent::XMPP::Error::Presence object if this error
origins to such an error and not some internal error.
.IP \fBmessage_error\fR 4
.IX Item "message_error"
Returns a AnyEvent::XMPP::Error::Message object if this error
origins to such an error and not some internal error.
.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.