Package org.jivesoftware.smackx.pubsub

Enum SubscribeOptionFields

java.lang.Object

java.lang.Enum<SubscribeOptionFields>

org.jivesoftware.smackx.pubsub.SubscribeOptionFields

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SubscribeOptionFields>

public enum SubscribeOptionFields
extends java.lang.Enum<SubscribeOptionFields>

Defines the possible field options for a subscribe options form as defined by Section 16.4.2.

Enum Constant Summary

Enum Constants

Enum Constant	Description
deliver	Whether an entity wants to receive or disable notifications.
digest	Whether an entity wants to receive digests (aggregations) of notifications or all notifications individually.
digest_frequency	The minimum number of seconds between sending any two notifications digests.
expire	Expire.
include_body	Whether an entity wants to receive an XMPP message body in addition to the payload format.
show_values	The presence states for which an entity wants to receive notifications.
subscription_depth	Subscription depth.
subscription_type	Subscription type.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getFieldName()
static SubscribeOptionFields	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static SubscribeOptionFields	valueOfFromElement(java.lang.String elementName)
static SubscribeOptionFields[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

deliver

public static final SubscribeOptionFields deliver

Whether an entity wants to receive or disable notifications.

Value: boolean

digest

public static final SubscribeOptionFields digest

Whether an entity wants to receive digests (aggregations) of notifications or all notifications individually.

Value: boolean

digest_frequency

public static final SubscribeOptionFields digest_frequency

The minimum number of seconds between sending any two notifications digests.

Value: int

expire

public static final SubscribeOptionFields expire

Expire.

Value: Calendar

include_body

public static final SubscribeOptionFields include_body

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

Value: boolean

show_values

public static final SubscribeOptionFields show_values

The presence states for which an entity wants to receive notifications.

Value: PresenceState

subscription_type

public static final SubscribeOptionFields subscription_type

Subscription type.

Value:

subscription_depth

public static final SubscribeOptionFields subscription_depth

Subscription depth.

Value:

Method Detail

values

public static SubscribeOptionFields[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SubscribeOptionFields c : SubscribeOptionFields.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SubscribeOptionFields valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getFieldName

public java.lang.String getFieldName()

valueOfFromElement

public static SubscribeOptionFields valueOfFromElement(java.lang.String elementName)