|
Smack | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.jivesoftware.smack.packet.Packet
org.jivesoftware.smack.packet.IQ
org.jivesoftware.smackx.packet.OfflineMessageRequest
public class OfflineMessageRequest
Represents a request to get some or all the offline messages of a user. This class can also be used for deleting some or all the offline messages of a user.
| Nested Class Summary | |
|---|---|
static class |
OfflineMessageRequest.Item
Item child that holds information about offline messages to view or delete. |
static class |
OfflineMessageRequest.Provider
|
| Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ |
|---|
IQ.Type |
| Field Summary |
|---|
| Fields inherited from class org.jivesoftware.smack.packet.Packet |
|---|
DEFAULT_LANGUAGE, ID_NOT_AVAILABLE |
| Constructor Summary | |
|---|---|
OfflineMessageRequest()
|
|
| Method Summary | |
|---|---|
void |
addItem(OfflineMessageRequest.Item item)
Adds an item child that holds information about offline messages to view or delete. |
String |
getChildElementXML()
Returns the sub-element XML section of the IQ packet, or null if there isn't one. |
Iterator |
getItems()
Returns an Iterator for item childs that holds information about offline messages to view or delete. |
boolean |
isFetch()
Returns true if all the offline messages of the user should be retrieved. |
boolean |
isPurge()
Returns true if all the offline messages of the user should be deleted. |
void |
setFetch(boolean fetch)
Sets if all the offline messages of the user should be retrieved. |
void |
setPurge(boolean purge)
Sets if all the offline messages of the user should be deleted. |
| Methods inherited from class org.jivesoftware.smack.packet.IQ |
|---|
createErrorResponse, createResultIQ, getType, setType, toXML |
| Methods inherited from class org.jivesoftware.smack.packet.Packet |
|---|
addExtension, deleteProperty, equals, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getProperty, getPropertyNames, getTo, getXmlns, hashCode, nextID, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setProperty, setTo |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public OfflineMessageRequest()
| Method Detail |
|---|
public Iterator getItems()
public void addItem(OfflineMessageRequest.Item item)
item - the item child that holds information about offline messages to view or delete.public boolean isPurge()
public void setPurge(boolean purge)
purge - true if all the offline messages of the user should be deleted.public boolean isFetch()
public void setFetch(boolean fetch)
fetch - true if all the offline messages of the user should be retrieved.public String getChildElementXML()
IQExtensions of this class must override this method.
getChildElementXML in class IQ
|
Smack | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||