Builder
Properties
If operating behind a misbehaving proxy, allow the client to shuffle the subdomains.
How long to keep idle connections alive in the OkHttp connection pool before evicting them.
Maximum number of idle connections to keep in the OkHttp connection pool.
How long before the client gives up trying to connect with the server.
CryptoModule is responsible for handling encryption and decryption. If set, all communications to and from PubNub will be encrypted.
Custom loggers list for creating additional logger instances. Use it if your slf4j implementation like logback, log4j2, etc. can't meet your specific logging requirements.
How many times publishing file message should automatically retry before marking the action as failed
Feature to subscribe with a custom filter expression.
Enable Google App Engine networking.
How often the client will announce itself to server.
Set Heartbeat notification options.
Sets a custom HttpLoggingInterceptor for logging network traffic.
Whether to include a instanceId with every request.
Whether to include a requestId with every request.
Set to PNLogVerbosity.BODY to enable logging of network traffic, otherwise se to PNLogVerbosity.NONE.
When true the SDK will resend the last channel state that was set using PubNub.setPresenceState for the current userId with every automatic heartbeat (if heartbeatInterval is greater than 0) and initial subscribe connection (also after e.g. loss of network).
Enables explicit presence control. When set to true heartbeat calls will contain only channels and groups added explicitly using PubNubCore.presence. Should be used only with ACL set on the server side. For more information please contact PubNub support
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.
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.
Sets the custom presence server timeout.
The publish key from the admin panel (only required if publishing).
Retry configuration for requests. Defaults to RetryConfiguration.Exponential enabled only for subscription endpoint (other endpoints are excluded).
The subscribe key from the admin panel.
The subscribe request timeout.
When true the SDK doesn't send out the leave requests.
Functions
If Access Manager (deprecated PAM v2) is utilized, client will use this authKey in all restricted requests.
Create a PNConfiguration object with values from this builder.
If operating behind a misbehaving proxy, allow the client to shuffle the subdomains.
How long to keep idle connections alive in the OkHttp connection pool before evicting them.
Maximum number of idle connections to keep in the OkHttp connection pool.
How long before the client gives up trying to connect with the server.
CryptoModule is responsible for handling encryption and decryption. If set, all communications to and from PubNub will be encrypted.
Custom loggers list for creating additional logger instances. Use it if your slf4j implementation like logback, log4j2, etc. can't meet your specific logging requirements.
How many times publishing file message should automatically retry before marking the action as failed
Feature to subscribe with a custom filter expression.
Enable Google App Engine networking.
How often the client will announce itself to server.
Set Heartbeat notification options.
Sets a custom HttpLoggingInterceptor for logging network traffic.
Whether to include a PubNubCore.instanceId with every request.
Whether to include a PubNubCore.requestId with every request.
Set to PNLogVerbosity.BODY to enable logging of network traffic, otherwise se to PNLogVerbosity.NONE.
When true the SDK will resend the last channel state that was set using PubNub.setPresenceState for the current userId with every automatic heartbeat (if heartbeatInterval is greater than 0) and initial subscribe connection (also after e.g. loss of network).
Enables explicit presence control. When set to true heartbeat calls will contain only channels and groups added explicitly using PubNubCore.presence. Should be used only with ACL set on the server side. For more information please contact PubNub support
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.
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.
Custom origin if needed.
Sets the custom presence server timeout.
Instructs the SDK to use a proxy configuration when communicating with PubNub servers.
The publish key from the admin panel (only required if publishing).
Retry configuration for requests. Defaults to RetryConfiguration.Exponential enabled only for subscription endpoint (other endpoints are excluded).
The secret key from the admin panel (only required for modifying/revealing access permissions).
If set to true, requests will be made over HTTPS.
The subscribe request timeout.
When true the SDK doesn't send out the leave requests.