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 java.lang.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 Description static java.lang.String
ELEMENT
-
Constructor Summary
Constructors Constructor Description Invite(java.lang.String reason, EntityBareJid to)
Invite(java.lang.String reason, EntityFullJid from)
Invite(java.lang.String reason, EntityJid from, EntityBareJid to)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getElementName()
Returns the root element name.EntityJid
getFrom()
Returns the bare JID of the inviting user or, optionally, the room JID.java.lang.String
getReason()
Returns the message explaining the invitation.EntityBareJid
getTo()
Returns the bare JID of the invitee.XmlStringBuilder
toXML(XmlEnvironment enclosingNamespace)
-
-
-
Field Detail
-
ELEMENT
public static final java.lang.String ELEMENT
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Invite
public Invite(java.lang.String reason, EntityFullJid from)
-
Invite
public Invite(java.lang.String reason, EntityBareJid to)
-
Invite
public Invite(java.lang.String reason, EntityJid from, EntityBareJid to)
-
-
Method Detail
-
getFrom
public EntityJid getFrom()
Returns the bare JID of the inviting user 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 EntityBareJid getTo()
Returns the bare JID of the invitee. (e.g. 'hecate@shakespeare.lit')- Returns:
- the bare JID of the invitee.
-
toXML
public XmlStringBuilder toXML(XmlEnvironment enclosingNamespace)
-
getElementName
public java.lang.String getElementName()
Description copied from interface:NamedElement
Returns the root element name.- Specified by:
getElementName
in interfaceNamedElement
- Returns:
- the element name.
-
-