|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jivesoftware.smackx.pubsub.NodeExtension
org.jivesoftware.smackx.pubsub.ItemsExtension
public class ItemsExtension
This class is used to for multiple purposes.
Please note, this class is used for internal purposes, and is not required for usage of pubsub functionality.
Nested Class Summary | |
---|---|
static class |
ItemsExtension.ItemsElementType
|
Constructor Summary | |
---|---|
ItemsExtension(ItemsExtension.ItemsElementType itemsType,
java.lang.String nodeId,
java.util.List<? extends org.jivesoftware.smack.packet.PacketExtension> items,
java.lang.String attributeValue)
Construct an instance with a list representing items that have been published or deleted. |
|
ItemsExtension(java.lang.String nodeId,
java.lang.Integer maxItems)
Constructs a request to get items from the node as defined in the first scenario in ItemsExtension(ItemsElementType, String, List, String) |
Method Summary | |
---|---|
java.lang.String |
getAttributeValue()
Gets the value of the optional attribute related to the ItemsExtension.ItemsElementType . |
java.util.List<org.jivesoftware.smack.packet.PacketExtension> |
getExtensions()
Get the list of embedded PacketExtension objects. |
java.util.List<? extends org.jivesoftware.smack.packet.PacketExtension> |
getItems()
Gets the items related to the type of request or event. |
ItemsExtension.ItemsElementType |
getItemsElementType()
Get the type of element |
java.lang.String |
toString()
|
java.lang.String |
toXML()
|
Methods inherited from class org.jivesoftware.smackx.pubsub.NodeExtension |
---|
getElementName, getNamespace, getNode |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.jivesoftware.smack.packet.PacketExtension |
---|
getElementName, getNamespace |
Constructor Detail |
---|
public ItemsExtension(ItemsExtension.ItemsElementType itemsType, java.lang.String nodeId, java.util.List<? extends org.jivesoftware.smack.packet.PacketExtension> items, java.lang.String attributeValue)
Valid scenarios are:
ItemsExtension.ItemsElementType.items
, items = list of Item
and an
optional value for the max_items attribute.
ItemsExtension.ItemsElementType.retract
, items = list of Item
containing
only id's and an optional value for the notify attribute.
ItemsExtension.ItemsElementType.items
, items = list of Item
and
attributeValue = null
ItemsExtension.ItemsElementType.items
, items = list of RetractItem
and
attributeValue = null
itemsType
- Type of representationnodeId
- The node to which the items are being sent or deleteditems
- The list of Item
or RetractItem
attributeValue
- The value of the max_itemspublic ItemsExtension(java.lang.String nodeId, java.lang.Integer maxItems)
ItemsExtension(ItemsElementType, String, List, String)
nodeId
- The node the items will be requested frommaxItems
- The limit on the number of items to retrieve (null for all)Method Detail |
---|
public ItemsExtension.ItemsElementType getItemsElementType()
public java.util.List<org.jivesoftware.smack.packet.PacketExtension> getExtensions()
EmbeddedPacketExtension
PacketExtension
objects.
getExtensions
in interface EmbeddedPacketExtension
PacketExtension
public java.util.List<? extends org.jivesoftware.smack.packet.PacketExtension> getItems()
Item
, RetractItem
, or null
public java.lang.String getAttributeValue()
ItemsExtension.ItemsElementType
.
public java.lang.String toXML()
toXML
in interface org.jivesoftware.smack.packet.PacketExtension
toXML
in class NodeExtension
public java.lang.String toString()
toString
in class NodeExtension
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |