NAME
Net::Jabber::Presence - Jabber Presence Module
SYNOPSIS
Net::Jabber::Presence is a companion to the Net::Jabber module.
It provides the user a simple interface to set and retrieve all
parts of a Jabber Presence.DESCRIPTION
To initialize the Presence with a Jabber <presence/> you must pass it
the XML::Parser Tree array from the Net::Jabber::Client module. In the
callback function for the presence:
use Net::Jabber;
sub presence {
my $presence = new Net::Jabber::Presence(@_);
.
.
.
}
You now have access to all of the retrieval functions available.
To create a new presence to send to the server:
use Net::Jabber;
$Pres = new Net::Jabber::Presence();
Now you can call the creation functions below to populate the tag before
sending it.
For more information about the array format being passed to the CallBack
please read the Net::Jabber::Client documentation.Retrieval functions
$to = $Pres->GetTo();
$toJID = $Pres->GetTo("jid");
$from = $Pres->GetFrom();
$fromJID = $Pres->GetFrom("jid");
$etherxTo = $Pres->GetEtherxTo();
$etherxFrom = $Pres->GetEtherxFrom();
$type = $Pres->GetType();
$status = $Pres->GetStatus();
$priority = $Pres->GetPriority();
$meta = $Pres->GetMeta();
$icon = $Pres->GetIcon();
$show = $Pres->GetShow();
$loc = $Pres->GetLoc();
@xTags = $Pres->GetX();
@xTags = $Pres->GetX("my:namespace");
@xTrees = $Pres->GetXTrees();
@xTrees = $Pres->GetXTrees("my:namespace");
$str = $Pres->GetXML();
@presence = $Pres->GetTree();Creation functions
$Pres->SetPresence(TYPE=>"online",
StatuS=>"Open for Business",
iCoN=>"normal");
$Pres->SetTo("bob\@jabber.org");
$Pres->SetFrom("jojo\@jabber.org");
$Pres->SetEtherxTo("jabber.org");
$Pres->SetEtherxFrom("transport.jabber.org");
$Pres->SetType("unavailable");
$Pres->SetStatus("Taking a nap");
$Pres->SetPriority(10);
$Pres->SetMeta("PerlClient/1.0");
$Pres->SetIcon("zzz");
$Pres->SetShow("away");
$Pres->SetLoc("Lat: 32.91206 Lon: -96.75097");
$X = $Pres->NewX("jabber:x:delay");
$X = $Pres->NewX("my:namespace");
$Reply = $Pres->Reply();
$Reply = $Pres->Reply(template=>"client");
$Reply = $Pres->Reply(template=>"transport",
type=>"subscribed");METHODS
Retrieval functions
GetTo() - returns either a string with the Jabber Identifier,
GetTo("jid") or a Net::Jabber::JID object for the person who is
going to receive the <presence/>. To get the JID
object set the string to "jid", otherwise leave
blank for the text string.
GetFrom() - returns either a string with the Jabber Identifier,
GetFrom("jid") or a Net::Jabber::JID object for the person who
sent the <presence/>. To get the JID object set
the string to "jid", otherwise leave blank for the
text string.
GetEtherxTo(string) - returns the etherx:to attribute. This is for
Transport writers who need to communicate with
Etherx.
GetEtherxFrom(string) - returns the etherx:from attribute. This is for
Transport writers who need to communicate with
Etherx.
GetType() - returns a string with the type <presence/> this is.
GetStatus() - returns a string with the current status of the resource.
GetPriority() - returns an integer with the priority of the resource
The default is 0 if there is no priority in this presence.
GetMeta() - returns a string with the meta data of the client of the sender.
GetIcon() - returns a string with the icon the client should display.
GetShow() - returns a string with the state the client should show.
GetLoc() - returns a string with the location the sender is at.
GetX(string) - returns an array of Net::Jabber::X objects. The string can
either be empty or the XML Namespace you are looking for.
If empty then GetX returns every <x/> tag in the
<presence/>. If an XML Namespace is sent then GetX
returns every <x/> tag with that Namespace.
GetXTrees(string) - returns an array of XML::Parser::Tree objects. The
string can either be empty or the XML Namespace you
are looking for. If empty then GetXTrees returns every
<x/> tag in the <presence/>. If an XML Namespace is
sent then GetXTrees returns every <x/> tag with that
Namespace.
GetXML() - returns the XML string that represents the <presence/>.
This is used by the Send() function in Client.pm to send
this object as a Jabber Presence.
GetTree() - returns an array that contains the <presence/> tag
in XML::Parser Tree format.Creation functions
# # todo: add etherxto and from to the list... #
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=>integer, the "to" attribute twice, the second
priority=>string, 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.
SetTo(string) - sets the to attribute. You can either pass a string
SetTo(JID) or a JID object. They must be valid Jabber
Identifiers or the server will return an error message.
(ie. jabber:bob@jabber.org/Silent Bob, etc...)
SetFrom(string) - sets the from attribute. You can either pass a string
SetFrom(JID) or a JID object. They must be valid Jabber
Identifiers or the server will return an error message.
(ie. jabber:bob@jabber.org/Silent Bob, etc...)
SetEtherxTo(string) - sets the etherx:to attribute. This is for
Transport writers who need to communicate with
Etherx.
SetEtherxFrom(string) - sets the etherx:from attribute. This is for
Transport writers who need to communicate with
Etherx.
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
SetStatus(string) - sets the status tag to be whatever string the user
wants associated with that resource.
SetPriority(integer) - sets the priority of this resource. The highest
resource attached to the jabber account is the
one that receives the messages.
SetMeta(string) - sets the meta data that tells everyone something about
<DRAFT) your client.
(ie. device/pager, PerlClient/1.0, etc...)
SetIcon(string) - sets the name or URL of the icon to display for this
(DRAFT) resource.
SetShow(string) - sets the name of the default symbol to display for this
(DRAFT) resource.
SetLoc(string) - sets the location that the user wants associated with
(DRAFT) the resource.
NewX(string) - creates a new Net::Jabber::X object with the namespace
in the string. In order for this function to work with
a custom namespace, you must define and register that
namespace with the X module. For more information
please read the documentation for Net::Jabber::X.
Reply(template=>string, - creates a new Presence object and
type=>string) populates the to/from and
etherxto/etherxfrom fields based
the value of template. The following
templates are available:
client: (default)
just sets the to/from
transport:
transport-reply:
the transport will send the
reply to the sender
The type will be set in the <presence/>.AUTHOR
By Ryan Eatmon in May of 2000 for http://jabber.org..
COPYRIGHT
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.