NAME

Net::Jabber::Dialback::Verify - Jabber Dialback Verify Module

SYNOPSIS

Net::Jabber::Dialback::Verify is a companion to the Net::Jabber::Dialback
module.  It provides the user a simple interface to set and retrieve all
parts of a Jabber Dialback Verify.

DESCRIPTION

To initialize the Verify with a Jabber <db:*/> you must pass it
the XML::Stream hash.  For example:

  my $dialback = new Net::Jabber::Dialback::Verify(%hash);

There has been a change from the old way of handling the callbacks.
You no longer have to do the above yourself, a NJ::Dialback::Verify
object is passed to the callback function for the message.  Also,
the first argument to the callback functions is the session ID from
XML::Streams.  There are some cases where you might want this
information, like if you created a Client that connects to two servers
at once, or for writing a mini server.

  use Net::Jabber qw(Server);

  sub dialbackVerify {
    my ($sid,$Verify) = @_;
    .
    .
    .
  }

You now have access to all of the retrieval functions available.

To create a new dialback to send to the server:

  use Net::Jabber qw(Server);

  $Verify = new Net::Jabber::Dialback::Verify();

Now you can call the creation functions below to populate the tag before
sending it.

For more information about the array format being passed to the CallBack
please read the Net::Jabber::Client documentation.

Retrieval functions

$to         = $Verify->GetTo();
$from       = $Verify->GetFrom();
$type       = $Verify->GetType();
$id         = $Verify->GetID();
$data       = $Verify->GetData();

$str        = $Verify->GetXML();
@dialback   = $Verify->GetTree();

Creation functions

    $Verify->SetVerify(from=>"jabber.org",
		       to=>"jabber.com",
		       id=>id,
		       data=>key);
    $Verify->SetTo("jabber.org");
    $Verify->SetFrom("jabber.com");
    $Verify->SetType("valid");
    $Verify->SetID(id);
    $Verify->SetData(key);

Test functions

$test = $Verify->DefinedTo();
$test = $Verify->DefinedFrom();
$test = $Verify->DefinedType();
$test = $Verify->DefinedID();

METHODS

Retrieval functions

GetTo() -  returns a string with server that the <db:verify/> is being
           sent to.

GetFrom() -  returns a string with server that the <db:verify/> is being
             sent from.

GetType() - returns a string with the type <db:verify/> this is.

GetID() - returns a string with the id <db:verify/> this is.

GetData() - returns a string with the cdata of the <db:verify/>.

GetXML() - returns the XML string that represents the <db:verify/>.
           This is used by the Send() function in Server.pm to send
           this object as a Jabber Dialback Verify.

GetTree() - returns an array that contains the <db:verify/> tag
            in XML::Parser::Tree format.

Creation functions

SetVerify(to=>string,   - set multiple fields in the <db:verify/>
          from=>string,   at one time.  This is a cumulative
          type=>string,   and over writing action.  If you set
          id=>string,     the "from" attribute twice, the second
          data=>string)   setting is what is used.  If you set
                          the type, and then set the data
                          then both will be in the <db:verify/>
                          tag.  For valid settings read the
                          specific Set functions below.

SetTo(string) - sets the to attribute.

SetFrom(string) - sets the from attribute.

SetType(string) - sets the type attribute.  Valid settings are:

                  valid
                  invalid

SetID(string) - sets the id attribute.

SetData(string) - sets the cdata of the <db:verify/>.

Test functions

DefinedTo() - returns 1 if the to attribute is defined in the 
              <db:verify/>, 0 otherwise.

DefinedFrom() - returns 1 if the from attribute is defined in the 
                <db:verify/>, 0 otherwise.

DefinedType() - returns 1 if the type attribute is defined in the 
                <db:verify/>, 0 otherwise.

DefinedID() - returns 1 if the id attribute is defined in the 
                <db:verify/>, 0 otherwise.

AUTHOR

By Ryan Eatmon in May of 2001 for http://jabber.org..

COPYRIGHT

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