GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  ANYEVENT::XMPP::EXT::RECEIPTS (3)

.ds Aq ’

NAME

AnyEvent::XMPP::Ext::Receipts - XEP-0184 message receipts

CONTENTS

SYNOPSIS



    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);



DESCRIPTION

This module adds support for XEP-0184 message receipts.

Message receipts provide a way to verify that messages were received by the recipient, as long as the recipient’s client supports it.

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).

METHODS

<B>new (%args)B> Creates a new receipts handle.

The following keys can be specified:
<B>discoB> An AnyEvent::XMPP::Ext::Disco object so that it can be figured out whether the recipient supports message receipts (via service discovery).

This is required.

<B>debugB> If you pass a value that evaluates to true, debug messages will be printed to STDOUT.
<B>auto_resendB> 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.

Defaults to 30 (seconds).

Set to 0 to disable automatic re-sending.

Here is an example with all keys set:



    my $receipts = AnyEvent::XMPP::Ext::Receipts->new(
        disco => $disco,
        auto_resend => 30,
        debug => 1,
    );



AUTHOR

Michael Stapelberg, <michael at stapelberg.de>

COPYRIGHT & LICENSE

Copyright 2012 Michael Stapelberg

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 ANYEVENT::XMPP::EXT::RECEIPTS (3) 2014-02-16

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.