Class FillableConfigureForm
java.lang.Object
org.jivesoftware.smackx.xdata.form.FilledForm
org.jivesoftware.smackx.xdata.form.FillableForm
org.jivesoftware.smackx.pubsub.form.FillableConfigureForm
- All Implemented Interfaces:
ConfigureFormReader,FormReader
-
Field Summary
Fields inherited from class org.jivesoftware.smackx.xdata.form.FilledForm
formTypeFormFieldFields inherited from interface org.jivesoftware.smackx.pubsub.form.ConfigureFormReader
FORM_TYPE -
Method Summary
Modifier and TypeMethodDescriptionvoidsetAccessModel(AccessModel accessModel) Sets the value of access model.voidsetBodyXSLT(String bodyXslt) Set the URL of an XSL transformation which can be applied to payloads in order to generate an appropriate message body element.voidsetChildren(List<String> children) Set the list of child node ids that are associated with a collection node.voidSets the policy that determines who may associate children with the node.voidsetChildrenAssociationWhitelist(List<? extends Jid> whitelist) Set the JID's in the whitelist of users that can associate child nodes with the collection node.voidsetChildrenMax(int max) Set the maximum number of child nodes that can be associated with a collection node.voidsetCollection(String collection) Sets the collection node which the node is affiliated with.voidsetCollections(Collection<String> collections) voidsetDataformXSLT(URL url) Sets the URL of an XSL transformation which can be applied to the payload format in order to generate a valid Data Forms result that the client could display using a generic Data Forms rendering engine.voidsetDataType(CharSequence type) Sets the type of node data, usually specified by the namespace of the payload (if any).voidsetDeliverPayloads(boolean deliver) Sets whether the node will deliver payloads with event notifications.voidsetItemReply(ItemReply reply) Sets who should get the replies to items.voidsetMaxItems(int max) Set the maximum number of items to persisted to this node ifConfigureFormReader.isPersistItems()is true.voidsetMaxPayloadSize(int max) Sets the maximum payload size in bytes.voidsetNodeType(NodeType type) Sets the node type.voidsetNotificationType(NotificationType notificationType) Sets the NotificationType for the node.voidsetNotifyConfig(boolean notify) Sets whether subscribers should be notified when the configuration changes.voidsetNotifyDelete(boolean notify) Sets whether subscribers should be notified when the node is deleted.voidsetNotifyRetract(boolean notify) Sets whether subscribers should be notified when items are deleted from the node.voidsetPersistentItems(boolean persist) Sets whether items should be persisted in the node.voidsetPresenceBasedDelivery(boolean presenceBased) Sets whether to deliver notifications to available users only.voidsetPublishModel(PublishModel publish) Sets the publishing model for the node, which determines who may publish to it.voidsetRosterGroupsAllowed(List<? extends CharSequence> groups) Sets the roster groups that are allowed to subscribe and retrieve items.voidsetSubscribe(boolean subscribe) Sets whether subscriptions are allowed.voidsetTitle(CharSequence title) Sets a human readable title for the node.Methods inherited from class org.jivesoftware.smackx.xdata.form.FillableForm
getDataFormToSubmit, getField, getSubmitForm, setAnswer, setAnswer, setAnswer, setAnswer, write, write, write, writeBoolean, writeListMulti, writeTextSingleMethods inherited from class org.jivesoftware.smackx.xdata.form.FilledForm
ensureFormType, getDataForm, getFieldOrThrow, getFormType, getInstructions, getTitle, hasFieldMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.jivesoftware.smackx.pubsub.form.ConfigureFormReader
getAccessModel, getBodyXSLT, getChildren, getChildrenAssociationPolicy, getChildrenAssociationWhitelist, getChildrenMax, getCollection, getDataformXSLT, getDataType, getItemReply, getMaxItems, getMaxPayloadSize, getNodeType, getNotificationType, getPublishModel, getRosterGroupsAllowed, getTitle, isDeliverPayloads, isNotifyConfig, isNotifyDelete, isNotifyRetract, isPersistItems, isPresenceBasedDelivery, isSubscribeMethods inherited from interface org.jivesoftware.smackx.xdata.form.FormReader
getField, readBoolean, readDate, readFirstValue, readInteger, readStringValues, readValues
-
Method Details
-
setAccessModel
Sets the value of access model.- Parameters:
accessModel- TODO javadoc me please
-
setBodyXSLT
Set the URL of an XSL transformation which can be applied to payloads in order to generate an appropriate message body element.- Parameters:
bodyXslt- The URL of an XSL
-
setChildren
Set the list of child node ids that are associated with a collection node.- Parameters:
children- TODO javadoc me please
-
setChildrenAssociationPolicy
Sets the policy that determines who may associate children with the node.- Parameters:
policy- The policy being set
-
setChildrenAssociationWhitelist
Set the JID's in the whitelist of users that can associate child nodes with the collection node. This is only relevant ifConfigureFormReader.getChildrenAssociationPolicy()is set toChildrenAssociationPolicy.whitelist.- Parameters:
whitelist- The list of JID's
-
setChildrenMax
Set the maximum number of child nodes that can be associated with a collection node.- Parameters:
max- The maximum number of child nodes.
-
setCollection
Sets the collection node which the node is affiliated with.- Parameters:
collection- The node id of the collection node
-
setCollections
-
setDataformXSLT
Sets the URL of an XSL transformation which can be applied to the payload format in order to generate a valid Data Forms result that the client could display using a generic Data Forms rendering engine.- Parameters:
url- The URL of an XSL transformation
-
setDeliverPayloads
Sets whether the node will deliver payloads with event notifications.- Parameters:
deliver- true if the payload will be delivered, false otherwise
-
setItemReply
Sets who should get the replies to items.- Parameters:
reply- Defines who should get the reply
-
setMaxItems
Set the maximum number of items to persisted to this node ifConfigureFormReader.isPersistItems()is true.- Parameters:
max- The maximum number of items to persist
-
setMaxPayloadSize
Sets the maximum payload size in bytes.- Parameters:
max- The maximum payload size
-
setNodeType
Sets the node type.- Parameters:
type- The node type
-
setNotifyConfig
Sets whether subscribers should be notified when the configuration changes.- Parameters:
notify- true if subscribers should be notified, false otherwise
-
setNotifyDelete
Sets whether subscribers should be notified when the node is deleted.- Parameters:
notify- true if subscribers should be notified, false otherwise
-
setNotifyRetract
Sets whether subscribers should be notified when items are deleted from the node.- Parameters:
notify- true if subscribers should be notified, false otherwise
-
setNotificationType
Sets the NotificationType for the node.- Parameters:
notificationType- The enum representing the possible options- Since:
- 4.3
-
setPersistentItems
Sets whether items should be persisted in the node.- Parameters:
persist- true if items should be persisted, false otherwise
-
setPresenceBasedDelivery
Sets whether to deliver notifications to available users only.- Parameters:
presenceBased- true if user must be available, false otherwise
-
setPublishModel
Sets the publishing model for the node, which determines who may publish to it.- Parameters:
publish- The enum representing the possible options for the publishing model
-
setRosterGroupsAllowed
Sets the roster groups that are allowed to subscribe and retrieve items.- Parameters:
groups- The roster groups
-
setSubscribe
Sets whether subscriptions are allowed.- Parameters:
subscribe- true if they are, false otherwise
-
setTitle
Sets a human readable title for the node.- Parameters:
title- The node title
-
setDataType
Sets the type of node data, usually specified by the namespace of the payload (if any).- Parameters:
type- The type of node data
-