.\" -*- 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::Ext::Disco 3"
.TH AnyEvent::XMPP::Ext::Disco 3 2023-07-25 "perl v5.38.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
AnyEvent::XMPP::Ext::Disco \- Service discovery manager class for XEP\-0030
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&   use AnyEvent::XMPP::Ext::Disco;
\&
\&   my $con = AnyEvent::XMPP::IM::Connection\->new (...);
\&   $con\->add_extension (my $disco = AnyEvent::XMPP::Ext::Disco\->new);
\&   $disco\->request_items ($con, \*(Aqromeo@montague.net\*(Aq, undef,
\&      sub {
\&         my ($disco, $items, $error) = @_;
\&         if ($error) { print "ERROR:" . $error\->string . "\en" }
\&         else {
\&            ... do something with the $items ...
\&         }
\&      }
\&   );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module represents a service discovery manager class.
You make instances of this class and get a handle to send
discovery requests like described in XEP\-0030.
.PP
It also allows you to setup a disco\-info/items tree
that others can walk and also lets you publish disco information.
.PP
This class is derived from AnyEvent::XMPP::Ext and can be added as extension to
objects that implement the AnyEvent::XMPP::Extendable interface or derive from
it.
.SH METHODS
.IX Header "METHODS"
.IP "\fBnew (%args)\fR" 4
.IX Item "new (%args)"
Creates a new disco handle.
.ie n .IP "\fBset_identity ($category, \fR\fB$type\fR\fB, \fR\fB$name\fR\fB)\fR" 4
.el .IP "\fBset_identity ($category, \fR\f(CB$type\fR\fB, \fR\f(CB$name\fR\fB)\fR" 4
.IX Item "set_identity ($category, $type, $name)"
This sets the identity of the top info node.
.Sp
\&\f(CW$name\fR is optional and can be undef.  Please note that \f(CW$name\fR will
overwrite all previous set names! If \f(CW$name\fR is undefined then
no previous set name is overwritten.
.Sp
For a list of valid identites look at:
.Sp
.Vb 1
\&   http://www.xmpp.org/registrar/disco\-categories.html
.Ve
.Sp
Valid identity \f(CW$type\fRs for \f(CW\*(C`$category = "client"\*(C'\fR may be:
.Sp
.Vb 6
\&   bot
\&   console
\&   handheld
\&   pc
\&   phone
\&   web
.Ve
.ie n .IP "\fBunset_identity ($category, \fR\fB$type\fR\fB)\fR" 4
.el .IP "\fBunset_identity ($category, \fR\f(CB$type\fR\fB)\fR" 4
.IX Item "unset_identity ($category, $type)"
This function removes the identity \f(CW$category\fR and \f(CW$type\fR.
.IP "\fBenable_feature ($uri)\fR" 4
.IX Item "enable_feature ($uri)"
This method enables the feature \f(CW$uri\fR, where \f(CW$uri\fR
should be one of the values from the \fBName\fR column on:
.Sp
.Vb 1
\&   http://www.xmpp.org/registrar/disco\-features.html
.Ve
.Sp
These features are enabled by default:
.Sp
.Vb 2
\&   http://jabber.org/protocol/disco#info
\&   http://jabber.org/protocol/disco#items
.Ve
.Sp
You can pass also a list of features you want to enable to \f(CW\*(C`enable_feature\*(C'\fR!
.IP "\fBdisable_feature ($uri)\fR" 4
.IX Item "disable_feature ($uri)"
This method enables the feature \f(CW$uri\fR, where \f(CW$uri\fR
should be one of the values from the \fBName\fR column on:
.Sp
.Vb 1
\&   http://www.xmpp.org/registrar/disco\-features.html
.Ve
.Sp
You can pass also a list of features you want to disable to \f(CW\*(C`disable_feature\*(C'\fR!
.ie n .IP "\fBrequest_items ($con, \fR\fB$dest\fR\fB, \fR\fB$node\fR\fB, \fR\fB$cb\fR\fB)\fR" 4
.el .IP "\fBrequest_items ($con, \fR\f(CB$dest\fR\fB, \fR\f(CB$node\fR\fB, \fR\f(CB$cb\fR\fB)\fR" 4
.IX Item "request_items ($con, $dest, $node, $cb)"
This method does send a items request to the JID entity \f(CW$from\fR.
\&\f(CW$node\fR is the optional node to send the request to, which can be
undef.
.Sp
\&\f(CW$con\fR must be an instance of AnyEvent::XMPP::Connection or a subclass of it.
The callback \f(CW$cb\fR will be called when the request returns with 3 arguments:
the disco handle, an AnyEvent::XMPP::Ext::Disco::Items object (or undef)
and an AnyEvent::XMPP::Error::IQ object when an error occured and no items
were received.
.Sp
The timeout of the request is the IQ timeout of the connection \f(CW$con\fR.
.Sp
.Vb 3
\&   $disco\->request_items ($con, \*(Aqa@b.com\*(Aq, undef, sub {
\&      my ($disco, $items, $error) = @_;
\&      die $error\->string if $error;
\&
\&      # do something with the items here ;_)
\&   });
.Ve
.ie n .IP "\fBrequest_info ($con, \fR\fB$dest\fR\fB, \fR\fB$node\fR\fB, \fR\fB$cb\fR\fB)\fR" 4
.el .IP "\fBrequest_info ($con, \fR\f(CB$dest\fR\fB, \fR\f(CB$node\fR\fB, \fR\f(CB$cb\fR\fB)\fR" 4
.IX Item "request_info ($con, $dest, $node, $cb)"
This method does send a info request to the JID entity \f(CW$from\fR.
\&\f(CW$node\fR is the optional node to send the request to, which can be
undef.
.Sp
\&\f(CW$con\fR must be an instance of AnyEvent::XMPP::Connection or a subclass of it.
The callback \f(CW$cb\fR will be called when the request returns with 3 arguments:
the disco handle, an AnyEvent::XMPP::Ext::Disco::Info object (or undef)
and an AnyEvent::XMPP::Error::IQ object when an error occured and no items
were received.
.Sp
The timeout of the request is the IQ timeout of the connection \f(CW$con\fR.
.Sp
.Vb 3
\&   $disco\->request_info ($con, \*(Aqa@b.com\*(Aq, undef, sub {
\&      my ($disco, $info, $error) = @_;
\&      die $error\->string if $error;
\&
\&      # do something with info here ;_)
\&   });
.Ve
.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.