AndroidAndroid V4 Configuration API Reference for Realtime Apps

Android V4 complete API reference for building Realtime Applications on PubNub, including basic usage and sample code.

PNConfiguration instance is storage for user-provided information which describe further PubNub client behaviour. Configuration instance contain additional set of properties which allow to perform precise PubNub client configuration.
To create configuration instance you can use the following function in the Android V4 SDK:
  1. PropertiesTypeRequiredDefaultsDescription
    setSubscribeKeyStringYessubscribeKey from the admin panel.
    setPublishKeyStringOptionalpublishKey from the admin panel (only required if publishing).
    setSecretKeyStringOptionalsecretKey (only required for access operations, keep away from Android).
    setCipherKeyStringOptionalIf cipher is passed, all communications to and from PubNub will be encrypted.
    setUuidStringYesSDK generated uuid

    UUID to use. You should set a unique UUID to identify the user or the device that connects to PubNub.

    Allowing the SDK to generate a random UUID can result in significant billing impacts, particularly on an MAU pricing plan.

    setLogVerbosityPNLogVerbosityOptionalPNLogVerbosity.NONESet PNLogVerbosity.BODY to enable debugging. To disable debugging use the option PNLogVerbosity.NONE
    setAuthKeyStringOptionalNot setIf Access Manager is utilized, client will use this authKey in all restricted requests.
    setCacheBustingBooleanOptionalIf operating behind a misbehaving proxy, allow the client to shuffle the subdomains.
    setSecureBooleanOptionaltrueWhen true TLS is enabled. TLS is enabled by default as of Android P; check this link if you want to use false in this setting (Not Recommended).
    setConnectTimeoutIntOptional5

    How long before the client gives up trying to connect with a subscribe call.

    The value is in seconds.

    setSubscribeTimeoutIntOptional310

    The subscribe request timeout.

    The value is in seconds.

    setNonSubscribeRequestTimeoutIntOptional10

    For non subscribe operations (publish, herenow, etc), how long to wait to connect to PubNub before giving up with a connection timeout error.

    The value is in seconds.

    setFilterExpressionStringOptionalNot setFeature to subscribe with a custom filter expression.
    setHeartbeatNotificationOptionsPNHeartbeatNotificationOptionsOptionalPNHeartbeatNotificationOptions.FAILURES

    Heartbeat notification options. By default, the SDK alerts on failed heartbeats (equivalent to PNHeartbeatNotificationOptions.FAILURES).

    Other options including all heartbeats (PNHeartbeatNotificationOptions.ALL) and no heartbeats (PNHeartbeatNotificationOptions.NONE) are supported.

    setOriginStringOptionalCustom origin if needed.
    setReconnectionPolicyPNReconnectionPolicyOptionalPNReconnectionPolicy.NONE

    Set to PNReconnectionPolicy.LINEAR for automatic reconnects. Use PNReconnectionPolicy.NONE to disable automatic reconnects.

    Use PNReconnectionPolicy.EXPONENTIAL to set exponential retry interval.

    setPresenceTimeoutIntOptional300

    Sets the custom presence server timeout.

    The value is in seconds, and the minimum value is 20 seconds.

    setPresenceTimeoutWithCustomIntervalInt, IntOptional300, 0

    Parameters are presence timeout (same as setPresenceTimeout) and custom heartbeat interval at which to ping the server.

    setProxyProxyOptionalInstruct the SDK to use a proxy configuration when communicating with PubNub servers. For more details see this https://docs.oracle.com/javase/7/docs/api/java/net/Proxy.html
    setMaximumReconnectionRetriesIntOptional-1The config sets how many times to retry to reconnect before giving up.
    setProxySelectorProxySelectorOptionalSets Java ProxySelector. For more details refer to https://docs.oracle.com/javase/7/docs/api/java/net/ProxySelector.html
    setProxyAuthenticatorAuthenticatorOptionalSets Java Authenticator. For more details, refer to https://docs.oracle.com/javase/7/docs/api/java/net/Authenticator.html
    setGoogleAppEngineNetworkingBooleanOptionalEnable Google App Engine networking.
    setSuppressLeaveEventsBooleanOptionalfalseWhen true the SDK doesn't send out the leave requests.
    requestMessageCountThresholdIntOptional100PNRequestMessageCountExceededCategory is thrown when the number of messages into the payload is above requestMessageCountThreshold.
    setDisableTokenManagerBooleanOptionalfalseDisables the TMS (Token Manager System) in a way that it won't authorize requests even if there are applicable tokens.
 Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. Not setting the UUID can significantly impact your billing if your account uses the Monthly Active Users (MAUs) based pricing model, and can also lead to unexpected behavior if you have Presence enabled.
PNConfiguration pnConfiguration = new PNConfiguration();
// subscribeKey from admin panel
pnConfiguration.setSubscribeKey("SubscribeKey"); // required
// publishKey from admin panel (only required if publishing)
pnConfiguration.setPublishKey("PublishKey"); 
// secretKey (only required for access operations, keep away from Android)
pnConfiguration.setSecretKey("SecretKey");
// if cipherKey is passed, all communicatons to/from pubnub will be encrypted
pnConfiguration.setCipherKey("cipherKey");
// UUID to be used as a device identifier, a default UUID is generated 
// if not passed
pnConfiguration.setUuid("myUniqueUUID");
// Enable Debugging
pnConfiguration.setLogVerbosity(PNLogVerbosity.BODY);
// if Access Manager is utilized, client will use this authKey in all restricted
// requests
pnConfiguration.setAuthKey("authKey");
// use SSL.
pnConfiguration.setSecure(true);
// PSV2 feature to subscribe with a custom filter expression
pnConfiguration.setFilterExpression("such=wow");
// heartbeat notifications, by default, the SDK will alert on failed heartbeats.
// other options such as all heartbeats or no heartbeats are supported.
pnConfiguration.setHeartbeatNotificationOptions(PNHeartbeatNotificationOptions.All);
pnConfiguration.setPresenceTimeout(120);
// the number of messages into the payload
pnConfiguration.setRequestMessageCountThreshold(100);
Add PubNub to your project using one of the procedures defined under How to Get It.
 

Put these permission outside the <application> tag, preferable before the tag in the AndroidManifest.xml.

  • <uses-permission android:name="android.permission.INTERNET" />
  • <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
This function is used for initializing the PubNub Client API context. This function must be called before attempting to utilize any API functionality in order to establish account level credentials such as publishKey and subscribeKey.
To Initialize Pubnub you can use the following method(s) in the Android V4 SDK:
  1. ParameterTypeRequiredDescription
    pnConfigurationPNConfigurationYesGoto Configuration for more details.
 Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. Not setting the UUID can significantly impact your billing if your account uses the Monthly Active Users (MAUs) based pricing model, and can also lead to unexpected behavior if you have Presence enabled.
PNConfiguration pnConfiguration = new PNConfiguration();
pnConfiguration.setSubscribeKey("my_subkey");
pnConfiguration.setPublishKey("my_pubkey");
pnConfiguration.setSecure(true);  
pnConfiguration.setUuid("myUniqueUUID");
PubNub pubnub = new PubNub(pnConfiguration);
It returns the Pubnub instance for invoking PubNub APIs like publish(), subscribe(), history(), hereNow(), etc.
  1.  Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. Not setting the UUID can significantly impact your billing if your account uses the Monthly Active Users (MAUs) based pricing model, and can also lead to unexpected behavior if you have Presence enabled.
    PNConfiguration pnConfiguration = new PNConfiguration();
    pnConfiguration.setSubscribeKey("SubscribeKey");
    pnConfiguration.setPublishKey("PublishKey");
    pnConfiguration.setSecure(false);
    pnConfiguration.setUuid("myUniqueUUID");
    PubNub pubnub = new PubNub(pnConfiguration);
  2. In the case where a client will only read messages and never publish to a channel, you can simply omit the publishKey when initializing the client:
     Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. Not setting the UUID can significantly impact your billing if your account uses the Monthly Active Users (MAUs) based pricing model, and can also lead to unexpected behavior if you have Presence enabled.
    PNConfiguration pnConfiguration = new PNConfiguration();
    pnConfiguration.setSubscribeKey("my_subkey");
    PubNub pubnub = new PubNub(pnConfiguration);
  3. Set a custom UUID to identify your users.
     Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. Not setting the UUID can significantly impact your billing if your account uses the Monthly Active Users (MAUs) based pricing model, and can also lead to unexpected behavior if you have Presence enabled.
    PNConfiguration pnConfiguration = new PNConfiguration();
    pnConfiguration.setSubscribeKey("mySubscribeKey");
    pnConfiguration.setPublishKey("myPublishKey");
    pnConfiguration.setUuid("myUniqueUUID");  
    PubNub pubnub = new PubNub(pnConfiguration);
    
  4. This examples demonstrates how to enable PubNub Transport Layer Encryption with SSL. Just initialize the client with setSecure set to true. The hard work is done, now the PubNub API takes care of the rest. Just subscribe and publish as usual and you are good to go.

     Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. Not setting the UUID can significantly impact your billing if your account uses the Monthly Active Users (MAUs) based pricing model, and can also lead to unexpected behavior if you have Presence enabled.
    PNConfiguration pnConfiguration = new PNConfiguration();
    pnConfiguration.setSubscribeKey("my_subkey");
    pnConfiguration.setPublishKey("my_pubkey");
    pnConfiguration.setSecure(true);  
    pnConfiguration.setUuid("myUniqueUUID");
    PubNub pubnub = new PubNub(pnConfiguration);
  5. Requires Access Manager add-on XRequires that the Access Manager add-on is enabled for your key. See this page on enabling add-on features on your keys:

    http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
     

    Anyone with the secretKey can grant and revoke permissions to your app. Never let your secretKey be discovered, and to only exchange it / deliver it securely. Only use the secretKey on secure server-side platforms.

    When you init with secretKey, you get root permissions for the Access Manager. With this feature you don't have to grant access to your servers to access channel data. The servers get all access on all channels.

    For applications that will administer PAM permissions, the API is initialized with the secretKey as in the following example:
     Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. Not setting the UUID can significantly impact your billing if your account uses the Monthly Active Users (MAUs) based pricing model, and can also lead to unexpected behavior if you have Presence enabled.
    PNConfiguration pnConfiguration = new PNConfiguration();
    pnConfiguration.setSubscribeKey("my_subkey");
    pnConfiguration.setPublishKey("my_pubkey");
    pnConfiguration.setSecretKey("my_secretkey");
    pnConfiguration.setUuid("myUniqueUUID");
    pnConfiguration.setSecure(true);  
    
    PubNub pubnub = new PubNub(pnConfiguration);
    
    Now that the pubnub object is instantiated the client will be able to access the PAM functions. The pubnub object will use the secretKey to sign all PAM messages to the PubNub Network.
  6.  Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. Not setting the UUID can significantly impact your billing if your account uses the Monthly Active Users (MAUs) based pricing model, and can also lead to unexpected behavior if you have Presence enabled.
    PNConfiguration pnConfiguration = new PNConfiguration();
    pnConfiguration.setSubscribeKey("mySubscribeKey");
    pnConfiguration.setPublishKey("myPublishKey");
    pnConfiguration.setSecretKey("mySecretKey");
    pnConfiguration.setUuid("myUniqueUUID");
    Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("http://mydomain.com", 8080));
    pnConfiguration.setProxy(proxy);
    PubNub pubNub = new PubNub(pnConfiguration);
These functions are used to set/get a user ID on the fly.
To set/get UUID you can use the following method(s) in Android V4 SDK
  1. ParameterTypeRequiredDefaultsDescription
    uuidStringYesSDK generated uuidUUID to be used as a device identifier, a default UUID is generated if not passed.
  2. This method doesn't take any arguments.

 Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. Not setting the UUID can significantly impact your billing if your account uses the Monthly Active Users (MAUs) based pricing model, and can also lead to unexpected behavior if you have Presence enabled.
PNConfiguration pnConfiguration = new PNConfiguration();
pnConfiguration.setUuid("myUniqueUUID");
PNConfiguration pnConfiguration = new PNConfiguration();
pnConfiguration.getUuid();
Setter and getter for users auth key.
  1. ParameterTypeRequiredDescription
    Auth KeyStringYesIf Access Manager is utilized, client will use this authKey in all restricted requests.
  2. This method doesn't take any arguments.
PNConfiguration pnConfiguration = new PNConfiguration();
pnConfiguration.setAuthKey("authKey");
pnConfiguration.getAuthKey();
None.

Requires Stream Controller add-on XRequires that the Stream Controller add-on is enabled for your key. See this page on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.

Stream filtering allows a subscriber to apply a filter to only receive messages that satisfy the conditions of the filter. The message filter is set by the subscribing client(s) but it is applied on the server side thus preventing unwanted messages (those that do not meet the conditions of the filter) from reaching the subscriber.

To set/get filters you can use the following method. To learn more about stream filtering, refer to the stream filtering tutorial.

  1. ParameterTypeRequiredDescription
    filterExpressionStringYesPSV2 feature to subscribe with a custom filter expression
  2. This method doesn't take any arguments.

 Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. Not setting the UUID can significantly impact your billing if your account uses the Monthly Active Users (MAUs) based pricing model, and can also lead to unexpected behavior if you have Presence enabled.
 Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. Not setting the UUID can significantly impact your billing if your account uses the Monthly Active Users (MAUs) based pricing model, and can also lead to unexpected behavior if you have Presence enabled.
PNConfiguration pnConfiguration = new PNConfiguration();
pnConfiguration.setFilterExpression("such=wow");
pnConfiguration.getFilterExpression();