org.jivesoftware.smackx.muc.packet

Class MUCItem

java.lang.Object

org.jivesoftware.smackx.muc.packet.MUCItem

All Implemented Interfaces:

Element, NamedElement

public class MUCItem
extends Object
implements NamedElement

Item child that holds information about roles, affiliation, jids and nicks.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT

Constructor Summary

Constructors

Constructor and Description
MUCItem(MUCAffiliation affiliation)
MUCItem(MUCAffiliation affiliation, MUCRole role, String actor, String reason, String jid, String nick) Creates a new item child.
MUCItem(MUCAffiliation affiliation, String jid)
MUCItem(MUCAffiliation affiliation, String jid, String reason)
MUCItem(MUCRole role)
MUCItem(MUCRole role, String nick)
MUCItem(MUCRole role, String nick, String reason)

Method Summary

Modifier and Type	Method and Description
String	getActor() Returns the actor (JID of an occupant in the room) that was kicked or banned.
MUCAffiliation	getAffiliation() Returns the occupant's affiliation to the room.
String	getElementName() Returns the root element name.
String	getJid() Returns the by which an occupant is identified within the context of a room.
String	getNick() Returns the new nickname of an occupant that is changing his/her nickname.
String	getReason() Returns the reason for the item child.
MUCRole	getRole() Returns the temporary position or privilege level of an occupant within a room.
XmlStringBuilder	toXML() Returns the XML representation of this Element.

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

Constructor Detail

MUCItem

public MUCItem(MUCAffiliation affiliation)

MUCItem

public MUCItem(MUCRole role)

MUCItem

public MUCItem(MUCRole role,
               String nick)

MUCItem

public MUCItem(MUCAffiliation affiliation,
               String jid,
               String reason)

MUCItem

public MUCItem(MUCAffiliation affiliation,
               String jid)

MUCItem

public MUCItem(MUCRole role,
               String nick,
               String reason)

MUCItem

public MUCItem(MUCAffiliation affiliation,
               MUCRole role,
               String actor,
               String reason,
               String jid,
               String nick)

Creates a new item child.

Parameters:

affiliation - the actor's affiliation to the room

role - the privilege level of an occupant within a room.

actor -

reason -

jid -

nick -

Method Detail

getActor

public String getActor()

Returns the actor (JID of an occupant in the room) that was kicked or banned.

Returns:

the JID of an occupant in the room that was kicked or banned.

getReason

public String getReason()

Returns the reason for the item child. The reason is optional and could be used to explain the reason why a user (occupant) was kicked or banned.

Returns:

the reason for the item child.

getAffiliation

public MUCAffiliation getAffiliation()

Returns the occupant's affiliation to the room. The affiliation is a semi-permanent association or connection with a room. The possible affiliations are "owner", "admin", "member", and "outcast" (naturally it is also possible to have no affiliation). An affiliation lasts across a user's visits to a room.

Returns:

the actor's affiliation to the room

getJid

public String getJid()

Returns the by which an occupant is identified within the context of a room. If the room is non-anonymous, the JID will be included in the item.

Returns:

the room JID by which an occupant is identified within the room.

getNick

public String getNick()

Returns the new nickname of an occupant that is changing his/her nickname. The new nickname is sent as part of the unavailable presence.

Returns:

the new nickname of an occupant that is changing his/her nickname.

getRole

public MUCRole getRole()

Returns the temporary position or privilege level of an occupant within a room. The possible roles are "moderator", "participant", "visitor" and "none" (it is also possible to have no defined role). A role lasts only for the duration of an occupant's visit to a room.

Returns:

the privilege level of an occupant within a room.

toXML

public XmlStringBuilder toXML()

Description copied from interface: Element

Returns the XML representation of this Element.

Specified by:

toXML in interface Element

Returns:

the stanza(/packet) extension as XML.

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.