SubscribeFormReader

All Superinterfaces:: FormReader

All Known Implementing Classes:: FillableSubscribeForm, FilledSubscribeForm, SubscribeForm

public interface SubscribeFormReader extends FormReader

Field Summary

Fields

Modifier and Type

Field

Description

static final String

FORM_TYPE
Method Summary

Modifier and Type

Method

Description

default Integer

getDigestFrequency()

Gets the minimum number of milliseconds between sending notification digests.

default Date

getExpiry()

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

default 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 Boolean

isDigestOn()

Determines if notifications should be delivered as aggregations or not.

default 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 Details
- FORM_TYPE
  
  static final String FORM_TYPE
  See Also:
  
  Constant Field Values
Method Details
- isDeliverOn
  
  default boolean isDeliverOn()
  
  Determines if an entity wants to receive notifications.
  
  Returns:
  
  true if want to receive, false otherwise
- isDigestOn
  
  default Boolean isDigestOn()
  
  Determines if notifications should be delivered as aggregations or not.
  
  Returns:
  
  true to aggregate, false otherwise
- getDigestFrequency
  
  default Integer getDigestFrequency()
  
  Gets the minimum number of milliseconds between sending notification digests.
  
  Returns:
  
  The frequency in milliseconds
- getExpiry
  
  default Date getExpiry() throws ParseException
  
  Get the time at which the leased subscription will expire, or has expired.
  
  Returns:
  
  The expiry date
  
  Throws:
  
  ParseException - in case the date could not be parsed.
- isIncludeBody
  
  default 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 List<PresenceState> getShowValues()
  
  Gets the PresenceState for which an entity wants to receive notifications.
  
  Returns:
  
  the list of states