.\" -*- 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::JID 3pm"
.TH Net::XMPP::JID 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::JID \- XMPP JID Module
.SH SYNOPSIS
.IX Header "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).
.SH DESCRIPTION
.IX Header "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:
.PP
.Vb 1
\&    use Net::XMPP;
\&
\&    sub foo {
\&      my $foo = Net::XMPP::Foo\->new(@_);
\&      my $from = $foo\->GetFrom();
\&      my $JID = Net::XMPP::JID\->new($from);
\&      .
\&      .
\&      .
\&    }
.Ve
.PP
You now have access to all of the retrieval functions available.
.PP
To create a new JID to send to the server:
.PP
.Vb 1
\&    use Net::XMPP;
\&
\&    $JID = Net::XMPP::JID\->new();
.Ve
.PP
Now you can call the creation functions below to populate the tag
before sending it.
.SS "Retrieval functions"
.IX Subsection "Retrieval functions"
.Vb 3
\&    $userid   = $JID\->GetUserID();
\&    $server   = $JID\->GetServer();
\&    $resource = $JID\->GetResource();
\&
\&    $JID      = $JID\->GetJID();
\&    $fullJID  = $JID\->GetJID("full");
\&    $baseJID  = $JID\->GetJID("base");
.Ve
.SS "Creation functions"
.IX Subsection "Creation functions"
.Vb 3
\&    $JID\->SetJID(userid=>"bob",
\&                 server=>"jabber.org",
\&                 resource=>"Work");
\&
\&    $JID\->SetJID(\*(Aqblue@moon.org/Home\*(Aq);
\&
\&    $JID\->SetUserID("foo");
\&    $JID\->SetServer("bar.net");
\&    $JID\->SetResource("Foo Bar");
.Ve
.SH METHODS
.IX Header "METHODS"
.SS "Retrieval functions"
.IX Subsection "Retrieval functions"
.IP GetUserID 4
.IX Item "GetUserID"
.Vb 1
\&  GetUserID()
.Ve
.Sp
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).
.IP GetServer 4
.IX Item "GetServer"
.Vb 1
\&  GetServer()
.Ve
.Sp
returns a string with the server of the JID.
.IP GerResource 4
.IX Item "GerResource"
.Vb 1
\&  GetResource()
.Ve
.Sp
returns a string with the resource of the JID.
.IP GetJID 4
.IX Item "GetJID"
.Vb 9
\&  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.
.Ve
.SS "Creation functions"
.IX Subsection "Creation functions"
.IP SetJID 4
.IX Item "SetJID"
.Vb 4
\&  SetJID(userid=>string,  
\&         server=>string,  
\&         resource=>string)
\&  SetJID(string)
.Ve
.Sp
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.
.IP SetUserID 4
.IX Item "SetUserID"
.Vb 1
\&  SetUserID(string)
.Ve
.Sp
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.
.IP SerServer 4
.IX Item "SerServer"
.Vb 1
\&  SetServer(string)
.Ve
.Sp
sets the server.  Must be a valid host on the
network or the server will not be able to talk
to it.
.IP SetResource 4
.IX Item "SetResource"
.Vb 1
\&  SetResource(string)
.Ve
.Sp
sets the resource of the userid to talk to.
.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.