.\" Automatically generated by Pod::Man 4.14 (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
..
.\" 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 "AnyEvent::XMPP::Ext::Receipts 3pm"
.TH AnyEvent::XMPP::Ext::Receipts 3pm "2022-12-06" "perl v5.36.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"
AnyEvent::XMPP::Ext::Receipts \- XEP\-0184 message receipts
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use AnyEvent::XMPP::Ext::Disco;
\&    use AnyEvent::XMPP::Ext::Receipts;
\&
\&    my $disco = AnyEvent::XMPP::Ext::Disco\->new();
\&    $xmpp\->add_extension($disco);
\&
\&    my $receipts = AnyEvent::XMPP::Ext::Receipts\->new(disco => $disco);
\&    $xmpp\->add_extension($receipts);
\&
\&    $disco\->enable_feature($receipts\->disco_feature);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module adds support for \s-1XEP\-0184\s0 message receipts.
.PP
Message receipts provide a way to verify that messages were received by the
recipient, as long as the recipient's client supports it.
.PP
Note that you need to send messages with message receipts to full Jabber IDs
(e.g. jabber@example.com/android3948128), not bare Jabber IDs (e.g.
jabber@example.com).
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBnew (%args)\fR" 4
.IX Item "new (%args)"
Creates a new receipts handle.
.Sp
The following keys can be specified:
.RS 4
.IP "\fBdisco\fR" 4
.IX Item "disco"
An \f(CW\*(C`AnyEvent::XMPP::Ext::Disco\*(C'\fR object so that it can be figured out whether
the recipient supports message receipts (via service discovery).
.Sp
This is required.
.IP "\fBdebug\fR" 4
.IX Item "debug"
If you pass a value that evaluates to true, debug messages will be printed to
\&\s-1STDOUT.\s0
.IP "\fBauto_resend\fR" 4
.IX Item "auto_resend"
Amount of time in seconds after which messages will be re-sent when no receipt
was received. Of course messages will only be re-sent if the recipient is known
to support message receipts.
.Sp
Defaults to 30 (seconds).
.Sp
Set to 0 to disable automatic re-sending.
.RE
.RS 4
.Sp
Here is an example with all keys set:
.Sp
.Vb 5
\&    my $receipts = AnyEvent::XMPP::Ext::Receipts\->new(
\&        disco => $disco,
\&        auto_resend => 30,
\&        debug => 1,
\&    );
.Ve
.RE
.SH "AUTHOR"
.IX Header "AUTHOR"
Michael Stapelberg, \f(CW\*(C`<michael at stapelberg.de>\*(C'\fR
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2012 Michael Stapelberg
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.