Net::XMPP::Presence - XMPP Presence Module 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. 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. use Net::XMPP; sub presence { my ($sid,$Pres) = @_; . . . } You now have access to all of the retrieval functions available. To create a new presence to send to the server: use Net::XMPP; $Pres = new Net::XMPP::Presence(); Now you can call the creation functions below to populate the tag before sending it.

Retrieval functions
GetTo() - returns the value in the to='' attribute for the GetTo("jid") <presence/>. 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. $to = $Pres->GetTo(); $toJID = $Pres->GetTo("jid"); GetFrom() - returns the value in the from='' attribute for the GetFrom("jid") <presence/>. 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. $from = $Pres->GetFrom(); $fromJID = $Pres->GetFrom("jid"); GetType() - returns the type='' attribute of the <presence/>. Each presence is one of seven types: 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(); GetStatus() - returns a string with the current status of the resource. $status = $Pres->GetStatus(); GetPriority() - returns an integer with the priority of the resource The default is 0 if there is no priority in this presence. $priority = $Pres->GetPriority(); GetShow() - returns a string with the state the client should show. $show = $Pres->GetShow();

Creation functions
SetPresence(to=>string|JID - set multiple fields in the <presence/> from=>string|JID, at one time. This is a cumulative type=>string, and over writing action. If you set status=>string, the "to" attribute twice, the second priority=>integer, setting is what is used. If you set meta=>string, the status, and then set the priority icon=>string, then both will be in the <presence/> show=>string, tag. For valid settings read the loc=>string) specific Set functions below. $Pres->SetPresence(TYPE=>"away", StatuS=>"Out for lunch"); SetTo(string) - sets the to attribute. You can either pass a string SetTo(JID) or a JID object. They must be valid JIDs or the server will return an error message. (ie. bob@jabber.org/Silent Bob, etc...) $Pres->SetTo("bob\@jabber.org"); SetFrom(string) - sets the from='' attribute. You can either pass SetFrom(JID) 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. $Pres->SetFrom("jojo\@jabber.org"); SetType(string) - sets the type attribute. Valid settings are: 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"); SetStatus(string) - sets the status tag to be whatever string the user wants associated with that resource. $Pres->SetStatus("Taking a nap"); SetPriority(integer) - sets the priority of this resource. The highest resource attached to the xmpp account is the one that receives the messages. $Pres->SetPriority(10); SetShow(string) - sets the name of the icon or string to display for this resource. $Pres->SetShow("away"); Reply(hash) - 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. $Reply = $Pres->Reply(); $Reply = $Pres->Reply(type=>"subscribed");

Removal functions
RemoveTo() - removes the to attribute from the <presence/>. $Pres->RemoveTo(); RemoveFrom() - removes the from attribute from the <presence/>. $Pres->RemoveFrom(); RemoveType() - removes the type attribute from the <presence/>. $Pres->RemoveType(); RemoveStatus() - removes the <status/> element from the <presence/>. $Pres->RemoveStatus(); RemovePriority() - removes the <priority/> element from the <presence/>. $Pres->RemovePriority(); RemoveShow() - removes the <show/> element from the <presence/>. $Pres->RemoveShow();

Test functions
DefinedTo() - returns 1 if the to attribute is defined in the <presence/>, 0 otherwise. $test = $Pres->DefinedTo(); DefinedFrom() - returns 1 if the from attribute is defined in the <presence/>, 0 otherwise. $test = $Pres->DefinedFrom(); DefinedType() - returns 1 if the type attribute is defined in the <presence/>, 0 otherwise. $test = $Pres->DefinedType(); DefinedStatus() - returns 1 if <status/> is defined in the <presence/>, 0 otherwise. $test = $Pres->DefinedStatus(); DefinedPriority() - returns 1 if <priority/> is defined in the <presence/>, 0 otherwise. $test = $Pres->DefinedPriority(); DefinedShow() - returns 1 if <show/> is defined in the <presence/>, 0 otherwise. $test = $Pres->DefinedShow(); Ryan Eatmon This module is free software, you can redistribute it and/or modify it under the LGPL.