org.jivesoftware.smackx.workgroup.packet
Class DepartQueuePacket

java.lang.Object
  org.jivesoftware.smack.packet.Packet
      org.jivesoftware.smack.packet.IQ
          org.jivesoftware.smackx.workgroup.packet.DepartQueuePacket

public class DepartQueuePacket
extends IQ

A IQ packet used to depart a workgroup queue. There are two cases for issuing a depart queue request:

• The user wants to leave the queue. In this case, an instance of this class should be created without passing in a user address.
• An administrator or the server removes wants to remove a user from the queue. In that case, the address of the user to remove from the queue should be used to create an instance of this class.

Author:

loki der quaeler

Nested Class Summary

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

IQ.Type

Field Summary

Fields inherited from class org.jivesoftware.smack.packet.Packet

ID_NOT_AVAILABLE

Constructor Summary

DepartQueuePacket(String workgroup)
Creates a depart queue request packet to the specified workgroup.

DepartQueuePacket(String workgroup, String user)
Creates a depart queue request to the specified workgroup and for the specified user.

Method Summary

String

getChildElementXML() Returns the sub-element XML section of the IQ packet, or null if there isn't one.

Methods inherited from class org.jivesoftware.smack.packet.IQ

getType, setType, toXML

Methods inherited from class org.jivesoftware.smack.packet.Packet

addExtension, deleteProperty, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getProperty, getPropertyNames, getTo, removeExtension, setError, setFrom, setPacketID, setProperty, setTo

Methods inherited from class java.lang.Object

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

Constructor Detail

DepartQueuePacket

public DepartQueuePacket(String workgroup)

Creates a depart queue request packet to the specified workgroup.

Parameters:

workgroup - the workgroup to depart.

DepartQueuePacket

public DepartQueuePacket(String workgroup,
                         String user)

Creates a depart queue request to the specified workgroup and for the specified user.

Parameters:

workgroup - the workgroup to depart.

user - the user to make depart from the queue.

Method Detail

getChildElementXML

public String getChildElementXML()

Description copied from class: IQ

Returns the sub-element XML section of the IQ packet, or null if there isn't one. Packet extensions must be included, if any are defined.

Extensions of this class must override this method.

Specified by:

getChildElementXML in class IQ

Returns:

the child element section of the IQ XML.