.\" -*- 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::IM::Delayed 3"
.TH AnyEvent::XMPP::IM::Delayed 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::IM::Delayed \- A delayed "XML" stanza
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module handles the delayed fields of stanzas and is a superclass of
AnyEvent::XMPP::IM::Message and AnyEvent::XMPP::IM::Presence.
.SH METHODS
.IX Header "METHODS"
.IP \fBnew\fR 4
.IX Item "new"
The constructor takes no arguments and makes just a new object of this class.
.IP "\fBxml_node ()\fR" 4
.IX Item "xml_node ()"
Returns the AnyEvent::XMPP::Node object for this stream error.
.IP "\fBfetch_delay_from_node ($node)\fR" 4
.IX Item "fetch_delay_from_node ($node)"
\&\f(CW$node\fR must be a AnyEvent::XMPP::Node. This method will try to
fetch the delay information from the \f(CW$node\fR. It will look in the lists
of child nodes for the delay elements and set it's values from there.
.IP \fBdelay_from\fR 4
.IX Item "delay_from"
This method returns either the original source of a maybe delayed
stanza. It's the JID of the original entity that sent the stanza.
.Sp
This method returns undef if this stanza was not delayed.
.Sp
And this method returns undef if this stanza had no details about
who sent the message in the first place.
.Sp
To find out whether this stanza was delayed use the \f(CW\*(C`delay_stamp\*(C'\fR
method.
.IP \fBdelay_stamp\fR 4
.IX Item "delay_stamp"
This method returns the timestamp in XMPP format which can be fed
to the \f(CW\*(C`from_xmpp_datetime\*(C'\fR function documented in AnyEvent::XMPP::Util.
.Sp
(Please note that this might be a newstyle XEP\-0087 timestamp or
old style legacy timestamp)
.Sp
If the stanza was not delayed this method returns undef.
.IP \fBdelay_reason\fR 4
.IX Item "delay_reason"
This method might return a human readable string containing the reason
why the stanza was delayed.
.Sp
Will be undef if stanza contained no delay.
.IP \fBis_delayed\fR 4
.IX Item "is_delayed"
If this method returns a true value then this stanza was delayed.
Otherwise it returns undef.
.SH AUTHOR
.IX Header "AUTHOR"
Robin Redeker, \f(CW\*(C`<elmex at ta\-sa.org>\*(C'\fR, JID: \f(CW\*(C`<elmex at jabber.org>\*(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.