Class FillableSubscribeForm
- java.lang.Object
-
- org.jivesoftware.smackx.xdata.form.FilledForm
-
- org.jivesoftware.smackx.xdata.form.FillableForm
-
- org.jivesoftware.smackx.pubsub.form.FillableSubscribeForm
-
- All Implemented Interfaces:
SubscribeFormReader
,FormReader
public class FillableSubscribeForm extends FillableForm implements SubscribeFormReader
-
-
Field Summary
-
Fields inherited from class org.jivesoftware.smackx.xdata.form.FilledForm
formTypeFormField
-
Fields inherited from interface org.jivesoftware.smackx.pubsub.form.SubscribeFormReader
FORM_TYPE
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
setDeliverOn(boolean deliverNotifications)
Sets whether an entity wants to receive notifications.void
setDigestFrequency(int frequency)
Sets the minimum number of milliseconds between sending notification digests.void
setDigestOn(boolean digestOn)
Sets whether notifications should be delivered as aggregations or not.void
setExpiry(java.util.Date expire)
Sets the time at which the leased subscription will expire, or has expired.void
setIncludeBody(boolean include)
Sets whether the entity wants to receive an XMPP message body in addition to the payload format.void
setShowValues(java.util.Collection<PresenceState> stateValues)
Sets the list ofPresenceState
for which an entity wants to receive notifications.-
Methods inherited from class org.jivesoftware.smackx.xdata.form.FillableForm
getDataFormToSubmit, getField, setAnswer, setAnswer, setAnswer, setAnswer, write, write, write, writeBoolean, writeListMulti, writeTextSingle
-
Methods inherited from class org.jivesoftware.smackx.xdata.form.FilledForm
ensureFormType, getDataForm, getFieldOrThrow, getFormType, getInstructions, getTitle, hasField
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.jivesoftware.smackx.xdata.form.FormReader
getField, readBoolean, readDate, readFirstValue, readInteger, readStringValues, readValues
-
Methods inherited from interface org.jivesoftware.smackx.pubsub.form.SubscribeFormReader
getDigestFrequency, getExpiry, getShowValues, isDeliverOn, isDigestOn, isIncludeBody
-
-
-
-
Method Detail
-
setDeliverOn
public void setDeliverOn(boolean deliverNotifications)
Sets whether an entity wants to receive notifications.- Parameters:
deliverNotifications
- TODO javadoc me please
-
setDigestOn
public void setDigestOn(boolean digestOn)
Sets whether notifications should be delivered as aggregations or not.- Parameters:
digestOn
- true to aggregate, false otherwise
-
setDigestFrequency
public void setDigestFrequency(int frequency)
Sets the minimum number of milliseconds between sending notification digests.- Parameters:
frequency
- The frequency in milliseconds
-
setExpiry
public void setExpiry(java.util.Date expire)
Sets the time at which the leased subscription will expire, or has expired.- Parameters:
expire
- The expiry date
-
setIncludeBody
public void setIncludeBody(boolean include)
Sets whether the entity wants to receive an XMPP message body in addition to the payload format.- Parameters:
include
- true to receive the message body, false otherwise
-
setShowValues
public void setShowValues(java.util.Collection<PresenceState> stateValues)
Sets the list ofPresenceState
for which an entity wants to receive notifications.- Parameters:
stateValues
- The list of states
-
-