.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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 "AnyEvent::XMPP::Namespaces 3"
.TH AnyEvent::XMPP::Namespaces 3 2024-07-13 "perl v5.38.2" "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
AnyEvent::XMPP::Namespaces \- XMPP namespace collection and aliasing class
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&   use AnyEvent::XMPP::Namespaces qw/xmpp_ns set_xmpp_ns_alias/;
\&
\&   set_xmpp_ns_alias (stanzas => \*(Aqurn:ietf:params:xml:ns:xmpp\-stanzas\*(Aq);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module represents a simple namespaces aliasing mechanism to ease handling
of namespaces when traversing AnyEvent::XMPP::Node objects and writing XML
with AnyEvent::XMPP::Writer.
.SH "XMPP NAMESPACES"
.IX Header "XMPP NAMESPACES"
There are already some aliases defined for the XMPP XML namespaces
which make handling of namepsaces a bit easier:
.PP
.Vb 2
\&   stream  => http://etherx.jabber.org/streams
\&   xml     => http://www.w3.org/XML/1998/namespace
\&
\&   streams => urn:ietf:params:xml:ns:xmpp\-streams
\&   session => urn:ietf:params:xml:ns:xmpp\-session
\&   stanzas => urn:ietf:params:xml:ns:xmpp\-stanzas
\&   sasl    => urn:ietf:params:xml:ns:xmpp\-sasl
\&   bind    => urn:ietf:params:xml:ns:xmpp\-bind
\&   tls     => urn:ietf:params:xml:ns:xmpp\-tls
\&
\&   client  => jabber:client
\&   roster  => jabber:iq:roster
\&   version => jabber:iq:version
\&   auth    => jabber:iq:auth
\&
\&   iq_oob  => jabber:iq:oob
\&   x_oob   => jabber:x:oob
\&
\&   disco_info  => http://jabber.org/protocol/disco#info
\&   disco_items => http://jabber.org/protocol/disco#items
\&
\&   register    => http://jabber.org/features/iq\-register
\&   iqauth      => http://jabber.org/features/iq\-auth
\&   data_form   => jabber:x:data
\&
\&   ping        => urn:xmpp:ping
\&
\&   vcard       => vcard\-temp
\&
\&   pubsub      => http://jabber.org/protocol/pubsub
\&   pubsub_own  => http://jabber.org/protocol/pubsub#owner
\&   pubsub_ev   => http://jabber.org/protocol/pubsub#event
.Ve
.SH FUNCTIONS
.IX Header "FUNCTIONS"
.IP "\fBxmpp_ns ($alias)\fR" 4
.IX Item "xmpp_ns ($alias)"
Returns am uri for the registered \f(CW$alias\fR or undef if none exists.
.IP "\fBxmpp_ns_maybe ($alias_or_namespace_uri)\fR" 4
.IX Item "xmpp_ns_maybe ($alias_or_namespace_uri)"
This method tries to find whether there is a alias \f(CW$alias_or_namespace_uri\fR
registered and if not it returns \f(CW$alias_or_namespace_uri\fR.
.ie n .IP "\fBset_xmpp_ns_alias ($alias, \fR\fB$namespace_uri\fR\fB)\fR" 4
.el .IP "\fBset_xmpp_ns_alias ($alias, \fR\f(CB$namespace_uri\fR\fB)\fR" 4
.IX Item "set_xmpp_ns_alias ($alias, $namespace_uri)"
Sets an \f(CW$alias\fR for the \f(CW$namespace_uri\fR.
.SH AUTHOR
.IX Header "AUTHOR"
Robin Redeker, \f(CW\*(C`<elmex at ta\-sa.org>\*(C'\fR, JID: \f(CW\*(C`<elmex at jabber.org>\*(C'\fR
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2007, 2008 Robin Redeker, all rights reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.