.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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 "Net::XMPP::Presence 3pm"
.TH Net::XMPP::Presence 3pm 2024-09-01 "perl v5.40.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::XMPP::Presence \- XMPP Presence Module
.SH SYNOPSIS
.IX Header "SYNOPSIS"
Net::XMPP::Presence is a companion to the Net::XMPP module.
It provides the user a simple interface to set and retrieve all
parts of an XMPP Presence.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A Net::XMPP::Presence object is passed to the callback function for
the message.  Also, the first argument to the callback functions is
the session ID from XML::Streams.  There are some cases where you
might want this information, like if you created a Client that
connects to two servers at once, or for writing a mini server.
.PP
.Vb 1
\&    use Net::XMPP;
\&
\&    sub presence {
\&      my ($sid,$Pres) = @_;
\&      .
\&      .
\&      .
\&    }
.Ve
.PP
You now have access to all of the retrieval functions available.
.PP
To create a new presence to send to the server:
.PP
.Vb 1
\&    use Net::XMPP;
\&
\&    $Pres = Net::XMPP::Presence\->new();
.Ve
.PP
Now you can call the creation functions below to populate the tag
before sending it.
.SH METHODS
.IX Header "METHODS"
.SS "Retrieval functions"
.IX Subsection "Retrieval functions"
.IP GetTo 4
.IX Item "GetTo"
.Vb 1
\&  GetTo()
.Ve
.Sp
returns the value in the to='' attribute for the <presence/>.
.Sp
.Vb 1
\&  GetTo("jid")
.Ve
.Sp
If you specify "jid" as an argument
then a Net::XMPP::JID object is returned and
you can easily parse the parts of the JID.
.Sp
.Vb 2
\&  $to    = $Pres\->GetTo();
\&  $toJID = $Pres\->GetTo("jid");
.Ve
.IP GetFrom 4
.IX Item "GetFrom"
.Vb 1
\&  GetFrom()
.Ve
.Sp
returns the value in the from='' attribute for the <presence/>.
.Sp
.Vb 1
\&  GetFrom("jid")
.Ve
.Sp
If you specify "jid" as an argument
then a Net::XMPP::JID object is returned and
you can easily parse the parts of the JID.
.Sp
.Vb 2
\&  $from    = $Pres\->GetFrom();
\&  $fromJID = $Pres\->GetFrom("jid");
.Ve
.IP GetType 4
.IX Item "GetType"
.Vb 1
\&  GetType()
.Ve
.Sp
returns the type='' attribute of the <presence/>.  Each
presence is one of seven types:
.Sp
.Vb 7
\&  available       available to receive messages; default
\&  unavailable     unavailable to receive anything
\&  subscribe       ask the recipient to subscribe you
\&  subscribed      tell the sender they are subscribed
\&  unsubscribe     ask the recipient to unsubscribe you
\&  unsubscribed    tell the sender they are unsubscribed
\&  probe           probe
\&
\&  $type = $Pres\->GetType();
.Ve
.IP GetStatus 4
.IX Item "GetStatus"
.Vb 1
\&  GetStatus()
.Ve
.Sp
returns a string with the current status of the resource.
.Sp
.Vb 1
\&  $status = $Pres\->GetStatus();
.Ve
.IP GetPriority 4
.IX Item "GetPriority"
.Vb 1
\&  GetPriority()
.Ve
.Sp
returns an integer with the priority of the resource
The default is 0 if there is no priority in this
presence.
.Sp
.Vb 1
\&  $priority = $Pres\->GetPriority();
.Ve
.IP GetShow 4
.IX Item "GetShow"
.Vb 1
\&  GetShow()
.Ve
.Sp
Returns a string with the state the client should show.
.Sp
.Vb 1
\&  $show = $Pres\->GetShow();
.Ve
.SS "Creation functions"
.IX Subsection "Creation functions"
.IP SetPresence 4
.IX Item "SetPresence"
.Vb 9
\&  SetPresence(to=>string|JID    
\&              from=>string|JID, 
\&              type=>string,     
\&              status=>string,   
\&              priority=>integer,
\&              meta=>string,     
\&              icon=>string,     
\&              show=>string,     
\&              loc=>string)
.Ve
.Sp
set multiple fields in the <presence/>
at one time.  This is a cumulative
and over writing action.  If you set
the "to" attribute twice, the second
setting is what is used.  If you set
the status, and then set the priority
then both will be in the <presence/>
tag.  For valid settings read the
specific Set functions below.
.Sp
.Vb 1
\&  $Pres\->SetPresence(TYPE=>"away", StatuS=>"Out for lunch");
.Ve
.IP SetTo 4
.IX Item "SetTo"
.Vb 2
\&  SetTo(string)
\&  SetTo(JID)
.Ve
.Sp
sets the to attribute.  You can either pass a string
or a JID object.  They must be valid JIDs or the
server will return an error message.
(ie.  bob@jabber.org/Silent Bob, etc...)
.Sp
.Vb 1
\&  $Pres\->SetTo("bob\e@jabber.org");
.Ve
.IP SetFrom 4
.IX Item "SetFrom"
.Vb 1
\&  SetFrom(string)
.Ve
.Sp
sets the from='' attribute.  You can either pass
.Sp
.Vb 1
\&  SetFrom(JID)
.Ve
.Sp
A string or a JID object.  They must be valid JIDs
or the server will return an error message. (ie.
jabber:bob@jabber.org/Work)  This field is not
required if you are writing a Client since the
server will put the JID of your connection in there
to prevent spamming.
.Sp
.Vb 1
\&  $Pres\->SetFrom("jojo\e@jabber.org");
.Ve
.IP SetType 4
.IX Item "SetType"
.Vb 1
\&  SetType(string)
.Ve
.Sp
sets the type attribute.  Valid settings are:
.Sp
.Vb 7
\&  available      available to receive messages; default
\&  unavailable    unavailable to receive anything
\&  subscribe      ask the recipient to subscribe you
\&  subscribed     tell the sender they are subscribed
\&  unsubscribe    ask the recipient to unsubscribe you
\&  unsubscribed   tell the sender they are unsubscribed
\&  probe          probe
\&
\&  $Pres\->SetType("unavailable");
.Ve
.IP SetStatus 4
.IX Item "SetStatus"
.Vb 1
\&  SetStatus(string)
.Ve
.Sp
sets the status tag to be whatever string the user
wants associated with that resource.
.Sp
.Vb 1
\&  $Pres\->SetStatus("Taking a nap");
.Ve
.IP SetPriority 4
.IX Item "SetPriority"
.Vb 1
\&  SetPriority(integer)
.Ve
.Sp
sets the priority of this resource.  The highest
resource attached to the xmpp account is the
one that receives the messages.
.Sp
.Vb 1
\&  $Pres\->SetPriority(10);
.Ve
.IP SetShow 4
.IX Item "SetShow"
.Vb 1
\&  SetShow(string)
.Ve
.Sp
Sets the name of the icon or string to display for this resource.
.Sp
.Vb 1
\&  $Pres\->SetShow("away");
.Ve
.IP Reply 4
.IX Item "Reply"
.Vb 1
\&  Reply(hash)
.Ve
.Sp
creates a new Presence object and populates the to/from
fields.  If you specify a hash the same as with
SetPresence then those values will override the Reply
values.
.Sp
.Vb 2
\&  $Reply = $Pres\->Reply();
\&  $Reply = $Pres\->Reply(type=>"subscribed");
.Ve
.SS "Removal functions"
.IX Subsection "Removal functions"
.IP RemoveTo 4
.IX Item "RemoveTo"
removes the to attribute from the <presence/>.
.Sp
.Vb 1
\&  $Pres\->RemoveTo();
.Ve
.IP RemoveFrom 4
.IX Item "RemoveFrom"
removes the from attribute from the <presence/>.
.Sp
.Vb 1
\& $Pres\->RemoveFrom();
.Ve
.IP RemoveType 4
.IX Item "RemoveType"
removes the type attribute from the <presence/>.
.Sp
.Vb 1
\& $Pres\->RemoveType();
.Ve
.IP RemoveStatus 4
.IX Item "RemoveStatus"
removes the <status/> element from the <presence/>.
.Sp
.Vb 1
\& $Pres\->RemoveStatus();
.Ve
.IP RemovePriority 4
.IX Item "RemovePriority"
removes the <priority/> element from the <presence/>.
.Sp
.Vb 1
\& $Pres\->RemovePriority();
.Ve
.IP RemoveShow 4
.IX Item "RemoveShow"
removes the <show/> element from the <presence/>.
.Sp
.Vb 1
\&  $Pres\->RemoveShow();
.Ve
.SS "Test functions"
.IX Subsection "Test functions"
.IP DefinedTo 4
.IX Item "DefinedTo"
returns 1 if the to attribute is defined in the <presence/>, 0 otherwise.
.Sp
.Vb 1
\&  $test = $Pres\->DefinedTo();
.Ve
.IP DefinedFrom 4
.IX Item "DefinedFrom"
returns 1 if the from attribute is defined in the <presence/>, 0 otherwise.
.Sp
.Vb 1
\& $test = $Pres\->DefinedFrom();
.Ve
.IP DefinedType 4
.IX Item "DefinedType"
returns 1 if the type attribute is defined in the <presence/>, 0 otherwise.
.Sp
.Vb 1
\&  $test = $Pres\->DefinedType();
.Ve
.IP DefinedStatus 4
.IX Item "DefinedStatus"
returns 1 if <status/> is defined in the <presence/>, 0 otherwise.
.Sp
.Vb 1
\&  $test = $Pres\->DefinedStatus();
.Ve
.IP DefinedPriority 4
.IX Item "DefinedPriority"
returns 1 if <priority/> is defined in the <presence/>, 0 otherwise.
.Sp
.Vb 1
\&  $test = $Pres\->DefinedPriority();
.Ve
.IP DefinedShow 4
.IX Item "DefinedShow"
returns 1 if <show/> is defined in the <presence/>, 0 otherwise.
.Sp
.Vb 1
\&  $test = $Pres\->DefinedShow();
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
Originally authored by Ryan Eatmon.
.PP
Previously maintained by Eric Hacker.
.PP
Currently maintained by Darian Anthony Patrick.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
This module is free software, you can redistribute it and/or modify it
under the LGPL 2.1.