.\" -*- 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::Ext::MUC::Message 3"
.TH AnyEvent::XMPP::Ext::MUC::Message 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::Ext::MUC::Message \- A room message
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This message represents a message from a MUC room. It is
derived from AnyEvent::XMPP::IM::Message. (You can use the
methods from that class to access it for example).
.PP
Also the methods like eg. \f(CW\*(C`make_reply\*(C'\fR return a
AnyEvent::XMPP::Ext::MUC::Message.
.SH METHODS
.IX Header "METHODS"
.IP "\fBnew (%args)\fR" 4
.IX Item "new (%args)"
This constructor takes the same arguments that the constructor for
AnyEvent::XMPP::IM::Message takes.
.IP \fBroom\fR 4
.IX Item "room"
Returns the chatroom in which' context this message
was sent.
.IP "\fBsend ([$room])\fR" 4
.IX Item "send ([$room])"
This method send this message. If \f(CW$room\fR
is defined it will set the connection of this
message object before it is send.
.IP "\fBmake_reply ([$msg])\fR" 4
.IX Item "make_reply ([$msg])"
This method returns a new instance of AnyEvent::XMPP::Ext::MUC::Message.
The destination address, connection and type of the returned message
object will be set.
.Sp
If \f(CW$msg\fR is defined and an instance of AnyEvent::XMPP::Ext::MUC::Message
the destination address, connection and type of \f(CW$msg\fR will be changed
and this method will not return a new instance of AnyEvent::XMPP::Ext::MUC::Message.
.Sp
If \f(CW$self\fR is a message of type 'groupchat' the \f(CW\*(C`to\*(C'\fR attribute
will be set to the bare JID of the room for the reply.
.IP \fBfrom_nick\fR 4
.IX Item "from_nick"
This method returns the nickname of the source
of this message.
.IP \fBis_private\fR 4
.IX Item "is_private"
This method returns true when the message was not directed to the
room, but privately to you.
.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.