PNConfiguration (pubnub-gson 4.25.0 API)

java.lang.Object
- com.pubnub.api.PNConfiguration

public class PNConfiguration
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description

PNConfiguration()
Initialize the PNConfiguration with default values

Constructors
Constructor and Description
`PNConfiguration()` Initialize the PNConfiguration with default values

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAuthKey()`
`okhttp3.CertificatePinner`	`getCertificatePinner()`
`java.lang.String`	`getCipherKey()`
`okhttp3.ConnectionSpec`	`getConnectionSpec()`
`int`	`getConnectTimeout()` Stores the maximum number of seconds which the client should wait for connection before timing out.
`java.lang.String`	`getFilterExpression()` filterExpression used as part of PSV2 specification.
`int`	`getHeartbeatInterval()` In seconds, How often the client should announce it's existence via heartbeating.
`PNHeartbeatNotificationOptions`	`getHeartbeatNotificationOptions()` verbosity of heartbeat configuration, by default only alerts on failed heartbeats
`javax.net.ssl.HostnameVerifier`	`getHostnameVerifier()`
`okhttp3.logging.HttpLoggingInterceptor`	`getHttpLoggingInterceptor()`
`PNLogVerbosity`	`getLogVerbosity()` toggle to enable verbose logging.
`java.lang.Integer`	`getMaximumConnections()`
`java.lang.Integer`	`getMaximumMessagesCacheSize()`
`int`	`getMaximumReconnectionRetries()` Set how many times the reconneciton manager will try to connect before giving app
`int`	`getNonSubscribeRequestTimeout()` Reference on number of seconds which is used by client during non-subscription operations to check whether response potentially failed with 'timeout' or not.
`java.lang.String`	`getOrigin()` By default, the origin is pointing directly to PubNub servers.
`int`	`getPresenceTimeout()` In seconds, how long the server will consider this client to be online before issuing a leave event.
`java.net.Proxy`	`getProxy()` Proxy configuration which will be passed to the networking layer.
`okhttp3.Authenticator`	`getProxyAuthenticator()`
`java.net.ProxySelector`	`getProxySelector()`
`java.lang.String`	`getPublishKey()` Publish Key provided by PubNub.
`PNReconnectionPolicy`	`getReconnectionPolicy()` Reconnection policy which will be used if/when networking goes down
`java.lang.Integer`	`getRequestMessageCountThreshold()` if set, the SDK will alert once the number of messages arrived in one call equal to the threshold
`java.lang.String`	`getSecretKey()`
`javax.net.ssl.SSLSocketFactory`	`getSslSocketFactory()`
`java.lang.String`	`getSubscribeKey()` Subscribe Key provided by PubNub
`int`	`getSubscribeTimeout()`
`java.lang.String`	`getUuid()`
`javax.net.ssl.X509ExtendedTrustManager`	`getX509ExtendedTrustManager()`
`boolean`	`isCacheBusting()` Deprecated.
`boolean`	`isDedupOnSubscribe()`
`boolean`	`isGoogleAppEngineNetworking()` Use Google App Engine based networking configuration
`boolean`	`isIncludeInstanceIdentifier()` Set to true to send a UUID for PubNub instance
`boolean`	`isIncludeRequestIdentifier()` Set to true to send a UUID on each request
`boolean`	`isSecure()` set to true to switch the client to HTTPS:// based communications.
`boolean`	`isStartSubscriberThread()`
`boolean`	`isSupressLeaveEvents()` Supress leave events when a channel gets disconnected
`PNConfiguration`	`setAuthKey(java.lang.String authKey)`
`PNConfiguration`	`setCacheBusting(boolean cacheBusting)` Deprecated.
`PNConfiguration`	`setCertificatePinner(okhttp3.CertificatePinner certificatePinner)`
`PNConfiguration`	`setCipherKey(java.lang.String cipherKey)`
`PNConfiguration`	`setConnectionSpec(okhttp3.ConnectionSpec connectionSpec)`
`PNConfiguration`	`setConnectTimeout(int connectTimeout)` Stores the maximum number of seconds which the client should wait for connection before timing out.
`PNConfiguration`	`setDedupOnSubscribe(boolean dedupOnSubscribe)`
`PNConfiguration`	`setFilterExpression(java.lang.String filterExpression)` filterExpression used as part of PSV2 specification.
`PNConfiguration`	`setGoogleAppEngineNetworking(boolean googleAppEngineNetworking)` Use Google App Engine based networking configuration
`PNConfiguration`	`setHeartbeatNotificationOptions(PNHeartbeatNotificationOptions heartbeatNotificationOptions)` verbosity of heartbeat configuration, by default only alerts on failed heartbeats
`PNConfiguration`	`setHostnameVerifier(javax.net.ssl.HostnameVerifier hostnameVerifier)`
`PNConfiguration`	`setHttpLoggingInterceptor(okhttp3.logging.HttpLoggingInterceptor httpLoggingInterceptor)`
`PNConfiguration`	`setIncludeInstanceIdentifier(boolean includeInstanceIdentifier)` Set to true to send a UUID for PubNub instance
`PNConfiguration`	`setIncludeRequestIdentifier(boolean includeRequestIdentifier)` Set to true to send a UUID on each request
`PNConfiguration`	`setLogVerbosity(PNLogVerbosity logVerbosity)` toggle to enable verbose logging.
`PNConfiguration`	`setMaximumConnections(java.lang.Integer maximumConnections)`
`PNConfiguration`	`setMaximumMessagesCacheSize(java.lang.Integer maximumMessagesCacheSize)`
`PNConfiguration`	`setMaximumReconnectionRetries(int maximumReconnectionRetries)` Set how many times the reconneciton manager will try to connect before giving app
`PNConfiguration`	`setNonSubscribeRequestTimeout(int nonSubscribeRequestTimeout)` Reference on number of seconds which is used by client during non-subscription operations to check whether response potentially failed with 'timeout' or not.
`PNConfiguration`	`setOrigin(java.lang.String origin)` By default, the origin is pointing directly to PubNub servers.
`PNConfiguration`	`setPresenceTimeout(int timeout)` set presence configurations for timeout and allow the client to pick the best interval
`PNConfiguration`	`setPresenceTimeoutWithCustomInterval(int timeout, int interval)` set presence configurations for timeout and announce interval.
`PNConfiguration`	`setProxy(java.net.Proxy proxy)` Proxy configuration which will be passed to the networking layer.
`PNConfiguration`	`setProxyAuthenticator(okhttp3.Authenticator proxyAuthenticator)`
`PNConfiguration`	`setProxySelector(java.net.ProxySelector proxySelector)`
`PNConfiguration`	`setPublishKey(java.lang.String publishKey)` Publish Key provided by PubNub.
`PNConfiguration`	`setReconnectionPolicy(PNReconnectionPolicy reconnectionPolicy)` Reconnection policy which will be used if/when networking goes down
`PNConfiguration`	`setRequestMessageCountThreshold(java.lang.Integer requestMessageCountThreshold)` if set, the SDK will alert once the number of messages arrived in one call equal to the threshold
`PNConfiguration`	`setSecretKey(java.lang.String secretKey)`
`PNConfiguration`	`setSecure(boolean secure)` set to true to switch the client to HTTPS:// based communications.
`PNConfiguration`	`setSslSocketFactory(javax.net.ssl.SSLSocketFactory sslSocketFactory)`
`PNConfiguration`	`setStartSubscriberThread(boolean startSubscriberThread)`
`PNConfiguration`	`setSubscribeKey(java.lang.String subscribeKey)` Subscribe Key provided by PubNub
`PNConfiguration`	`setSubscribeTimeout(int subscribeTimeout)`
`PNConfiguration`	`setSupressLeaveEvents(boolean supressLeaveEvents)` Supress leave events when a channel gets disconnected
`PNConfiguration`	`setUuid(java.lang.String uuid)`
`PNConfiguration`	`setX509ExtendedTrustManager(javax.net.ssl.X509ExtendedTrustManager x509ExtendedTrustManager)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PNConfiguration
```
public PNConfiguration()
```
    Initialize the PNConfiguration with default values
- Method Detail
  - setPresenceTimeoutWithCustomInterval
```
public PNConfiguration setPresenceTimeoutWithCustomInterval(int timeout,
                                                            int interval)
```
    set presence configurations for timeout and announce interval.
    
    Parameters:
    
    timeout - presence timeout; how long before the server considers this client to be gone.
    
    interval - presence announce interval, how often the client should announce itself.
    
    Returns:
    
    returns itself.
  - setPresenceTimeout
```
public PNConfiguration setPresenceTimeout(int timeout)
```
    set presence configurations for timeout and allow the client to pick the best interval
    
    Parameters:
    
    timeout - presence timeout; how long before the server considers this client to be gone.
    
    Returns:
    
    returns itself.
  - getOrigin
```
public java.lang.String getOrigin()
```
    By default, the origin is pointing directly to PubNub servers. If a proxy origin is needed, set a custom origin using this parameter.
  - getSubscribeTimeout
```
public int getSubscribeTimeout()
```
  - getPresenceTimeout
```
public int getPresenceTimeout()
```
    In seconds, how long the server will consider this client to be online before issuing a leave event.
  - getHeartbeatInterval
```
public int getHeartbeatInterval()
```
    In seconds, How often the client should announce it's existence via heartbeating.
  - isSecure
```
public boolean isSecure()
```
    set to true to switch the client to HTTPS:// based communications.
  - getSubscribeKey
```
public java.lang.String getSubscribeKey()
```
    Subscribe Key provided by PubNub
  - getPublishKey
```
public java.lang.String getPublishKey()
```
    Publish Key provided by PubNub.
  - getSecretKey
```
public java.lang.String getSecretKey()
```
  - getCipherKey
```
public java.lang.String getCipherKey()
```
  - getAuthKey
```
public java.lang.String getAuthKey()
```
  - getUuid
```
public java.lang.String getUuid()
```
  - isCacheBusting
```
@Deprecated
public boolean isCacheBusting()
```
    Deprecated.
    
    If proxies are forcefully caching requests, set to true to allow the client to randomize the subdomain. This configuration is not supported if custom origin is enabled.
  - getLogVerbosity
```
public PNLogVerbosity getLogVerbosity()
```
    toggle to enable verbose logging.
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Stores the maximum number of seconds which the client should wait for connection before timing out.
  - getNonSubscribeRequestTimeout
```
public int getNonSubscribeRequestTimeout()
```
    Reference on number of seconds which is used by client during non-subscription operations to check whether response potentially failed with 'timeout' or not.
  - isSupressLeaveEvents
```
public boolean isSupressLeaveEvents()
```
    Supress leave events when a channel gets disconnected
  - getHeartbeatNotificationOptions
```
public PNHeartbeatNotificationOptions getHeartbeatNotificationOptions()
```
    verbosity of heartbeat configuration, by default only alerts on failed heartbeats
  - getFilterExpression
```
public java.lang.String getFilterExpression()
```
    filterExpression used as part of PSV2 specification.
  - getReconnectionPolicy
```
public PNReconnectionPolicy getReconnectionPolicy()
```
    Reconnection policy which will be used if/when networking goes down
  - getMaximumReconnectionRetries
```
public int getMaximumReconnectionRetries()
```
    Set how many times the reconneciton manager will try to connect before giving app
  - getProxy
```
public java.net.Proxy getProxy()
```
    Proxy configuration which will be passed to the networking layer.
  - getProxySelector
```
public java.net.ProxySelector getProxySelector()
```
  - getProxyAuthenticator
```
public okhttp3.Authenticator getProxyAuthenticator()
```
  - getCertificatePinner
```
public okhttp3.CertificatePinner getCertificatePinner()
```
  - getMaximumConnections
```
public java.lang.Integer getMaximumConnections()
```
  - getHttpLoggingInterceptor
```
public okhttp3.logging.HttpLoggingInterceptor getHttpLoggingInterceptor()
```
  - getRequestMessageCountThreshold
```
public java.lang.Integer getRequestMessageCountThreshold()
```
    if set, the SDK will alert once the number of messages arrived in one call equal to the threshold
  - isGoogleAppEngineNetworking
```
public boolean isGoogleAppEngineNetworking()
```
    Use Google App Engine based networking configuration
  - isStartSubscriberThread
```
public boolean isStartSubscriberThread()
```
  - isDedupOnSubscribe
```
public boolean isDedupOnSubscribe()
```
  - getMaximumMessagesCacheSize
```
public java.lang.Integer getMaximumMessagesCacheSize()
```
  - setSslSocketFactory
```
public PNConfiguration setSslSocketFactory(javax.net.ssl.SSLSocketFactory sslSocketFactory)
```
  - setX509ExtendedTrustManager
```
public PNConfiguration setX509ExtendedTrustManager(javax.net.ssl.X509ExtendedTrustManager x509ExtendedTrustManager)
```
  - setConnectionSpec
```
public PNConfiguration setConnectionSpec(okhttp3.ConnectionSpec connectionSpec)
```
  - setHostnameVerifier
```
public PNConfiguration setHostnameVerifier(javax.net.ssl.HostnameVerifier hostnameVerifier)
```
  - setIncludeInstanceIdentifier
```
public PNConfiguration setIncludeInstanceIdentifier(boolean includeInstanceIdentifier)
```
    Set to true to send a UUID for PubNub instance
    
    Returns:
    
    this
  - setIncludeRequestIdentifier
```
public PNConfiguration setIncludeRequestIdentifier(boolean includeRequestIdentifier)
```
    Set to true to send a UUID on each request
    
    Returns:
    
    this
  - setOrigin
```
public PNConfiguration setOrigin(java.lang.String origin)
```
    By default, the origin is pointing directly to PubNub servers. If a proxy origin is needed, set a custom origin using this parameter.
    
    Returns:
    
    this
  - setSubscribeTimeout
```
public PNConfiguration setSubscribeTimeout(int subscribeTimeout)
```
  - setSecure
```
public PNConfiguration setSecure(boolean secure)
```
    set to true to switch the client to HTTPS:// based communications.
    
    Returns:
    
    this
  - setSubscribeKey
```
public PNConfiguration setSubscribeKey(java.lang.String subscribeKey)
```
    Subscribe Key provided by PubNub
    
    Returns:
    
    this
  - setPublishKey
```
public PNConfiguration setPublishKey(java.lang.String publishKey)
```
    Publish Key provided by PubNub.
    
    Returns:
    
    this
  - setSecretKey
```
public PNConfiguration setSecretKey(java.lang.String secretKey)
```
  - setCipherKey
```
public PNConfiguration setCipherKey(java.lang.String cipherKey)
```
  - setAuthKey
```
public PNConfiguration setAuthKey(java.lang.String authKey)
```
  - setUuid
```
public PNConfiguration setUuid(java.lang.String uuid)
```
  - setCacheBusting
```
@Deprecated
public PNConfiguration setCacheBusting(boolean cacheBusting)
```
    Deprecated.
    
    If proxies are forcefully caching requests, set to true to allow the client to randomize the subdomain. This configuration is not supported if custom origin is enabled.
    
    Returns:
    
    this
  - setLogVerbosity
```
public PNConfiguration setLogVerbosity(PNLogVerbosity logVerbosity)
```
    toggle to enable verbose logging.
    
    Returns:
    
    this
  - setConnectTimeout
```
public PNConfiguration setConnectTimeout(int connectTimeout)
```
    Stores the maximum number of seconds which the client should wait for connection before timing out.
    
    Returns:
    
    this
  - setNonSubscribeRequestTimeout
```
public PNConfiguration setNonSubscribeRequestTimeout(int nonSubscribeRequestTimeout)
```
    Reference on number of seconds which is used by client during non-subscription operations to check whether response potentially failed with 'timeout' or not.
    
    Returns:
    
    this
  - setSupressLeaveEvents
```
public PNConfiguration setSupressLeaveEvents(boolean supressLeaveEvents)
```
    Supress leave events when a channel gets disconnected
    
    Returns:
    
    this
  - setHeartbeatNotificationOptions
```
public PNConfiguration setHeartbeatNotificationOptions(PNHeartbeatNotificationOptions heartbeatNotificationOptions)
```
    verbosity of heartbeat configuration, by default only alerts on failed heartbeats
    
    Returns:
    
    this
  - setRequestMessageCountThreshold
```
public PNConfiguration setRequestMessageCountThreshold(java.lang.Integer requestMessageCountThreshold)
```
    if set, the SDK will alert once the number of messages arrived in one call equal to the threshold
    
    Returns:
    
    this
  - getSslSocketFactory
```
public javax.net.ssl.SSLSocketFactory getSslSocketFactory()
```
  - getX509ExtendedTrustManager
```
public javax.net.ssl.X509ExtendedTrustManager getX509ExtendedTrustManager()
```
  - getConnectionSpec
```
public okhttp3.ConnectionSpec getConnectionSpec()
```
  - getHostnameVerifier
```
public javax.net.ssl.HostnameVerifier getHostnameVerifier()
```
  - isIncludeInstanceIdentifier
```
public boolean isIncludeInstanceIdentifier()
```
    Set to true to send a UUID for PubNub instance
  - isIncludeRequestIdentifier
```
public boolean isIncludeRequestIdentifier()
```
    Set to true to send a UUID on each request
  - setFilterExpression
```
public PNConfiguration setFilterExpression(java.lang.String filterExpression)
```
    filterExpression used as part of PSV2 specification.
    
    Returns:
    
    this
  - setReconnectionPolicy
```
public PNConfiguration setReconnectionPolicy(PNReconnectionPolicy reconnectionPolicy)
```
    Reconnection policy which will be used if/when networking goes down
    
    Returns:
    
    this
  - setMaximumReconnectionRetries
```
public PNConfiguration setMaximumReconnectionRetries(int maximumReconnectionRetries)
```
    Set how many times the reconneciton manager will try to connect before giving app
    
    Returns:
    
    this
  - setProxy
```
public PNConfiguration setProxy(java.net.Proxy proxy)
```
    Proxy configuration which will be passed to the networking layer.
    
    Returns:
    
    this
  - setProxySelector
```
public PNConfiguration setProxySelector(java.net.ProxySelector proxySelector)
```
  - setProxyAuthenticator
```
public PNConfiguration setProxyAuthenticator(okhttp3.Authenticator proxyAuthenticator)
```
  - setCertificatePinner
```
public PNConfiguration setCertificatePinner(okhttp3.CertificatePinner certificatePinner)
```
  - setMaximumConnections
```
public PNConfiguration setMaximumConnections(java.lang.Integer maximumConnections)
```
  - setHttpLoggingInterceptor
```
public PNConfiguration setHttpLoggingInterceptor(okhttp3.logging.HttpLoggingInterceptor httpLoggingInterceptor)
```
  - setGoogleAppEngineNetworking
```
public PNConfiguration setGoogleAppEngineNetworking(boolean googleAppEngineNetworking)
```
    Use Google App Engine based networking configuration
    
    Returns:
    
    this
  - setStartSubscriberThread
```
public PNConfiguration setStartSubscriberThread(boolean startSubscriberThread)
```
  - setDedupOnSubscribe
```
public PNConfiguration setDedupOnSubscribe(boolean dedupOnSubscribe)
```
  - setMaximumMessagesCacheSize
```
public PNConfiguration setMaximumMessagesCacheSize(java.lang.Integer maximumMessagesCacheSize)
```

Class PNConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PNConfiguration

Method Detail

setPresenceTimeoutWithCustomInterval

setPresenceTimeout

getOrigin

getSubscribeTimeout

getPresenceTimeout

getHeartbeatInterval

isSecure

getSubscribeKey

getPublishKey

getSecretKey

getCipherKey

getAuthKey

getUuid

isCacheBusting

getLogVerbosity

getConnectTimeout

getNonSubscribeRequestTimeout

isSupressLeaveEvents

getHeartbeatNotificationOptions

getFilterExpression

getReconnectionPolicy

getMaximumReconnectionRetries

getProxy

getProxySelector

getProxyAuthenticator

getCertificatePinner

getMaximumConnections

getHttpLoggingInterceptor

getRequestMessageCountThreshold

isGoogleAppEngineNetworking

isStartSubscriberThread

isDedupOnSubscribe

getMaximumMessagesCacheSize

setSslSocketFactory

setX509ExtendedTrustManager

setConnectionSpec

setHostnameVerifier

setIncludeInstanceIdentifier

setIncludeRequestIdentifier

setOrigin

setSubscribeTimeout

setSecure

setSubscribeKey

setPublishKey

setSecretKey

setCipherKey

setAuthKey

setUuid

setCacheBusting

setLogVerbosity

setConnectTimeout

setNonSubscribeRequestTimeout

setSupressLeaveEvents

setHeartbeatNotificationOptions

setRequestMessageCountThreshold

getSslSocketFactory

getX509ExtendedTrustManager

getConnectionSpec

getHostnameVerifier

isIncludeInstanceIdentifier

isIncludeRequestIdentifier

setFilterExpression

setReconnectionPolicy

setMaximumReconnectionRetries

setProxy

setProxySelector

setProxyAuthenticator

setCertificatePinner

setMaximumConnections

setHttpLoggingInterceptor

setGoogleAppEngineNetworking

setStartSubscriberThread

setDedupOnSubscribe