com.realtime.xmpp.tools
Interface RosterTool

All Known Subinterfaces:

XmppTool

All Known Implementing Classes:

DomXmppTool

public interface RosterTool

Method Summary

XmppError	rosterAdd(JID account, JID contact, java.lang.String sContactNick, java.lang.String sSubscription, java.lang.String sGroup, java.lang.String sGroupTail) Insert a new contact into a roster.
XmppError	rosterRemove(JID principal, JID contact, java.lang.String sGroup, boolean bTail) Remove a contact from an accounts roster.

Method Detail

rosterRemove

public XmppError rosterRemove(JID principal,
                              JID contact,
                              java.lang.String sGroup,
                              boolean bTail)
                       throws java.io.IOException

Remove a contact from an accounts roster.

Parameters:

principal - The account to remove the contact from.

contact - The contact to remove.

sGroup - The full, or tail portion of the group name.

bTail - If true, the group name is just the tail.

Returns:

An XmppError, or null for success.

Throws:

java.io.IOException - Generated when the session fails.

rosterAdd

public XmppError rosterAdd(JID account,
                           JID contact,
                           java.lang.String sContactNick,
                           java.lang.String sSubscription,
                           java.lang.String sGroup,
                           java.lang.String sGroupTail)
                    throws java.io.IOException

Insert a new contact into a roster.

Parameters:

account - The account to add the roster item to.

contact - The Jabber id of the new contact.

sContactNick - The contacts nick name.

sSubscription - The type of subscription. If this is 'none', then no subscription has been agreed to. If this is 'both', then both parties are assumed to have agreed to a subscription.

sGroup - If this is not null, then the contact will be assigned to a group. NOTE that if a group tail is provided, it will be added to the finished group name.

sGroupTail - If this is not null, then it will be used to locate the matching group.

Returns:

An XmppError, or null for success.

Throws:

java.io.IOException - Generated when the session fails.