.\" -*- 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::IM::Presence 3"
.TH AnyEvent::XMPP::IM::Presence 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::IM::Presence \- XMPP presence
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module represents an XMPP presence. It stores
the full JID of the contact, the show value, status value
and priority.
.PP
AnyEvent::XMPP::IM::Presence is derived from AnyEvent::XMPP::IM::Delayed,
use the interface described there to find out whether this presence was delayed.
.SH METHODS
.IX Header "METHODS"
.IP \fBjid\fR 4
.IX Item "jid"
Returns the full JID of this presence.
.IP \fBpriority\fR 4
.IX Item "priority"
Returns the priority of this presence.
.IP \fBstatus_all_lang\fR 4
.IX Item "status_all_lang"
Returns all language tags of available status descriptions.
See also status.
.IP \fBshow\fR 4
.IX Item "show"
Returns the show value of this presence, which is one of:
.Sp
.Vb 1
\&   \*(Aqaway\*(Aq, \*(Aqchat\*(Aq, \*(Aqdnd\*(Aq, \*(Aqxa\*(Aq
.Ve
.Sp
or the empty string if the presence is 'available'.
.IP "\fBstatus ([$lang])\fR" 4
.IX Item "status ([$lang])"
Returns the presence description. \f(CW$lang\fR is optional can should be one of
the tags returned by \f(CW\*(C`status_all_lang\*(C'\fR.
.IP "\fBmake_message (%args)\fR" 4
.IX Item "make_message (%args)"
Returns a AnyEvent::XMPP::IM::Message object with the to field set to
this presence full JID.
.Sp
\&\f(CW%args\fR are further arguments to the constructor of the message.
.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.