org.jivesoftware.smackx.muc.packet

Class MUCUser

java.lang.Object

org.jivesoftware.smackx.muc.packet.MUCUser

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class MUCUser
extends Object
implements ExtensionElement

Represents extended presence information about roles, affiliations, full JIDs, or status codes scoped by the 'http://jabber.org/protocol/muc#user' namespace.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MUCUser.Decline Represents a rejection to an invitation from another user to a room.
static class	MUCUser.Invite Represents an invitation for another user to a room.
static class	MUCUser.Status Status code assists in presenting notification messages.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT
static String	NAMESPACE

Constructor Summary

Constructors

Constructor and Description
MUCUser()

Method Summary

Modifier and Type	Method and Description
void	addStatusCode(MUCUser.Status status) Add a status code which hold a code that assists in presenting notification messages.
void	addStatusCodes(Set<MUCUser.Status> statusCodes) Add the status codes which holds the codes that assists in presenting notification messages.
static MUCUser	from(Stanza packet) Retrieve the MUCUser PacketExtension from packet, if any.
MUCUser.Decline	getDecline() Returns the rejection to an invitation from another user to a room.
Destroy	getDestroy() Returns the notification that the room has been destroyed.
String	getElementName() Returns the root element name.
static MUCUser	getFrom(Stanza packet) Deprecated. use from(Stanza) instead
MUCUser.Invite	getInvite() Returns the invitation for another user to a room.
MUCItem	getItem() Returns the item child that holds information about roles, affiliation, jids and nicks.
String	getNamespace() Returns the root element XML namespace.
String	getPassword() Returns the password to use to enter Password-Protected Room.
Set<MUCUser.Status>	getStatus() Returns a set of status which holds the status code that assist in presenting notification messages.
boolean	hasStatus() Returns true if this MUCUser instance has also MUCUser.Status information.
void	setDecline(MUCUser.Decline decline) Sets the rejection to an invitation from another user to a room.
void	setDestroy(Destroy destroy) Sets the notification that the room has been destroyed.
void	setInvite(MUCUser.Invite invite) Sets the invitation for another user to a room.
void	setItem(MUCItem item) Sets the item child that holds information about roles, affiliation, jids and nicks.
void	setPassword(String string) Sets the password to use to enter Password-Protected 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

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

MUCUser

public MUCUser()

Method Detail

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

getNamespace

public String getNamespace()

Description copied from interface: ExtensionElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the namespace.

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.

getInvite

public MUCUser.Invite getInvite()

Returns the invitation for another user to a room. The sender of the invitation must be an occupant of the room. The invitation will be sent to the room which in turn will forward the invitation to the invitee.

Returns:

an invitation for another user to a room.

getDecline

public MUCUser.Decline getDecline()

Returns the rejection to an invitation from another user to a room. The rejection will be sent to the room which in turn will forward the refusal to the inviter.

Returns:

a rejection to an invitation from another user to a room.

getItem

public MUCItem getItem()

Returns the item child that holds information about roles, affiliation, jids and nicks.

Returns:

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

getPassword

public String getPassword()

Returns the password to use to enter Password-Protected Room. A Password-Protected Room is a room that a user cannot enter without first providing the correct password.

Returns:

the password to use to enter Password-Protected Room.

getStatus

public Set<MUCUser.Status> getStatus()

Returns a set of status which holds the status code that assist in presenting notification messages.

Returns:

the set of status which holds the status code that assist in presenting notification messages.

hasStatus

public boolean hasStatus()

Returns true if this MUCUser instance has also MUCUser.Status information.

If true is returned, then getStatus() will return a non-empty set.

Returns:

true if this MUCUser has status information.

Since:

4.1

getDestroy

public Destroy getDestroy()

Returns the notification that the room has been destroyed. After a room has been destroyed, the room occupants will receive a Presence stanza(/packet) of type 'unavailable' with the reason for the room destruction if provided by the room owner.

Returns:

a notification that the room has been destroyed.

setInvite

public void setInvite(MUCUser.Invite invite)

Sets the invitation for another user to a room. The sender of the invitation must be an occupant of the room. The invitation will be sent to the room which in turn will forward the invitation to the invitee.

Parameters:

invite - the invitation for another user to a room.

setDecline

public void setDecline(MUCUser.Decline decline)

Sets the rejection to an invitation from another user to a room. The rejection will be sent to the room which in turn will forward the refusal to the inviter.

Parameters:

decline - the rejection to an invitation from another user to a room.

setItem

public void setItem(MUCItem item)

Sets the item child that holds information about roles, affiliation, jids and nicks.

Parameters:

item - the item child that holds information about roles, affiliation, jids and nicks.

setPassword

public void setPassword(String string)

Sets the password to use to enter Password-Protected Room. A Password-Protected Room is a room that a user cannot enter without first providing the correct password.

Parameters:

string - the password to use to enter Password-Protected Room.

addStatusCodes

public void addStatusCodes(Set<MUCUser.Status> statusCodes)

Add the status codes which holds the codes that assists in presenting notification messages.

Parameters:

statusCodes - the status codes which hold the codes that assists in presenting notification messages.

addStatusCode

public void addStatusCode(MUCUser.Status status)

Add a status code which hold a code that assists in presenting notification messages.

Parameters:

status - the status code which olds a code that assists in presenting notification messages.

setDestroy

public void setDestroy(Destroy destroy)

Sets the notification that the room has been destroyed. After a room has been destroyed, the room occupants will receive a Presence stanza(/packet) of type 'unavailable' with the reason for the room destruction if provided by the room owner.

Parameters:

destroy - the notification that the room has been destroyed.

getFrom

@Deprecated
public static MUCUser getFrom(Stanza packet)

Deprecated. use from(Stanza) instead

Retrieve the MUCUser PacketExtension from packet, if any.

Parameters:

packet -

Returns:

the MUCUser PacketExtension or null

from

public static MUCUser from(Stanza packet)

Retrieve the MUCUser PacketExtension from packet, if any.

Parameters:

packet -

Returns:

the MUCUser PacketExtension or null