org.jivesoftware.smackx.packet
Class MUCUser.Invite

java.lang.Object
  org.jivesoftware.smackx.packet.MUCUser.Invite

Enclosing class:

MUCUser

public static class MUCUser.Invite
extends Object

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.

Author:

Gaston Dombiak

Constructor Summary

MUCUser.Invite()

Method Summary

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.
String	toXML()

Methods inherited from class java.lang.Object

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

Constructor Detail

MUCUser.Invite

public MUCUser.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 String toXML()