| 
 | Smack | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.jivesoftware.smackx.GroupChatInvitation
public class GroupChatInvitation
A group chat invitation packet 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.sendPacket(message);
 
 To listen for group chat invitations, use a PacketExtensionFilter for the
 x element name and jabber:x:conference namespace, as in the
 following code example:
 
 PacketFilter filter = new PacketExtensionFilter("x", "jabber:x:conference");
 // Create a packet collector or packet listeners using the filter...
 
 Note: this protocol is outdated now that the Multi-User Chat (MUC) JEP is available
 (JEP-45). However, most
 existing clients still use this older protocol. Once MUC support becomes more
 widespread, this API may be deprecated.
| Nested Class Summary | |
|---|---|
| static class | GroupChatInvitation.Provider | 
| Field Summary | |
|---|---|
| static String | ELEMENT_NAMEElement name of the packet extension. | 
| static String | NAMESPACENamespace of the packet extension. | 
| Constructor Summary | |
|---|---|
| GroupChatInvitation(String roomAddress)Creates a new group chat invitation to the specified room address. | |
| Method Summary | |
|---|---|
|  String | getElementName()Returns the root element name. | 
|  String | getNamespace()Returns the root element XML namespace. | 
|  String | getRoomAddress()Returns the address of the group chat room. | 
|  String | toXML()Returns the XML representation of the PacketExtension. | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
|---|
public static final String ELEMENT_NAME
public static final String NAMESPACE
| Constructor Detail | 
|---|
public GroupChatInvitation(String roomAddress)
roomAddress - the address of the group chat room.| Method Detail | 
|---|
public String getRoomAddress()
public String getElementName()
PacketExtension
getElementName in interface PacketExtensionpublic String getNamespace()
PacketExtension
getNamespace in interface PacketExtensionpublic String toXML()
PacketExtension
toXML in interface PacketExtension| 
 | Smack | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||