/ 
Net-XMPP2-0.04
/ Net::XMPP2::Ext::Registration

NAME

Net::XMPP2::Ext::Registration - Handles all tasks of in band registration

SYNOPSIS

my $con = Net::XMPP2::Connection->new (...);

$con->reg_cb (stream_pre_authentication => sub {
   my ($con, $rcont) = @_;

   my $reg = Net::XMPP2::Ext::Registration->new;
   $reg->send_registration_request ($con, sub {
      my ($reg, $con, $form, $error) = @_;

      if ($form) {
         my $res = $form->try_fillout_registration ('myusername', 'mypassword');

         $reg->submit_form ($con, $res, sub {
            my ($reg, $con, $ok, $error) = @_;

            if ($ok) {
               $con->authenticate; # just make sure the connection knows your
                                   # username and password :-)
            } else {
               print "error: " . $error->string . "\n";
            }
         });

      } else {
         print "error: " . $error->string . "\n";
      }
   });

   $$rcont = 0;
   0
});

DESCRIPTION

This module handles all tasks of in band registration that are possible and specified by XEP-0077. It's mainly a helper class that eases some tasks such as submitting and retrieving a form.

METHODS

new (%args)

This is the constructor for a registration object.

connection

This must be a Net::XMPP2::Connection (or some other subclass of that) object.

This argument is required.

send_registration_request ($cb)

This method sends a register form request. $cb will be called when either the form arrived or an error occured.

The first argument of $cb is always $self. If the form arrived the second argument of $cb will be a Net::XMPP2::Ext::RegisterForm object. If an error occured the second argument will be undef and the third argument will be a Net::XMPP2::Error::Register object.

For hints how Net::XMPP2::Ext::RegisterForm should be filled out look in XEP-0077. Either you have legacy form fields, out of band data or a data form.

See also try_fillout_registration in Net::XMPP2::Ext::RegisterForm.

send_unregistration_request
submit_form ($form, $cb)

This method submits the $form which should be of type Net::XMPP2::Ext::RegisterForm and should be an answer form.

$con is the connection on which to send this form.

$cb is the callback that will be called once the form has been submitted and either an error or success was received. The first argument to the callback will be the Net::XMPP2::Ext::Registration object, the second will be a boolean value that is true when the form was successfully transmitted and everything is fine. If the second argument is false then the third argument is a Net::XMPP2::Error::Register object. If the error contained a data form which is required to successfully make the request then the fourth argument will be a Net::XMPP2::Ext::RegisterForm which you should fill out and send again with submit_form.

For the semantics of such an error form see also XEP-0077.

AUTHOR

Robin Redeker, <elmex at ta-sa.org>, JID: <elmex at jabber.org>

COPYRIGHT & LICENSE

Copyright 2007 Robin Redeker, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.