rocks.xmpp.extensions.muc.model.user

Class Invite

java.lang.Object

rocks.xmpp.extensions.muc.model.user.Invite

public final class Invite
extends Object

The implementation of the <invite/> element.

This class is immutable.

See Also:

7.8.2 Mediated Invitation

Constructor Summary

Constructors

Constructor and Description
Invite(rocks.xmpp.addr.Jid to) Creates an 'invite' element.
Invite(rocks.xmpp.addr.Jid to, String reason) Creates an invite element with a reason.
Invite(rocks.xmpp.addr.Jid to, String reason, String thread) Creates an 'invite' element with a reason and a 'continue' element.

Method Summary

Modifier and Type	Method and Description
rocks.xmpp.addr.Jid	getFrom() Gets the inviter.
String	getReason() Gets the reason for the invitation.
String	getThread() Gets the thread of the previous one-to-one chat session.
rocks.xmpp.addr.Jid	getTo() Gets the invitee.
boolean	isContinue() Indicates, whether a previous one-to-one chat session is continued.

Methods inherited from class java.lang.Object

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

Constructor Detail

Invite

public Invite(rocks.xmpp.addr.Jid to)

Creates an 'invite' element.

Parameters:

to - The invitee, who will receive the invitation.

Invite

public Invite(rocks.xmpp.addr.Jid to,
              String reason)

Creates an invite element with a reason.

Parameters:

to - The invitee, who will receive the invitation.

reason - The reason.

Invite

public Invite(rocks.xmpp.addr.Jid to,
              String reason,
              String thread)

Creates an 'invite' element with a reason and a 'continue' element.

Parameters:

to - The invitee, who will receive the invitation.

reason - The reason.

thread - The thread to continue.

Method Detail

getReason

public String getReason()

Gets the reason for the invitation.

Returns:

The reason.

getFrom

public rocks.xmpp.addr.Jid getFrom()

Gets the inviter.

Returns:

The inviter.

getTo

public rocks.xmpp.addr.Jid getTo()

Gets the invitee.

Returns:

The invitee.

isContinue

public boolean isContinue()

Indicates, whether a previous one-to-one chat session is continued.

Returns:

True, if a previous one-to-one chat session is continued.

See Also:

getThread()

getThread

public String getThread()

Gets the thread of the previous one-to-one chat session.

Returns:

The thread of the previous one-to-one chat session (if any) or null.

See Also:

isContinue()