.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "Net::Jabber::Dialback::Result 3pm"
.TH Net::Jabber::Dialback::Result 3pm "2022-06-16" "perl v5.34.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"
Net::Jabber::Dialback::Result \- Jabber Dialback Result Module
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  Net::Jabber::Dialback::Result 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 Result.
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.Vb 2
\&  To initialize the Result with a Jabber <db:*/> you must pass it
\&  the XML::Stream hash.  For example:
\&
\&    my $dialback = new Net::Jabber::Dialback::Result(%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::Result
\&  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 dialbackResult {
\&      my ($sid,$Result) = @_;
\&      .
\&      .
\&      .
\&    }
\&
\&  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);
\&
\&    $Result = new Net::Jabber::Dialback::Result();
\&
\&  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.
.Ve
.SS "Retrieval functions"
.IX Subsection "Retrieval functions"
.Vb 3
\&    $to         = $Result\->GetTo();
\&    $from       = $Result\->GetFrom();
\&    $type       = $Result\->GetType();
\&
\&    $data       = $Result\->GetData();
\&
\&    $str        = $Result\->GetXML();
\&    @dialback   = $Result\->GetTree();
.Ve
.SS "Creation functions"
.IX Subsection "Creation functions"
.Vb 7
\&    $Result\->SetResult(from=>"jabber.org",
\&                       to=>"jabber.com",
\&                       data=>key);
\&    $Result\->SetTo("jabber.org");
\&    $Result\->SetFrom("jabber.com");
\&    $Result\->SetType("valid");
\&    $Result\->SetData(key);
.Ve
.SS "Test functions"
.IX Subsection "Test functions"
.Vb 3
\&    $test = $Result\->DefinedTo();
\&    $test = $Result\->DefinedFrom();
\&    $test = $Result\->DefinedType();
.Ve
.SH "METHODS"
.IX Header "METHODS"
.SS "Retrieval functions"
.IX Subsection "Retrieval functions"
.Vb 2
\&  GetTo() \-  returns a string with server that the <db:result/> is being
\&             sent to.
\&
\&  GetFrom() \-  returns a string with server that the <db:result/> is being
\&               sent from.
\&
\&  GetType() \- returns a string with the type <db:result/> this is.
\&
\&  GetData() \- returns a string with the cdata of the <db:result/>.
\&
\&  GetXML() \- returns the XML string that represents the <db:result/>.
\&             This is used by the Send() function in Server.pm to send
\&             this object as a Jabber Dialback Result.
\&
\&  GetTree() \- returns an array that contains the <db:result/> tag
\&              in XML::Parser::Tree format.
.Ve
.SS "Creation functions"
.IX Subsection "Creation functions"
.Vb 9
\&  SetResult(to=>string,   \- set multiple fields in the <db:result/>
\&            from=>string,   at one time.  This is a cumulative
\&            type=>string,   and over writing action.  If you set
\&            data=>string)   the "from" attribute twice, the second
\&                            setting is what is used.  If you set
\&                            the type, and then set the data
\&                            then both will be in the <db:result/>
\&                            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
\&
\&  SetData(string) \- sets the cdata of the <db:result/>.
.Ve
.SS "Test functions"
.IX Subsection "Test functions"
.Vb 2
\&  DefinedTo() \- returns 1 if the to attribute is defined in the 
\&                <db:result/>, 0 otherwise.
\&
\&  DefinedFrom() \- returns 1 if the from attribute is defined in the 
\&                  <db:result/>, 0 otherwise.
\&
\&  DefinedType() \- returns 1 if the type attribute is defined in the 
\&                  <db:result/>, 0 otherwise.
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
By Ryan Eatmon in May of 2001 for http://jabber.org..
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This module is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.