org.jivesoftware.smackx.muc.packet

Class MUCInitialPresence

java.lang.Object

org.jivesoftware.smackx.muc.packet.MUCInitialPresence

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class MUCInitialPresence
extends Object
implements ExtensionElement

Represents extended presence information whose sole purpose is to signal the ability of the occupant to speak the MUC protocol when joining a room. If the room requires a password then the MUCInitialPresence should include one.

The amount of discussion history provided on entering a room (perhaps because the user is on a low-bandwidth connection or is using a small-footprint client) could be managed by setting a configured History instance to the MUCInitialPresence instance.

See Also:

setHistory(MUCInitialPresence.History)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MUCInitialPresence.History The History class controls the number of characters or messages to receive when entering a room.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MUCInitialPresence() Deprecated. use MUCInitialPresence(String, int, int, int, Date) instead.
MUCInitialPresence(String password, int maxChars, int maxStanzas, int seconds, Date since) Construct a new MUC initial presence extension.

Method Summary

Modifier and Type	Method and Description
static MUCInitialPresence	from(Stanza packet) Retrieve the MUCInitialPresence PacketExtension from packet, if any.
String	getElementName() Returns the root element name.
static MUCInitialPresence	getFrom(Stanza packet) Deprecated. use from(Stanza) instead
MUCInitialPresence.History	getHistory() Returns the history that manages the amount of discussion history provided on entering a room.
String	getNamespace() Returns the root element XML namespace.
String	getPassword() Returns the password to use when the room requires a password.
void	setHistory(MUCInitialPresence.History history) Deprecated. use MUCInitialPresence(String, int, int, int, Date) instead.
void	setPassword(String password) Deprecated. use MUCInitialPresence(String, int, int, int, Date) instead.
XmlStringBuilder	toXML(String enclosingNamespace) 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

MUCInitialPresence

@Deprecated
public MUCInitialPresence()

Deprecated. use MUCInitialPresence(String, int, int, int, Date) instead.

Deprecated constructor.

MUCInitialPresence

public MUCInitialPresence(String password,
                          int maxChars,
                          int maxStanzas,
                          int seconds,
                          Date since)

Construct a new MUC initial presence extension.

Parameters:

password - the optional password used to enter the room.

maxChars - the maximal count of characters of history to request.

maxStanzas - the maximal count of stanzas of history to request.

seconds - the last seconds since when to request history.

since - the date since when to request history.

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(String enclosingNamespace)

Description copied from interface: Element

Returns the XML representation of this Element. This method takes an optional argument for the enclosing namespace which may be null or the empty String if the value is not known.

Specified by:

toXML in interface Element

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.

getHistory

public MUCInitialPresence.History getHistory()

Returns the history that manages the amount of discussion history provided on entering a room.

Returns:

the history that manages the amount of discussion history provided on entering a room.

getPassword

public String getPassword()

Returns the password to use when the room requires a password.

Returns:

the password to use when the room requires a password.

setHistory

@Deprecated
public void setHistory(MUCInitialPresence.History history)

Deprecated. use MUCInitialPresence(String, int, int, int, Date) instead.

Sets the History that manages the amount of discussion history provided on entering a room.

Parameters:

history - that manages the amount of discussion history provided on entering a room.

setPassword

@Deprecated
public void setPassword(String password)

Deprecated. use MUCInitialPresence(String, int, int, int, Date) instead.

Sets the password to use when the room requires a password.

Parameters:

password - the password to use when the room requires a password.

getFrom

@Deprecated
public static MUCInitialPresence getFrom(Stanza packet)

Deprecated. use from(Stanza) instead

Retrieve the MUCInitialPresence PacketExtension from packet, if any.

Parameters:

packet -

Returns:

the MUCInitialPresence PacketExtension or null

from

public static MUCInitialPresence from(Stanza packet)

Retrieve the MUCInitialPresence PacketExtension from packet, if any.

Parameters:

packet -

Returns:

the MUCInitialPresence PacketExtension or null