MUCUser.Invite (Smack 4.4.6 API)

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 Description

static String ELEMENT

Constructor Summary

Constructors
Constructor	Description
`Invite(String reason, EntityBareJid to)`
`Invite(String reason, EntityFullJid from)`
`Invite(String reason, EntityJid from, EntityBareJid to)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getElementName()`	Returns the root element name.
`EntityJid`	`getFrom()`	Returns the bare JID of the inviting user or, optionally, the room JID.
`String`	`getReason()`	Returns the message explaining the invitation.
`EntityBareJid`	`getTo()`	Returns the bare JID of the invitee.
`XmlStringBuilder`	`toXML(XmlEnvironment enclosingNamespace)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jivesoftware.smack.packet.Element
toXML, toXML

- Field Detail
  - ELEMENT
```
public static final String ELEMENT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Invite
```
public Invite(String reason,
              EntityFullJid from)
```
  - Invite
```
public Invite(String reason,
              EntityBareJid to)
```
  - Invite
```
public Invite(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 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)
```
    Specified by:
    
    toXML in interface Element
  - getElementName
```
public String getElementName()
```
    Description copied from interface: NamedElement
    
    Returns the root element name.
    
    Specified by:
    
    getElementName in interface NamedElement
    
    Returns:
    
    the element name.