Builder

interface Builder

Properties

Link copied to clipboard
abstract var authKey: String

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

Link copied to clipboard
abstract var authToken: String?

Authentication token for the PubNub client. This token is required on the client side when Access Manager (PAM) is enabled for PubNub keys. It can be generated using the PubNub.grantToken method, which should be executed on the server side with a PubNub instance initialized using the secret key.

Link copied to clipboard
abstract var connectTimeout: Int

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

Link copied to clipboard
abstract var cryptoModule: CryptoModule?

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

Link copied to clipboard

Whether to include a PubNub.instanceId with every request.

Link copied to clipboard

Whether to include a PubNub.requestId with every request.

Link copied to clipboard

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
abstract var publishKey: String

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
abstract var secretKey: String

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

Link copied to clipboard
abstract var subscribeKey: String

The subscribe key from the admin panel.

Link copied to clipboard
abstract var userId: UserId

The user ID that the PubNub client will use.

Functions

Link copied to clipboard
abstract fun build(): PNConfiguration

Create a PNConfiguration object with values from this builder.