org.jivesoftware.smackx.muc.packet

Class MUCUser.Invite

java.lang.Object

org.jivesoftware.smackx.muc.packet.MUCUser.Invite

All Implemented Interfaces:

org.jivesoftware.smack.packet.Element, org.jivesoftware.smack.packet.NamedElement

Enclosing class:

MUCUser

public static class MUCUser.Invite
extends java.lang.Object
implements org.jivesoftware.smack.packet.NamedElement

Represents an invitation for another user to a room. The sender of the invitation must be an occupant of the room. The invitation will be sent to the room which in turn will forward the invitation to the invitee.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELEMENT

Constructor Summary

Constructors

Constructor and Description
Invite(java.lang.String reason, org.jxmpp.jid.EntityBareJid to)
Invite(java.lang.String reason, org.jxmpp.jid.EntityFullJid from)
Invite(java.lang.String reason, org.jxmpp.jid.EntityFullJid from, org.jxmpp.jid.EntityBareJid to)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getElementName()
org.jxmpp.jid.EntityFullJid	getFrom() Returns the bare JID of the inviter or, optionally, the room JID.
java.lang.String	getReason() Returns the message explaining the invitation.
org.jxmpp.jid.EntityBareJid	getTo() Returns the bare JID of the invitee.
org.jivesoftware.smack.util.XmlStringBuilder	toXML()

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT

public static final java.lang.String ELEMENT

See Also:

Constant Field Values

Constructor Detail

Invite

public Invite(java.lang.String reason,
              org.jxmpp.jid.EntityFullJid from)

Invite

public Invite(java.lang.String reason,
              org.jxmpp.jid.EntityBareJid to)

Invite

public Invite(java.lang.String reason,
              org.jxmpp.jid.EntityFullJid from,
              org.jxmpp.jid.EntityBareJid to)

Method Detail

getFrom

public org.jxmpp.jid.EntityFullJid getFrom()

Returns the bare JID of the inviter or, optionally, the room JID. (e.g. 'crone1@shakespeare.lit/desktop').

Returns:

the room's occupant that sent the invitation.

getReason

public java.lang.String getReason()

Returns the message explaining the invitation.

Returns:

the message explaining the invitation.

getTo

public org.jxmpp.jid.EntityBareJid getTo()

Returns the bare JID of the invitee. (e.g. 'hecate@shakespeare.lit')

Returns:

the bare JID of the invitee.

toXML

public org.jivesoftware.smack.util.XmlStringBuilder toXML()

Specified by:

toXML in interface org.jivesoftware.smack.packet.Element

getElementName

public java.lang.String getElementName()

Specified by:

getElementName in interface org.jivesoftware.smack.packet.NamedElement