rocks.xmpp.extensions.muc.conference.model

Class DirectInvitation

java.lang.Object

rocks.xmpp.extensions.muc.conference.model.DirectInvitation

public final class DirectInvitation
extends Object

The implementation of the <x/> element in the jabber:x:conference namespace, which represents a direct multi-user chat invitation.

This class is immutable.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMESPACE jabber:x:conference

Constructor Summary

Constructors

Constructor and Description
DirectInvitation(Jid jid)
DirectInvitation(Jid jid, String password, String reason)
DirectInvitation(Jid jid, String password, String reason, boolean isContinue, String thread)

Method Summary

Modifier and Type	Method and Description
String	getPassword() Gets a password needed for entry into a password-protected room (optional).
String	getReason() Gets a human-readable purpose for the invitation (optional).
Jid	getRoomAddress() Gets the address of the groupchat room to be joined.
String	getThread() Gets the thread of the one-to-one chat, which is continued (optional).
boolean	isContinue() Indicates, if the groupchat room continues a one-to-one chat.

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final String NAMESPACE

jabber:x:conference

See Also:

Constant Field Values

Constructor Detail

DirectInvitation

public DirectInvitation(Jid jid)

DirectInvitation

public DirectInvitation(Jid jid,
                        String password,
                        String reason)

DirectInvitation

public DirectInvitation(Jid jid,
                        String password,
                        String reason,
                        boolean isContinue,
                        String thread)

Method Detail

isContinue

public boolean isContinue()

Indicates, if the groupchat room continues a one-to-one chat.

Returns:

True, if the groupchat room continues a one-to-one chat.

getThread

public String getThread()

Gets the thread of the one-to-one chat, which is continued (optional).

Returns:

The thread or null.

getReason

public String getReason()

Gets a human-readable purpose for the invitation (optional).

Returns:

The reason or null.

getPassword

public String getPassword()

Gets a password needed for entry into a password-protected room (optional).

Returns:

The password or null.

getRoomAddress

public Jid getRoomAddress()

Gets the address of the groupchat room to be joined.

Returns:

The room address.