.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Net::Jabber::Log 3pm"
.TH Net::Jabber::Log 3pm "2017-10-19" "perl v5.26.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::Log \- Jabber Log Module
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  Net::Jabber::Log is a companion to the Net::Jabber module.
\&  It provides the user a simple interface to set and retrieve all 
\&  parts of a Jabber Log.
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.Vb 2
\&  To initialize the Log with a Jabber <log/> you must pass it the 
\&  XML::Parser Tree array.  For example:
\&
\&    my $log = new Net::Jabber::Log(@tree);
\&
\&  There has been a change from the old way of handling the callbacks.
\&  You no longer have to do the above, a Net::Jabber::Log object is passed
\&  to the callback function for the log:
\&
\&    use Net::Jabber;
\&
\&    sub log {
\&      my ($Log) = @_;
\&      .
\&      .
\&      .
\&    }
\&
\&  You now have access to all of the retrieval functions available.
\&
\&  To create a new log to send to the server:
\&
\&    use Net::Jabber;
\&
\&    $Log = new Net::Jabber::Log();
\&
\&  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 4
\&    $from       = $Log\->GetFrom();
\&    $fromJID    = $Log\->GetFrom("jid");
\&    $type       = $Log\->GetType();
\&    $data       = $Log\->GetData();
\&
\&    $str        = $Log\->GetXML();
\&    @log        = $Log\->GetTree();
.Ve
.SS "Creation functions"
.IX Subsection "Creation functions"
.Vb 6
\&    $Log\->SetLog(type=>"error",
\&                 from=>"users.jabber.org",
\&                 data=>"The moon is full... I can\*(Aqt run anymore.");
\&    $Log\->SetFrom("foo.jabber.org");
\&    $Log\->SetType("warn");
\&    $Log\->SetData("I can\*(Aqt find a config file.  Using defaults.");
.Ve
.SS "Test functions"
.IX Subsection "Test functions"
.Vb 2
\&    $test = $Log\->DefinedFrom();
\&    $test = $Log\->DefinedType();
.Ve
.SH "METHODS"
.IX Header "METHODS"
.SS "Retrieval functions"
.IX Subsection "Retrieval functions"
.Vb 5
\&  GetFrom()      \-  returns either a string with the Jabber Identifier,
\&  GetFrom("jid")    or a Net::Jabber::JID object for the person who
\&                    sent the <log/>.  To get the JID object set 
\&                    the string to "jid", otherwise leave blank for the 
\&                    text string.
\&
\&  GetType() \- returns a string with the type <log/> this is.
\&
\&  GetData() \- returns a string with the cdata of the <log/>.
\&
\&  GetXML() \- returns the XML string that represents the <log/>.
\&             This is used by the Send() function in Client.pm to send
\&             this object as a Jabber Log.
\&
\&  GetTree() \- returns an array that contains the <log/> tag
\&              in XML::Parser Tree format.
.Ve
.SS "Creation functions"
.IX Subsection "Creation functions"
.Vb 9
\&  SetLog(from=>string|JID, \- set multiple fields in the <log/>
\&         type=>string,       at one time.  This is a cumulative
\&         data=>string)       and over writing action.  If you set
\&                             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 <log/>
\&                             tag.  For valid settings read the
\&                             specific Set functions below.
\&
\&  SetFrom(string) \- sets the from attribute.  You can either pass a string
\&  SetFrom(JID)      or a JID object.  They must be valid Jabber 
\&                    Identifiers or the server will return an error log.
\&                    (ie.  jabber:bob@jabber.org/Silent Bob, etc...)
\&
\&  SetType(string) \- sets the type attribute.  Valid settings are:
\&
\&                    notice     general logging
\&                    warn       warning
\&                    alert      critical error (can still run but not 
\&                               correctly)
\&                    error      fatal error (cannot run anymore)
\&
\&  SetData(string) \- sets the cdata of the <log/>.
.Ve
.SS "Test functions"
.IX Subsection "Test functions"
.Vb 2
\&  DefinedFrom() \- returns 1 if the from attribute is defined in the 
\&                  <log/>, 0 otherwise.
\&
\&  DefinedType() \- returns 1 if the type attribute is defined in the 
\&                  <log/>, 0 otherwise.
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
By Ryan Eatmon in May of 2000 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.