Class OfflineMessageRequest
- java.lang.Object
-
- org.jivesoftware.smack.packet.Stanza
-
- org.jivesoftware.smack.packet.IQ
-
- org.jivesoftware.smackx.offline.packet.OfflineMessageRequest
-
- All Implemented Interfaces:
org.jivesoftware.smack.packet.Element
,org.jivesoftware.smack.packet.FullyQualifiedElement
,org.jivesoftware.smack.packet.IqView
,org.jivesoftware.smack.packet.NamedElement
,org.jivesoftware.smack.packet.StanzaView
,org.jivesoftware.smack.packet.TopLevelStreamElement
,org.jivesoftware.smack.packet.XmlLangElement
public class OfflineMessageRequest extends org.jivesoftware.smack.packet.IQ
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
Nested Classes Modifier and Type Class Description static class
OfflineMessageRequest.Item
Item child that holds information about offline messages to view or delete.static class
OfflineMessageRequest.Provider
-
Constructor Summary
Constructors Constructor Description OfflineMessageRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addItem(OfflineMessageRequest.Item item)
Adds an item child that holds information about offline messages to view or delete.protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder
getIQChildElementBuilder(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder buf)
java.util.List<OfflineMessageRequest.Item>
getItems()
Returns a List of item children 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, createErrorResponse, createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementQName, getChildElementXML, getElementName, getType, isRequestIQ, isResponseIQ, setType, toString, toXML
-
Methods inherited from class org.jivesoftware.smack.packet.Stanza
addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtension, getExtensionElement, getExtensions, getExtensions, getExtensions, getExtensions, getExtensionsMap, getFrom, getLanguage, getNamespace, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, logCommonAttributes, overrideExtension, removeExtension, removeExtension, setError, setError, setFrom, setLanguage, setNewStanzaId, setStanzaId, setStanzaId, setTo, throwIfNoStanzaId
-
-
-
-
Field Detail
-
ELEMENT
public static final java.lang.String ELEMENT
- See Also:
- Constant Field Values
-
NAMESPACE
public static final java.lang.String NAMESPACE
- See Also:
- Constant Field Values
-
-
Method Detail
-
getItems
public java.util.List<OfflineMessageRequest.Item> getItems()
Returns a List of item children that holds information about offline messages to view or delete.- Returns:
- a List of item children that holds information about offline messages to view or delete.
-
addItem
public void addItem(OfflineMessageRequest.Item item)
Adds an item child that holds information about offline messages to view or delete.- Parameters:
item
- the item child that holds information about offline messages to view or delete.
-
isPurge
public boolean isPurge()
Returns true if all the offline messages of the user should be deleted.- Returns:
- true if all the offline messages of the user should be deleted.
-
setPurge
public void setPurge(boolean purge)
Sets if all the offline messages of the user should be deleted.- Parameters:
purge
- true if all the offline messages of the user should be deleted.
-
isFetch
public boolean isFetch()
Returns true if all the offline messages of the user should be retrieved.- Returns:
- true if all the offline messages of the user should be retrieved.
-
setFetch
public void setFetch(boolean fetch)
Sets if all the offline messages of the user should be retrieved.- Parameters:
fetch
- true if all the offline messages of the user should be retrieved.
-
getIQChildElementBuilder
protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder buf)
- Specified by:
getIQChildElementBuilder
in classorg.jivesoftware.smack.packet.IQ
-
-