.\" -*- 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::Registration 3" .TH AnyEvent::XMPP::Ext::Registration 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::Ext::Registration \- Handles all tasks of in band registration .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& my $con = AnyEvent::XMPP::Connection\->new (...); \& \& $con\->reg_cb (stream_pre_authentication => sub { \& my ($con) = @_; \& my $reg = AnyEvent::XMPP::Ext::Registration\->new (connection => $con); \& \& $reg\->send_registration_request (sub { \& my ($reg, $form, $error) = @_; \& \& if ($error) { \& # error handling \& \& } else { \& my $af = $form\->try_fillout_registration ("tester", "secret"); \& \& $reg\->submit_form ($af, sub { \& my ($reg, $ok, $error, $form) = @_; \& \& if ($ok) { # registered successfully! \& $con\->authenticate \& \& } else { # error \& if ($form) { # we got an alternative form! \& # fill it out and submit it with C again \& } \& } \& }); \& } \& }); \& \& 0 \& }); .Ve .SH DESCRIPTION .IX Header "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. .SH METHODS .IX Header "METHODS" .IP "\fBnew (%args)\fR" 4 .IX Item "new (%args)" This is the constructor for a registration object. .RS 4 .IP connection 4 .IX Item "connection" This must be a AnyEvent::XMPP::Connection (or some other subclass of that) object. .Sp This argument is required. .RE .RS 4 .RE .IP "\fBsend_registration_request ($cb)\fR" 4 .IX Item "send_registration_request ($cb)" This method sends a register form request. \&\f(CW$cb\fR will be called when either the form arrived or an error occured. .Sp The first argument of \f(CW$cb\fR is always \f(CW$self\fR. If the form arrived the second argument of \f(CW$cb\fR will be a AnyEvent::XMPP::Ext::RegisterForm object. If an error occured the second argument will be undef and the third argument will be a AnyEvent::XMPP::Error::Register object. .Sp For hints how AnyEvent::XMPP::Ext::RegisterForm should be filled out look in XEP\-0077. Either you have legacy form fields, out of band data or a data form. .Sp See also try_fillout_registration in AnyEvent::XMPP::Ext::RegisterForm. .IP "\fBsend_unregistration_request ($cb)\fR" 4 .IX Item "send_unregistration_request ($cb)" This method sends an unregistration request. .Sp For description of the semantics of the callback in \f(CW$cb\fR plase look in the description of the \f(CW\*(C`submit_form\*(C'\fR method below. .ie n .IP "\fBsend_password_change_request ($username, \fR\fB$password\fR\fB, \fR\fB$cb\fR\fB)\fR" 4 .el .IP "\fBsend_password_change_request ($username, \fR\f(CB$password\fR\fB, \fR\f(CB$cb\fR\fB)\fR" 4 .IX Item "send_password_change_request ($username, $password, $cb)" This method sends a password change request for the user \f(CW$username\fR with the new password \f(CW$password\fR. .Sp For description of the semantics of the callback in \f(CW$cb\fR plase look in the description of the \f(CW\*(C`submit_form\*(C'\fR method below. .ie n .IP "\fBsubmit_form ($form, \fR\fB$cb\fR\fB)\fR" 4 .el .IP "\fBsubmit_form ($form, \fR\f(CB$cb\fR\fB)\fR" 4 .IX Item "submit_form ($form, $cb)" This method submits the \f(CW$form\fR which should be of type AnyEvent::XMPP::Ext::RegisterForm and should be an answer form. .Sp \&\f(CW$con\fR is the connection on which to send this form. .Sp \&\f(CW$cb\fR 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 AnyEvent::XMPP::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 AnyEvent::XMPP::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 AnyEvent::XMPP::Ext::RegisterForm which you should fill out and send again with \f(CW\*(C`submit_form\*(C'\fR. .Sp For the semantics of such an error form see also XEP\-0077. .SH AUTHOR .IX Header "AUTHOR" Robin Redeker, \f(CW\*(C`\*(C'\fR, JID: \f(CW\*(C`\*(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.