org.jivesoftware.smackx.offline.packet

Class OfflineMessageRequest

java.lang.Object

org.jivesoftware.smack.packet.Stanza

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.offline.packet.OfflineMessageRequest

All Implemented Interfaces:

Element, TopLevelStreamElement

public class OfflineMessageRequest
extends 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 and Description
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.IQChildElementXmlStringBuilder, IQ.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT
static String	NAMESPACE

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

IQ_ELEMENT, QUERY_ELEMENT

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

DEFAULT_LANGUAGE, ITEM, language, TEXT

Constructor Summary

Constructors

Constructor and Description
OfflineMessageRequest()

Method Summary

Modifier and Type	Method and Description
void	addItem(OfflineMessageRequest.Item item) Adds an item child that holds information about offline messages to view or delete.
protected IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder buf) This method must be overwritten by IQ subclasses to create their child content.
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, getChildElementXML, getChildElementXML, getType, initializeAsResultFor, initialzeAsResultFor, isRequestIQ, setType, toString, toXML

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

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensions, getFrom, getLanguage, getPacketID, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, logCommonAttributes, overrideExtension, removeExtension, removeExtension, setError, setError, setFrom, setFrom, setLanguage, setPacketID, setStanzaId, setStanzaId, setTo, setTo

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

OfflineMessageRequest

public OfflineMessageRequest()

Method Detail

getItems

public 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 IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder buf)

Description copied from class: IQ

This method must be overwritten by IQ subclasses to create their child content. It is important you don't use the builder to add the final end tag. This will be done automatically by IQ.IQChildElementXmlStringBuilder after eventual existing ExtensionElements have been added.

For example to create an IQ with a extra attribute and an additional child element

 
 <iq to='foo@example.org' id='123'>
   <bar xmlns='example:bar' extraAttribute='blaz'>
      <extraElement>elementText</extraElement>
   </bar>
 </iq>
 
 

the body of the getIQChildElementBuilder looks like

 
 // The builder 'xml' will already have the child element and the 'xmlns' attribute added
 // So the current builder state is "<bar xmlns='example:bar'"
 xml.attribute("extraAttribute", "blaz");
 xml.rightAngleBracket();
 xml.element("extraElement", "elementText");
 // Do not close the 'bar' attribute by calling xml.closeElement('bar')
 
 

If your IQ only contains attributes and no child elements, i.e. it can be represented as empty element, then you can mark it as such.

 xml.attribute("myAttribute", "myAttributeValue");
 xml.setEmptyElement();
 

If your IQ does not contain any attributes or child elements (besides ExtensionElements), consider sub-classing SimpleIQ instead.

Specified by:

getIQChildElementBuilder in class IQ

Parameters:

buf - a pre-created builder which already has the child element and the 'xmlns' attribute set.

Returns:

the build to create the IQ child content.