ipworks
Class XMPPBuddy

java.lang.Object
  |
  +--ipworks.XMPPBuddy

public class XMPPBuddy

extends java.lang.Object

A buddy in the XMPP buddy list.

This type describes a buddy in the user's buddy list. Each buddy in the list has certain properties associated with it, such as names, id, etc.

Group: This is a comma-separated list of the buddy's associated groups.

After the Sync event has fired, this field will contain a comma-separated list of groups for the associated Id . This is the only buddy list field that can be modified, changing this value will cause the buddy's group associations to change. Setting it to the empty string ("") will cause the buddy to be completely disassociated from all groups.

Id: This is the jabber id of the buddy.

After a Sync event is fired, this field will contain the user id associated with the corresponding entry in the buddy list. If a buddy has multiple entries (e.g., if the buddy is listed in several groups) more than one entry will be the same.

NickName: The nickname of the buddy, if one exists.

RealName: The real name of the buddy.

Subscription: This is a list of the subscription status for the buddy.

After a Sync event is fired, this property will contain all of the types of subscriptions for the buddy. They are defined as follows:

stNone (0)

no subscription

stTo (1)

the buddy has a subscription to this entity.

stFrom (2)

this entity has a subscription to the buddy

stBoth (3)

subscription is both to and from

stRemove (4)

the item is to be removed from the list

See Also:

Atom, Atom.XMPPBuddy

Field Summary

static int	stBoth
static int	stFrom
static int	stNone
static int	stRemove
static int	stTo

Constructor Summary

XMPPBuddy()

Method Summary

java.lang.String	getGroup()
java.lang.String	getId()
java.lang.String	getNickName()
java.lang.String	getRealName()
int	getSubscription()
void	setGroup(java.lang.String value)
void	setNickName(java.lang.String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

stNone

public static final int stNone

See Also:

Constant Field Values

stTo

public static final int stTo

See Also:

Constant Field Values

stFrom

public static final int stFrom

See Also:

Constant Field Values

stBoth

public static final int stBoth

See Also:

Constant Field Values

stRemove

public static final int stRemove

See Also:

Constant Field Values

Constructor Detail

XMPPBuddy

public XMPPBuddy()

Method Detail

getGroup

public java.lang.String getGroup()

setGroup

public void setGroup(java.lang.String value)

getId

public java.lang.String getId()

getNickName

public java.lang.String getNickName()

setNickName

public void setNickName(java.lang.String value)

getRealName

public java.lang.String getRealName()

getSubscription

public int getSubscription()