org.jivesoftware.smackx.muc.packet

Class GroupChatInvitation

java.lang.Object

org.jivesoftware.smackx.muc.packet.GroupChatInvitation

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class GroupChatInvitation
extends Object
implements ExtensionElement

A group chat invitation stanza extension, which is used to invite other users to a group chat room. To invite a user to a group chat room, address a new message to the user and set the room name appropriately, as in the following code example:

 Message message = new Message("user@chat.example.com");
 message.setBody("Join me for a group chat!");
 message.addExtension(new GroupChatInvitation("room@chat.example.com"););
 con.sendStanza(message);
 

To listen for group chat invitations, use a StanzaExtensionFilter for the x element name and jabber:x:conference namespace, as in the following code example:

 PacketFilter filter = new StanzaExtensionFilter("x", "jabber:x:conference");
 // Create a stanza collector or stanza listeners using the filter...
 

Note: this protocol is outdated now that the Multi-User Chat (MUC) XEP is available (XEP-45). However, most existing clients still use this older protocol. Once MUC support becomes more widespread, this API may be deprecated.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupChatInvitation.Provider

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT Element name of the stanza extension.
static String	NAMESPACE Namespace of the stanza extension.

Constructor Summary

Constructors

Constructor and Description
GroupChatInvitation(String roomAddress) Creates a new group chat invitation to the specified room address.

Method Summary

Modifier and Type	Method and Description
static GroupChatInvitation	from(Stanza packet) Get the group chat invitation from the given stanza.
String	getElementName() Returns the root element name.
static GroupChatInvitation	getFrom(Stanza packet) Deprecated. use from(Stanza) instead
String	getNamespace() Returns the root element XML namespace.
String	getRoomAddress() Returns the address of the group chat room.
XmlStringBuilder	toXML(String enclosingNamespace) 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

Element name of the stanza extension.

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

Namespace of the stanza extension.

See Also:

Constant Field Values

Constructor Detail

GroupChatInvitation

public GroupChatInvitation(String roomAddress)

Creates a new group chat invitation to the specified room address. GroupChat room addresses are in the form room@service, where service is the name of group chat server, such as chat.example.com.

Parameters:

roomAddress - the address of the group chat room.

Method Detail

getRoomAddress

public String getRoomAddress()

Returns the address of the group chat room. GroupChat room addresses are in the form room@service, where service is the name of group chat server, such as chat.example.com.

Returns:

the address of the group chat room.

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

getNamespace

public String getNamespace()

Description copied from interface: ExtensionElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the namespace.

toXML

public XmlStringBuilder toXML(String enclosingNamespace)

Description copied from interface: Element

Returns the XML representation of this Element. This method takes an optional argument for the enclosing namespace which may be null or the empty String if the value is not known.

Specified by:

toXML in interface Element

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.

getFrom

@Deprecated
public static GroupChatInvitation getFrom(Stanza packet)

Deprecated. use from(Stanza) instead

Deprecated.

Parameters:

packet -

Returns:

the GroupChatInvitation or null

from

public static GroupChatInvitation from(Stanza packet)

Get the group chat invitation from the given stanza.

Parameters:

packet -

Returns:

the GroupChatInvitation or null