public final class PublishOptions
extends java.lang.Object
Represents a standardized DataForm
with form type http://jabber.org/protocol/pubsub#publish-options
, which can be used to retrieve node meta data.
DataForm
to retrieve standard data from it, use:
PublishOptions publishOptions = new PublishOptions(dataForm);
To build a form:
PublishOptions publishOptions = PublishOptions.builder()
.accessModel(AccessModel.AUTHORIZE)
.persistItems(true)
.rosterGroupsAllowed(Collections.singleton("Friends"))
.sendLastPublishedItem(SendLastPublishedItem.ON_SUB)
.build();
PublishOptions publishOptions = PublishOptions.forStorageOfPublicData();
PublishOptions publishOptions = PublishOptions.forStorageOfPrivateData();
Modifier and Type | Class and Description |
---|---|
static class |
PublishOptions.Builder
A builder class to build the publish options form.
|
Constructor and Description |
---|
PublishOptions(DataForm dataForm) |
Modifier and Type | Method and Description |
---|---|
static PublishOptions.Builder |
builder()
Creates the builder to build a meta data form.
|
static PublishOptions |
forStorageOfPrivateData()
Creates publish options for use of persistent storage of private data via pubsub.
|
static PublishOptions |
forStorageOfPublicData(AccessModel accessModel)
Creates publish options for use of persistent storage of public data via pubsub.
|
AccessModel |
getAccessModel()
Gets the access model.
|
DataForm |
getDataForm()
Gets the underlying data form.
|
java.util.List<java.lang.String> |
getRosterGroupsAllowed()
Gets the allowed roster groups.
|
SendLastPublishedItem |
getSendLastPublishedItem()
Gets the value which specifies when to send the last published item.
|
java.lang.Boolean |
isPersistItems()
Whether items are persisted.
|
public PublishOptions(DataForm dataForm)
public static PublishOptions.Builder builder()
Creates the builder to build a meta data form.
public static PublishOptions forStorageOfPublicData(AccessModel accessModel)
Creates publish options for use of persistent storage of public data via pubsub.
accessModel
- The access model.public static PublishOptions forStorageOfPrivateData()
Creates publish options for use of persistent storage of private data via pubsub.
public final DataForm getDataForm()
Gets the underlying data form.
public final AccessModel getAccessModel()
Gets the access model.
public final java.lang.Boolean isPersistItems()
Whether items are persisted.
public final SendLastPublishedItem getSendLastPublishedItem()
Gets the value which specifies when to send the last published item.
public final java.util.List<java.lang.String> getRosterGroupsAllowed()
Gets the allowed roster groups.
Copyright © 2014–2019 XMPP.rocks. All rights reserved.