Package org.jivesoftware.smackx.muc

Class MultiUserChat.MucCreateConfigFormHandle

java.lang.Object

org.jivesoftware.smackx.muc.MultiUserChat.MucCreateConfigFormHandle

Enclosing class:

MultiUserChat

public class MultiUserChat.MucCreateConfigFormHandle
extends Object

A handle used to configure a newly created room. As long as the room is not configured it will be locked, which means that no one is able to join. The room will become unlocked as soon it got configured. In order to create an instant room, use makeInstant().

For advanced configuration options, use MultiUserChat.getConfigurationForm(), get the answer form with Form.getFillableForm(), fill it out and send it back to the room with MultiUserChat.sendConfigurationForm(FillableForm).

Constructor Summary

Constructors

Constructor	Description
MucCreateConfigFormHandle()

Method Summary

Modifier and Type	Method	Description
MucConfigFormManager	getConfigFormManager()	Alias for MultiUserChat.getConfigFormManager().
void	makeInstant()	Create an instant room.

Methods inherited from class java.lang.Object

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

Constructor Detail

MucCreateConfigFormHandle

public MucCreateConfigFormHandle()

Method Detail

makeInstant

public void makeInstant()
                 throws SmackException.NoResponseException,
                        XMPPException.XMPPErrorException,
                        SmackException.NotConnectedException,
                        InterruptedException

Create an instant room. The default configuration will be accepted and the room will become unlocked, i.e. other users are able to join.

Throws:

SmackException.NoResponseException - if there was no response from the remote entity.

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NotConnectedException - if the XMPP connection is not connected.

InterruptedException - if the calling thread was interrupted.

See Also:

XEP-45 § 10.1.2 Creating an Instant Room

getConfigFormManager

public MucConfigFormManager getConfigFormManager()
                                          throws SmackException.NoResponseException,
                                                 XMPPException.XMPPErrorException,
                                                 SmackException.NotConnectedException,
                                                 InterruptedException

Alias for MultiUserChat.getConfigFormManager().

Returns:

a MUC configuration form manager for this room.

Throws:

SmackException.NoResponseException - if there was no response from the remote entity.

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NotConnectedException - if the XMPP connection is not connected.

InterruptedException - if the calling thread was interrupted.

See Also:

MultiUserChat.getConfigFormManager()