Net::XMPP::JID - XMPP JID Module

- NAME
- SYNOPSIS
- DESCRIPTION
  - Retrieval functions
  - Creation functions
- METHODS
  - Retrieval functions
  - Creation functions
- AUTHOR
- COPYRIGHT

# NAME

Net::XMPP::JID - XMPP JID Module

# SYNOPSIS

Net::XMPP::JID is a companion to the Net::XMPP module. It provides the user a simple interface to set and retrieve all parts of a Jabber ID (userid on a server).

# DESCRIPTION

To initialize the JID you must pass it the string that represents the jid from the XML packet. Inside the XMPP modules this is done automatically and the JID object is returned instead of a string. For example, in the callback function for the XMPP object foo:

        use Net::XMPP;

        sub foo {
          my $foo = Net::XMPP::Foo->new(@_);
          my $from = $foo->GetFrom();
          my $JID = Net::XMPP::JID->new($from);
          .
          .
          .
        }

You now have access to all of the retrieval functions available.

To create a new JID to send to the server:

        use Net::XMPP;

        $JID = Net::XMPP::JID->new();

Now you can call the creation functions below to populate the tag before sending it.

## Retrieval functions

        $userid   = $JID->GetUserID();
        $server   = $JID->GetServer();
        $resource = $JID->GetResource();

        $JID      = $JID->GetJID();
        $fullJID  = $JID->GetJID("full");
        $baseJID  = $JID->GetJID("base");

## Creation functions

        $JID->SetJID(userid=>"bob",
                     server=>"jabber.org",
                     resource=>"Work");

        $JID->SetJID('blue@moon.org/Home');

        $JID->SetUserID("foo");
        $JID->SetServer("bar.net");
        $JID->SetResource("Foo Bar");

# METHODS

## Retrieval functions

GetUserID

        GetUserID()

  returns a string with the userid of the JID. If the string is an address (bob%jabber.org) then the function will return it as an address (bob@jabber.org).

GetServer

        GetServer()

  returns a string with the server of the JID.

GerResource

        GetResource()

  returns a string with the resource of the JID.

GetJID

        GetJID()
        GetJID("full")
        GetJID("base")
      returns a string that represents the JID stored
      within.  If the "full" string is specified, then
      you get the full JID, including Resource, which
      should be used to send to the server.  If the "base",
      string is specified, then you will just get
      user@server, or the base JID.

## Creation functions

SetJID

        SetJID(userid=>string,
               server=>string,
               resource=>string)
        SetJID(string)

  set multiple fields in the jid at one time. This is a cumulative and over writing action. If you set the "userid" attribute twice, the second setting is what is used. If you set the server, and then set the resource then both will be in the jid. If all you pass is a string, then that string is used as the JID. For valid settings read the specific Set functions below.

SetUserID

        SetUserID(string)

  sets the userid. Must be a valid userid or the server will complain if you try to use this JID to talk to the server. If the string is an address then it will be converted to the % form suitable for using as a User ID.

SerServer

        SetServer(string)

  sets the server. Must be a valid host on the network or the server will not be able to talk to it.

SetResource

        SetResource(string)

  sets the resource of the userid to talk to.

# AUTHOR

Originally authored by Ryan Eatmon.

Previously maintained by Eric Hacker.

Currently maintained by Darian Anthony Patrick.

# COPYRIGHT

This module is free software, you can redistribute it and/or modify it under the LGPL 2.1.

Net::XMPP::JID - XMPP JID Module