public static final class SubscribeOptions.Builder extends DataForm.Builder<SubscribeOptions.Builder>
A builder for the subscribe options.
SubscribeOptions
Modifier and Type | Method and Description |
---|---|
SubscribeOptions |
build()
Builds the subscribe options.
|
SubscribeOptions.Builder |
deliver(boolean deliver)
Sets whether an entity wants to receive or disable notifications.
|
SubscribeOptions.Builder |
digest(boolean digest)
Sets whether you want to receive digests (aggregations) of notifications or all notifications individually.
|
SubscribeOptions.Builder |
digestFrequency(int digestFrequency)
Sets the minimum number of milliseconds between sending any two notification digests
|
SubscribeOptions.Builder |
expireAt(java.time.Instant expireAt)
Sets the expiration date.
|
SubscribeOptions.Builder |
includeBody(boolean includeBody)
Sets whether you want to receive an XMPP message body in addition to the payload.
|
SubscribeOptions.Builder |
showValues(java.util.Collection<Presence.Show> showValues)
Sets the presence states for which an entity wants to receive notifications.
|
SubscribeOptions.Builder |
subscriptionDepth(int subscriptionDepth)
Sets the subscription depth.
|
SubscribeOptions.Builder |
subscriptionType(SubscribeOptions.SubscriptionType subscriptionType)
Sets the subscription type.
|
SubscribeOptions.Builder |
temporary(boolean temporary)
If the subscription is temporary, i.e. only as long as you are online.
|
fields, formType, instructions, items, pages, reportedFields, title, type
public final SubscribeOptions.Builder deliver(boolean deliver)
Sets whether an entity wants to receive or disable notifications.
deliver
- Whether an entity wants to receive or disable notifications.public final SubscribeOptions.Builder digest(boolean digest)
Sets whether you want to receive digests (aggregations) of notifications or all notifications individually.
digest
- Whether you want to receive digests (aggregations) of notifications or all notifications individually.public final SubscribeOptions.Builder digestFrequency(int digestFrequency)
Sets the minimum number of milliseconds between sending any two notification digests
digestFrequency
- The minimum number of milliseconds between sending any two notification digests.public final SubscribeOptions.Builder includeBody(boolean includeBody)
Sets whether you want to receive an XMPP message body in addition to the payload.
includeBody
- Whether you want to receive an XMPP message body in addition to the payload.public final SubscribeOptions.Builder showValues(java.util.Collection<Presence.Show> showValues)
Sets the presence states for which an entity wants to receive notifications. A null value corresponds to “available” presence.
showValues
- The presence states for which an entity wants to receive notifications.public final SubscribeOptions.Builder expireAt(java.time.Instant expireAt)
Sets the expiration date.
expireAt
- The expiration date.public final SubscribeOptions.Builder temporary(boolean temporary)
If the subscription is temporary, i.e. only as long as you are online.
temporary
- If the subscription is temporary, i.e. only as long as you are online.public final SubscribeOptions.Builder subscriptionType(SubscribeOptions.SubscriptionType subscriptionType)
Sets the subscription type.
subscriptionType
- The subscription type.public final SubscribeOptions.Builder subscriptionDepth(int subscriptionDepth)
Sets the subscription depth. If the depth is negative, the depth is interpreted as “all”.
subscriptionDepth
- The subscription depth.public final SubscribeOptions build()
Builds the subscribe options.
Copyright © 2014–2019 XMPP.rocks. All rights reserved.