org.jivesoftware.smackx.pubsub.form

Interface SubscribeFormReader

All Superinterfaces:

FormReader

All Known Implementing Classes:

FillableSubscribeForm, FilledSubscribeForm, SubscribeForm

public interface SubscribeFormReader
extends FormReader

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FORM_TYPE

Method Summary

Modifier and Type	Method and Description
default java.lang.Integer	getDigestFrequency() Gets the minimum number of milliseconds between sending notification digests.
default java.util.Date	getExpiry() Get the time at which the leased subscription will expire, or has expired.
default java.util.List<PresenceState>	getShowValues() Gets the PresenceState for which an entity wants to receive notifications.
default boolean	isDeliverOn() Determines if an entity wants to receive notifications.
default java.lang.Boolean	isDigestOn() Determines if notifications should be delivered as aggregations or not.
default java.lang.Boolean	isIncludeBody() Determines whether the entity wants to receive an XMPP message body in addition to the payload format.

Methods inherited from interface org.jivesoftware.smackx.xdata.form.FormReader

getField, readBoolean, readDate, readFirstValue, readInteger, readStringValues, readValues

Field Detail

FORM_TYPE

static final java.lang.String FORM_TYPE

See Also:

Constant Field Values

Method Detail

isDeliverOn

default boolean isDeliverOn()

Determines if an entity wants to receive notifications.

Returns:

true if want to receive, false otherwise

isDigestOn

default java.lang.Boolean isDigestOn()

Determines if notifications should be delivered as aggregations or not.

Returns:

true to aggregate, false otherwise

getDigestFrequency

default java.lang.Integer getDigestFrequency()

Gets the minimum number of milliseconds between sending notification digests.

Returns:

The frequency in milliseconds

getExpiry

default java.util.Date getExpiry()
                          throws java.text.ParseException

Get the time at which the leased subscription will expire, or has expired.

Returns:

The expiry date

Throws:

java.text.ParseException - in case the date could not be parsed.

isIncludeBody

default java.lang.Boolean isIncludeBody()

Determines whether the entity wants to receive an XMPP message body in addition to the payload format.

Returns:

true to receive the message body, false otherwise

getShowValues

default java.util.List<PresenceState> getShowValues()

Gets the PresenceState for which an entity wants to receive notifications.

Returns:

the list of states