org.jivesoftware.smackx.muc

Class Affiliate

java.lang.Object

org.jivesoftware.smackx.muc.Affiliate

public class Affiliate
extends Object

Represents an affiliation of a user to a given room. The affiliate's information will always have the bare jid of the real user and its affiliation. If the affiliate is an occupant of the room then we will also have information about the role and nickname of the user in the room.

Method Summary

Modifier and Type	Method and Description
MUCAffiliation	getAffiliation() Returns the affiliation of the afffiliated user.
org.jxmpp.jid.Jid	getJid() Returns the bare JID of the affiliated user.
org.jxmpp.jid.parts.Resourcepart	getNick() Returns the current nickname of the affiliated user if the user is currently in the room.
MUCRole	getRole() Returns the current role of the affiliated user if the user is currently in the room.

Methods inherited from class java.lang.Object

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

Method Detail

getJid

public org.jxmpp.jid.Jid getJid()

Returns the bare JID of the affiliated user. This information will always be available.

Returns:

the bare JID of the affiliated user.

getAffiliation

public MUCAffiliation getAffiliation()

Returns the affiliation of the afffiliated user. Possible affiliations are: "owner", "admin", "member", "outcast". This information will always be available.

Returns:

the affiliation of the afffiliated user.

getRole

public MUCRole getRole()

Returns the current role of the affiliated user if the user is currently in the room. If the user is not present in the room then the answer will be 'none'.

Returns:

the current role of the affiliated user in the room or null if the user is not in the room.

getNick

public org.jxmpp.jid.parts.Resourcepart getNick()

Returns the current nickname of the affiliated user if the user is currently in the room. If the user is not present in the room then the answer will be null.

Returns:

the current nickname of the affiliated user in the room or null if the user is not in the room.