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();
    $from     = $Pres->GetFrom();
    $type     = $Pres->GetType();
    $status   = $Pres->GetStatus();
    $priority = $Pres->GetPriority();
    $meta     = $Pres->GetMeta();
    $icon     = $Pres->GetIcon();
    $show     = $Pres->GetShow();
    $loc      = $Pres->GetLoc();
    @xTags    = $Mess->GetX();
    @xTags    = $Mess->GetX("my:namespace");
    @xTrees   = $Mess->GetXTrees();
    @xTrees   = $Mess->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->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");

METHODS

Retrieval functions

  GetTo() - returns a string with the Jabber Identifier of the 
            person who is going to receive the <presence/>.

  GetFrom() - returns a string with the Jabber Identifier of the 
              person who sent the <presence/>.

  GetType() - returns a string with the type <presence/> this is.

  GetStatus() - returns a string with the current status of the sender's
                resource.

  GetPriority() - returns an integer with the priority of the sender's 
                  resource.

  GetMeta() - returns a string with the meta data of the sender's client.

  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

  SetPresence(to=>string,         - set multiple fields in the <presence/>
              type=>string,         at one time.  This is a cumulative
              status=>string,       and over writing action.  If you set
              priority=>integer,    the "to" attribute twice, the second
              meta=>string,         setting is what is used.  If you set
              icon=>string,         the status, and then set the priority
              show=>string,         then both will be in the <presence/>
              loc=>string)          tag.  For valid settings read the
                                    specific Set functions below.

  SetTo(string) - sets the to attribute.  Must be a valid Jabber Identifier 
                  or the server will return an error message.
                  (ie.  jabber:bob@jabber.org, etc...)

  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.

AUTHOR

By Ryan Eatmon in December of 1999 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.