NAME¶
AnyEvent::XMPP::IM::Roster - Instant messaging roster for XMPP
SYNOPSIS¶
my $con = AnyEvent::XMPP::IM::Connection->new (...);
...
my $ro = $con->roster;
if (my $c = $ro->get_contact ('test@example.com')) {
$c->make_message ()->add_body ("Hello there!")->send;
}
DESCRIPTION¶
This module represents a class for roster objects which contain contact
information.
It manages the roster of a JID connected by an AnyEvent::XMPP::IM::Connection.
It manages also the presence information that is received.
You get the roster by calling the "roster" method on an
AnyEvent::XMPP::IM::Connection object. There is no other way.
METHODS¶
- is_retrieved
- Returns true if this roster was fetched from the server or
false if this roster hasn't been retrieved yet.
- new_contact ($jid, $name,
$groups , $cb)
- This method sends a roster item creation request to the
server. $jid is the JID of the contact. $name is the nickname of the
contact, which can be undef. $groups should be a array reference
containing the groups this contact should be in.
The callback in $cb will be called when the creation is finished. The first
argument will be the "AnyEvent::XMPP::IM::Contact" object if no
error occured. The second argument will be an AnyEvent::XMPP::Error::IQ
object if the request resulted in an error.
Please note that the contact you are given in that callback might not yet be
on the roster ("is_on_roster" still returns a false value), if
the server did send the roster push after the iq result of the roster set,
so don't rely on the fact that the contact is on the roster.
- delete_contact ($jid, $cb)
- This method will send a request to the server to delete
this contact from the roster. It will result in cancelling all
subscriptions.
$cb will be called when the request was finished. The first argument to the
callback might be a AnyEvent::XMPP::Error::IQ object if the request
resulted in an error.
- get_contact ($jid)
- Returns the contact on the roster with the JID $jid. (If
$jid is not bare the resource part will be stripped before searching)
NOTE: This method will also return contacts that we have only
presence for. To be sure the contact is on the users roster you need to
call the "is_on_roster" method on the contact.
The return value is an instance of AnyEvent::XMPP::IM::Contact.
- get_contacts
- Returns the contacts that are on this roster as
AnyEvent::XMPP::IM::Contact objects.
NOTE: This method only returns the contacts that have a roster item. If you
haven't retrieved the roster yet the presence information is still stored
but you have to get the contacts without a roster item with the
"get_contacts_off_roster" method. See below.
- get_contacts_off_roster
- Returns the contacts that are not on the roster but for
which we have received presence. Return value is a list of
AnyEvent::XMPP::IM::Contact objects.
See also documentation of "get_contacts" method of
AnyEvent::XMPP::IM::Roster above.
- get_own_contact
- This method returns a AnyEvent::XMPP::IM::Contact object
which stands for ourself. It will be used to keep track of our own
presences.
- debug_dump
- This prints the roster and all it's contacts and their
presences.
AUTHOR¶
Robin Redeker, "<elmex at ta-sa.org>", JID: "<elmex at
jabber.org>"
SEE ALSO¶
AnyEvent::XMPP::IM::Connection, AnyEvent::XMPP::IM::Contact,
AnyEvent::XMPP::IM::Presence
COPYRIGHT & LICENSE¶
Copyright 2007, 2008 Robin Redeker, all rights reserved.
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.