//pubnub-kotlin-core-api/com.pubnub.api.v2/PNConfiguration
[common]
expect interface PNConfiguration
[apple, js, jvm]
actual interface PNConfiguration
| Name | Summary |
|---|---|
| Builder | [jvm] interface Builder |
| Companion | [jvm] object Companion |
| Name | Summary |
|---|---|
| authKey | [common, apple, js] [common] expect abstract val [apple, js] actual abstract val [jvm] actual abstract val If Access Manager (deprecated PAM v2) is utilized, client will use this authKey in all restricted requests. |
| authToken | [common, apple, js, jvm] [common] expect abstract val authToken: String? [apple, js, jvm] actual abstract val 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. |
| cacheBusting | [jvm] abstract val cacheBusting: Boolean If operating behind a misbehaving proxy, allow the client to shuffle the subdomains. |
| certificatePinner | [jvm] abstract val certificatePinner: CertificatePinner? |
| connectionSpec | [jvm] abstract val connectionSpec: ConnectionSpec? |
| connectTimeout | [jvm] abstract val connectTimeout: Int How long before the client gives up trying to connect with the server. |
| cryptoModule | [jvm] abstract val cryptoModule: CryptoModule? CryptoModule is responsible for handling encryption and decryption. If set, all communications to and from PubNub will be encrypted. |
| dedupOnSubscribe | [jvm] abstract val dedupOnSubscribe: Boolean |
| enableEventEngine | [js] abstract val enableEventEngine: Boolean |
| fileMessagePublishRetryLimit | [jvm] abstract val fileMessagePublishRetryLimit: Int How many times publishing file message should automatically retry before marking the action as failed |
| filterExpression | [jvm] abstract val filterExpression: String Feature to subscribe with a custom filter expression. |
| googleAppEngineNetworking | [jvm] abstract val googleAppEngineNetworking: Boolean Enable Google App Engine networking. |
| heartbeatInterval | [jvm] abstract val heartbeatInterval: Int How often the client will announce itself to server. |
| heartbeatNotificationOptions | [jvm] abstract val heartbeatNotificationOptions: PNHeartbeatNotificationOptions Set Heartbeat notification options. |
| hostnameVerifier | [jvm] abstract val hostnameVerifier: HostnameVerifier? |
| httpLoggingInterceptor | [jvm] abstract val httpLoggingInterceptor: HttpLoggingInterceptor? Sets a custom HttpLoggingInterceptor for logging network traffic. |
| includeInstanceIdentifier | [jvm] abstract val includeInstanceIdentifier: Boolean Whether to include a PubNubCore.instanceId with every request. |
| includeRequestIdentifier | [jvm] abstract val includeRequestIdentifier: Boolean Whether to include a PubNubCore.requestId with every request. |
| logVerbosity | [common, apple, js] [common] expect abstract val logVerbosity: PNLogVerbosity [apple, js] actual abstract val logVerbosity: PNLogVerbosity [jvm] actual abstract val logVerbosity: PNLogVerbosity Set to PNLogVerbosity.BODY to enable logging of network traffic, otherwise se to PNLogVerbosity.NONE. |
| maintainPresenceState | [jvm] abstract val maintainPresenceState: Boolean 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). |
| managePresenceListManually | [jvm] abstract val managePresenceListManually: Boolean 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 |
| maximumConnections | [jvm] abstract val maximumConnections: Int? |
| maximumMessagesCacheSize | [jvm] abstract val maximumMessagesCacheSize: Int |
| nonSubscribeReadTimeout | [jvm] abstract val nonSubscribeReadTimeout: Int 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. |
| nonSubscribeRequestTimeout | [jvm] open val 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. |
| origin | [jvm] abstract val origin: String Custom origin if needed. |
| pnsdkSuffixes | [jvm] abstract val pnsdkSuffixes: Map<String, String> |
| presenceTimeout | [jvm] abstract val presenceTimeout: Int Sets the custom presence server timeout. |
| proxy | [jvm] abstract val proxy: Proxy? Instructs the SDK to use a proxy configuration when communicating with PubNub servers. |
| proxyAuthenticator | [jvm] abstract val proxyAuthenticator: Authenticator? |
| proxySelector | [jvm] abstract val proxySelector: ProxySelector? |
| publishKey | [common, apple, js] [common] expect abstract val publishKey: String [apple, js] actual abstract val publishKey: String [jvm] actual abstract val publishKey: String The publish key from the admin panel (only required if publishing). |
| retryConfiguration | [jvm] abstract val retryConfiguration: RetryConfiguration Retry configuration for requests. Defaults to RetryConfiguration.Exponential enabled only for subscription endpoint (other endpoints are excluded). |
| secretKey | [common] expect abstract val secretKey: String The secretKey should only be used within a server side and never exposed to client devices. [apple, js] [apple, js] actual abstract val secretKey: String [jvm] actual abstract val secretKey: String The secret key from the admin panel (only required for modifying/revealing access permissions). |
| secure | [jvm] abstract val secure: Boolean If set to true, requests will be made over HTTPS. |
| sslSocketFactory | [jvm] abstract val sslSocketFactory: SSLSocketFactory? |
| subscribeKey | [common, apple, js] [common] expect abstract val subscribeKey: String [apple, js] actual abstract val subscribeKey: String [jvm] actual abstract val subscribeKey: String The subscribe key from the admin panel. |
| subscribeTimeout | [jvm] abstract val subscribeTimeout: Int The subscribe request timeout. |
| suppressLeaveEvents | [jvm] abstract val suppressLeaveEvents: Boolean When true the SDK doesn’t send out the leave requests. |
| userId | [common, apple, js] [common] expect abstract val userId: UserId [apple, js] actual abstract val userId: UserId [jvm] actual abstract val userId: UserId The user ID that the PubNub client will use. |
| uuid | [jvm] open val |
| x509ExtendedTrustManager | [jvm] abstract val x509ExtendedTrustManager: X509ExtendedTrustManager? |