org.jivesoftware.smackx.muc.packet

Class MUCUser.Invite

java.lang.Object

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

All Implemented Interfaces:

Element, NamedElement

Enclosing class:

MUCUser

public static class MUCUser.Invite
extends Object
implements 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 String	ELEMENT

Constructor Summary

Constructors

Constructor and Description
Invite()

Method Summary

Modifier and Type	Method and Description
String	getElementName() Returns the root element name.
String	getFrom() Returns the bare JID of the inviter or, optionally, the room JID.
String	getReason() Returns the message explaining the invitation.
String	getTo() Returns the bare JID of the invitee.
void	setFrom(String from) Sets the bare JID of the inviter or, optionally, the room JID.
void	setReason(String reason) Sets the message explaining the invitation.
void	setTo(String to) Sets the bare JID of the invitee.
XmlStringBuilder	toXML() Returns the XML representation of this Element.

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

Constructor Detail

Invite

public Invite()

Method Detail

getFrom

public String 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 String getReason()

Returns the message explaining the invitation.

Returns:

the message explaining the invitation.

getTo

public String getTo()

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

Returns:

the bare JID of the invitee.

setFrom

public void setFrom(String from)

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

Parameters:

from - the bare JID of the inviter or, optionally, the room JID.

setReason

public void setReason(String reason)

Sets the message explaining the invitation.

Parameters:

reason - the message explaining the invitation.

setTo

public void setTo(String to)

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

Parameters:

to - the bare JID of the invitee.

toXML

public XmlStringBuilder toXML()

Description copied from interface: Element

Returns the XML representation of this Element.

Specified by:

toXML in interface Element

Returns:

the stanza(/packet) extension as XML.

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.