Builder

interface Builder

Inheritors

Functions

Link copied to clipboard

If Access Manager (deprecated PAM v2) is utilized, client will use this authKey in all restricted requests.

Link copied to clipboard
abstract fun build(): PNConfiguration

Create a PNConfiguration object with values from this builder.

Link copied to clipboard
abstract fun connectTimeout(connectTimeout: Int): PNConfigurationOverride.Builder

How long before the client gives up trying to connect with the server.

Link copied to clipboard

CryptoModule is responsible for handling encryption and decryption. If set, all communications to and from PubNub will be encrypted.

Link copied to clipboard
abstract fun includeInstanceIdentifier(includeInstanceIdentifier: Boolean): PNConfigurationOverride.Builder

Whether to include a PubNubCore.instanceId with every request.

Link copied to clipboard
abstract fun includeRequestIdentifier(includeRequestIdentifier: Boolean): PNConfigurationOverride.Builder

Whether to include a PubNubCore.requestId with every request.

Link copied to clipboard
abstract fun nonSubscribeReadTimeout(nonSubscribeReadTimeout: Int): PNConfigurationOverride.Builder

For non subscribe operations (publish, herenow, etc), This property relates to a read timeout that is applied from the moment the connection between a client and the server has been successfully established. It defines a maximum time of inactivity between two data packets when waiting for the server’s response.

Link copied to clipboard

The publish key from the admin panel (only required if publishing).

Link copied to clipboard

Retry configuration for requests. Defaults to RetryConfiguration.Exponential enabled only for subscription endpoint (other endpoints are excluded).

Link copied to clipboard

The secret key from the admin panel (only required for modifying/revealing access permissions).

Link copied to clipboard
Link copied to clipboard