rocks.xmpp.extensions.muc

Class InvitationEvent

java.lang.Object

java.util.EventObject

rocks.xmpp.extensions.muc.InvitationEvent

All Implemented Interfaces:

Serializable

public final class InvitationEvent
extends EventObject

The multi-user chat invitation event, which is triggered upon receiving an invitation to a multi-user chat.

See Also:

MultiUserChatManager.addInvitationListener(Consumer), Serialized Form

Method Summary

Modifier and Type	Method and Description
void	decline(String reason) Declines the invitation.
rocks.xmpp.addr.Jid	getInviter() Gets the inviter.
String	getPassword() Gets the password to the room.
String	getReason() Gets the reason for the invitation.
rocks.xmpp.addr.Jid	getRoomAddress() Gets the room address.
String	getThread() Gets the thread of the continued one-to-one chat session (if any).
boolean	isContinue() Indicates, whether a one-to-one chat session is continued in the chat room.
boolean	isMediated() Indicates, whether the invitation is a mediated or direct invitation.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Method Detail

decline

public void decline(String reason)

Declines the invitation.

Parameters:

reason - The reason.

getInviter

public rocks.xmpp.addr.Jid getInviter()

Gets the inviter. If the invitation was mediated by the chat room, the inviter can either be a bare or full JID or the in-room JID of an occupant.

Returns:

The inviter.

isContinue

public boolean isContinue()

Indicates, whether a one-to-one chat session is continued in the chat room.

Returns:

If a one-to-one chat session is continued in the chat room.

See Also:

getThread()

getRoomAddress

public rocks.xmpp.addr.Jid getRoomAddress()

Gets the room address.

Returns:

The room address.

getPassword

public String getPassword()

Gets the password to the room.

Returns:

The password.

getReason

public String getReason()

Gets the reason for the invitation.

Returns:

The reason.

getThread

public String getThread()

Gets the thread of the continued one-to-one chat session (if any).

Returns:

The thread.

See Also:

isContinue()

isMediated

public boolean isMediated()

Indicates, whether the invitation is a mediated or direct invitation.

Returns:

True, if the invitation was mediated by the room; false, if it is a direct invitation.

See Also:

7.8.1 Direct Invitation, 7.8.2 Mediated Invitation