pubnub-gson-api/com.pubnub.api.java.v2.endpoints.pubsub/PublishBuilder

PublishBuilder

interface PublishBuilder : Endpoint<PNPublishResult>

Interface representing a builder for configuring a publish operation. This interface extends Endpoint to provide a fluent API for setting various parameters for the publish request.

Functions

async

abstract fun async(callback: Consumer<Result<Output>>)

customMessageType

abstract fun customMessageType(customMessageType: String): PublishBuilder

Specifies a custom message type for the message.

meta

abstract fun meta(meta: Any): PublishBuilder

Sets the metadata to be sent along with the message.

operationType

abstract fun operationType(): PNOperationType

overrideConfiguration

abstract fun overrideConfiguration(configuration: PNConfiguration): Endpoint<T>

Allows to override certain configuration options (see com.pubnub.api.v2.PNConfigurationOverride.Builder) for this request only.

replicate

abstract fun replicate(replicate: Boolean): PublishBuilder

Specifies whether the message should be replicated across datacenters.

retry

abstract fun retry()

shouldStore

abstract fun shouldStore(shouldStore: Boolean): PublishBuilder

Specifies whether the message should be stored in the history of the channel.

silentCancel

abstract fun silentCancel()

sync

abstract fun sync(): Output

ttl

abstract fun ttl(ttl: Integer): PublishBuilder

Sets the time-to-live (TTL) in Message Persistence.

usePOST

abstract fun usePOST(usePOST: Boolean): PublishBuilder

Configures the publish request to use the POST HTTP method instead of GET.