Vue V4 Configuration API Reference for Realtime Apps

import Vue from 'vue';
import PubNubVue from 'pubnub-vue';

Vue.use(PubNubVue, {
    subscribeKey: "mySubscribeKey",
    publishKey: "myPublishKey",
    cipherKey: "myCipherKey",
    authKey: "myAuthKey",
    logVerbosity: true,
    uuid: "myUniqueUUID",
    ssl: true,
    presenceTimeout: 130
});

Returns

It returns the Pubnub instance for invoking PubNub APIs like publish(), subscribe(), history(), hereNow(), etc.

Other Examples

import Vue from 'vue';
import PubNubVue from 'pubnub-vue';

Vue.use(PubNubVue, {
    subscribeKey: "mySubscribeKey",
    publishKey: "myPublishKey",
    ssl: true
});

Initialization for a Read-Only client:
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:
```
import Vue from 'vue';
import PubNubVue from 'pubnub-vue';

// Initialize for Read Only Client

Vue.use(PubNubVue, { 
	subscribeKey : 'demo' 
});
```

Initializing with SSL Enabled:

Set a custom UUID to identify your users.

import Vue from 'vue';
import PubNubVue from 'pubnub-vue';

Vue.use(PubNubVue, { 
	subscribeKey : 'mySubscribeKey', 
	uuid: 'myUniqueUUID' 
});

This examples demonstrates how to enable PubNub Transport Layer Encryption with SSL. Just initialize the client with ssl 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.

import Vue from 'vue';
import PubNubVue from 'pubnub-vue';

Vue.use(PubNubVue, {
    subscribeKey: "mySubscribeKey",
    publishKey: "myPublishKey",
    cipherKey: "myCipherKey",
    authKey: "myAuthKey",
    logVerbosity: true,
    uuid: "myUniqueUUID",
    ssl: true,
    presenceTimeout: 130
});

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 environments such as Node.js application or other 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:

import Vue from 'vue';
import PubNubVue from 'pubnub-vue';

Vue.use(PubNubVue, {
    subscribeKey: 'mySubscribeKey',
    publishKey: 'myPublishKey',
    secretKey: 'secretKey'
});

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.

UUID

Description

These functions are used to set/get a user ID on the fly.

Method(s)

To set/get UUID you can use the following method(s) in Vue V4 SDK

pubnub.setUUID(string)
Parameter Type Required Description
uuid String Yes UUID to set.
pubnub.getUUID()
This method doesn't take any arguments.

Parameter	Type	Required	Description
`uuid`	String	Yes	`UUID` to set.

Basic Usage

import PubNubVue from 'pubnub-vue';

const pubnub = PubNubVue.getInstance();
pubnub.setUUID('myUniqueUUID');

import PubNubVue from 'pubnub-vue';

const pubnub = PubNubVue.getInstance();
pubnub.getUUID();

Other Examples

import Vue from 'vue';
import PubNubVue from 'pubnub-vue';

Vue.use(PubNubVue, {
    subscribeKey: 'mySubscribeKey',
    publishKey: 'myPublishKey',
    uuid: 'myUniqueUUID'
});

Authentication Key

Description

This function provides the capability to reset a user's auth Key.

Typically auth Key is specified during initialization for PubNub Access Manager enabled applications. In the event that auth Key has expired or a new auth Key is issued to the client from a Security Authority, the new auth Key can be sent using setAuthKey().

Property

To Set Authentication Key you can use the following method(s) in the Vue V4 SDK

pubnub.setAuthKey(string)
Parameter Type Required Description
key String Yes Auth key to set.

Parameter	Type	Required	Description
`key`	String	Yes	`Auth key` to set.

Basic Usage

import PubNubVue from 'pubnub-vue';

const pubnub = PubNubVue.getInstance();
pubnub.setAuthKey('my_authkey');

Returns

None.

Filter Expression

Description

To set/get filters you can use the following methods.

Method(s)

pubnub.setFilterExpression(String filterExpression)
Parameter Type Required Description
filterExpression String Yes PSV2 feature to subscribe with a custom filter expression.
pubnub.getFilterExpression()
This method doesn't take any arguments.

Parameter	Type	Required	Description
`filterExpression`	String	Yes	PSV2 feature to `subscribe` with a custom filter expression.

Basic Usage

import PubNubVue from 'pubnub-vue';

const pubnub = PubNubVue.getInstance();
pubnub.setFilterExpression('such=wow');

import PubNubVue from 'pubnub-vue';

const pubnub = PubNubVue.getInstance();
pubnub.getFilterExpression();

Include PubNub JavaScript SDK

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

Initialization

You must include the PubNub JavaScript SDK in your code before initializing the client.


var PubNub = require('pubnub')

Description

Method(s)

To Initialize Pubnub you can use the following method(s) in the Node.js V4 SDK:

  PubNub(
 {String subscribeKey, String publishKey, String secretKey, String cipherKey, String authKey, Boolean logVerbosity, String uuid, Boolean ssl, String origin, Number presenceTimeout, Number heartbeatInterval, Boolean restore, Boolean keepAlive, Object keepAliveSettings, Boolean useInstanceId, Boolean suppressLeaveEvents, Proxy proxy, Number requestMessageCountThreshold, Boolean listenToBrowserNetworkEvents} )

Parameter	Type	Required	Defaults	Description
Operation Arguments	Hash	Yes		A hash of arguments.
`subscribeKey`	String	Yes		Specifies the `subscribeKey` to be used for subscribing to a channel. This key can be specified at initialization or along with a `subscribe()`.
`publishKey`	String	Optional		Specifies the `publishKey` to be used for publishing messages to a channel. This key can be specified at initialization or along with a `publish()`.
`secretKey`	String	Optional		Used for PAM operations (server only!!).
`cipherKey`	String	Optional		If passed, will encrypt the payloads.
`authKey`	String	Optional		If PAM enabled, this key will be used on all requests.
`logVerbosity`	Boolean	Optional	`false`	log HTTP information.
`uuid`	String	Yes	`SDK generated random 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.
`ssl`	Boolean	Optional	`true` for v4.20.0 onwards, `false` before v4.20.0	If set to `true`, requests will be made over HTTPS.
`origin`	String	Optional	`ps.pndsn.com`	If a custom domain is required, SDK accepts it here.
`presenceTimeout`	Number	Optional	`300`	How long the server will consider the client alive for presence. The value is in seconds.
`heartbeatInterval`	Number	Optional	`Not Set`	How often the client will announce itself to server. The value is in seconds.
`restore`	Boolean	Optional	`false`	`true` to allow catch up on the front-end applications.
`keepAlive`	Boolean	Optional	`true` for v4.18.0 onwards, `false` before v4.18.0	If set to `true`, SDK will use the same TCP connection for each HTTP request, instead of opening a new one for each new request.
`keepAliveSettings`	Object	Optional	`keepAliveMsecs`: 1000 `freeSocketKeepAliveTimeout`: 15000 `timeout`: 30000 `maxSockets`: Infinity `maxFreeSockets`: 256	Set a custom parameters for setting your connection `keepAlive` if this is set to `true`. `keepAliveMsecs: (Number)` how often to send TCP KeepAlive packets over sockets. `freeSocketKeepAliveTimeout: (Number)` sets the free socket to timeout after freeSocketKeepAliveTimeout milliseconds of inactivity on the free socket. `timeout: (Number)` sets the working socket to timeout after timeout milliseconds of inactivity on the working socket. `maxSockets: (Number)` maximum number of sockets to allow per host. `maxFreeSockets: (Number)` maximum number of sockets to leave open in a free state.
`useInstanceId`	Boolean	Optional		`InstanceId` is created for each new instance done and this is a composition of the prefix `pn-` and an uuid v4, this `instanceId` is used for signing each request to the service.
`suppressLeaveEvents`	Boolean	Optional	`false`	When `true` the SDK doesn't send out the leave requests.
`proxy`	Proxy	Optional		Instruct the SDK to use a `proxy` configuration when communicating with PubNub servers. Supported Protocols are `http`, `https`, `socks5`, `socks4` and `pac`.
`requestMessageCountThreshold`	Number	Optional	`100`	`PNRequestMessageCountExceededCategory` is thrown when the number of messages into the payload is above of `requestMessageCountThreshold`.
`listenToBrowserNetworkEvents`	Boolean	Optional	`false`	If the browser fails to detect the network changes from WiFi to LAN and vice versa or you get reconnection issues, set the flag to `false`. This allows the SDK reconnection logic to take over.

Basic Usage

// PubNub = require('pubnub'); 		ES5
import PubNub from 'pubnub';		ES6

var pubnub = new PubNub({
	subscribeKey: "mySubscribeKey",
	publishKey: "myPublishKey",
	secretKey: "secretKey",
	cipherKey: "myCipherKey",
	authKey: "myAuthKey",
	logVerbosity: true,
	uuid: "myUniqueUUID",
	ssl: true,
	presenceTimeout: 130
})

Returns

It returns the Pubnub instance for invoking PubNub APIs like publish(), subscribe(), history(), hereNow(), etc.

Other Examples

// PubNub = require('pubnub'); 		ES5
import PubNub from 'pubnub';		ES6

var pubnub = new PubNub({
	subscribeKey: "mySubscribeKey",
	publishKey: "myPublishKey",
	secretKey: "secretKey",
	ssl: true
})

Initialization for a Read-Only client:
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:
```
// Initialize for Read Only Client
 
var pubnub = new PubNub({
    subscribeKey : 'demo'
});
```

Initializing with SSL Enabled:

Set a custom UUID to identify your users.

var pubnub = new PubNub ({
    subscribeKey: "mySubscribeKey",
    publishKey: "myPublishKey",
    uuid: "myUniqueUUID"
})

// PubNub = require('pubnub'); 		ES5
import PubNub from 'pubnub';		ES6

var pubnub = new PubNub({
	subscribeKey: "mySubscribeKey",
	publishKey: "myPublishKey",
	secretKey: "secretKey",
	cipherKey: "myCipherKey",
	authKey: "myAuthKey",
	logVerbosity: true,
	uuid: "myUniqueUUID",
	ssl: true,
	presenceTimeout: 130
})

For applications that will administer PAM permissions, the API is initialized with the secretKey as in the following example:

var pubnub = new PubNub({
    subscribeKey: "mySubscribeKey",
    publishKey: "myPublishKey",
    secretKey: "secretKey"
});

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.

How to Set Proxy:

var proxy = new HttpsProxyAgent('http://username:password@<ip:port>');

var pubnub = new PubNub({ 
	subscribeKey: 'demo', 
	publishKey: 'demo', 
	proxy: proxy 
});

UUID

Description

These functions are used to set/get a user ID on the fly.

Method(s)

To set/get UUID you can use the following method(s) in Node.js V4 SDK

pubnub.setUUID(string)
Parameter Type Required Description
uuid String Yes UUID to set.
pubnub.getUUID()
This method doesn't take any arguments.
PubNub.generateUUID()
This method doesn't take any arguments.

Parameter	Type	Required	Description
`uuid`	String	Yes	`UUID` to set.

Basic Usage

pubnub.setUUID("myUniqueUUID")

pubnub.getUUID();

Creating a function to subscribe to a channel with a unique name:

PubNub.generateUUID();

Other Examples

var channel = PubNub.generateUUID();

pubnub.subscribe({
    channels: [channel]
})

Creating a unique auth Key for PAM on initialization:

var newUUID = PubNub.generateUUID();

var pubnub = new PubNub ({ 
    uuid: newUUID, 
    subscribeKey: "mySubscribeKey",
    publishKey: "myPublishKey",
    secretKey: "secretKey"
});

var randomAuthKey = PubNub.generateUUID();
   
var pubnub = new PubNub ({
	authKey: randomAuthKey, 
	subscribeKey: "mySubscribeKey",
	publishKey: "myPublishKey",
	secretKey: "secretKey"
});

Authentication Key

Description

This function provides the capability to reset a user's auth Key.

Property

To Set Authentication Key you can use the following method(s) in the Node.js V4 SDK

pubnub.setAuthKey(string)
Parameter Type Required Description
key String Yes Auth key to set.

Parameter	Type	Required	Description
`key`	String	Yes	`Auth key` to set.

Basic Usage

pubnub.setAuthKey("my_authkey");

Returns

None.

Filter Expression

Description

To set/get filters you can use the following methods.

Method(s)

pubnub.setFilterExpression(String filterExpression)
Parameter Type Required Description
filterExpression String Yes PSV2 feature to subscribe with a custom filter expression.
pubnub.getFilterExpression()
This method doesn't take any arguments.

Parameter	Type	Required	Description
`filterExpression`	String	Yes	PSV2 feature to `subscribe` with a custom filter expression.

Basic Usage

pubnub.setFilterExpression("such=wow");

pubnub.getFilterExpression();

Include PubNub JavaScript SDK

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

Initialization

You must include the PubNub JavaScript SDK in your code before initializing the client.


<script src="https://cdn.pubnub.com/sdk/javascript/pubnub.4.27.1.js"></script>

Description

Method(s)

To Initialize Pubnub you can use the following method(s) in the PhoneGap V4 SDK:

  PubNub(
 {String subscribeKey, String publishKey, String cipherKey, String authKey, Boolean logVerbosity, String uuid, Boolean ssl, String origin, Number presenceTimeout, Number heartbeatInterval, Boolean restore, Boolean keepAlive, Object keepAliveSettings, Boolean useInstanceId, Boolean suppressLeaveEvents, Number requestMessageCountThreshold, Boolean listenToBrowserNetworkEvents} )

Parameter	Type	Required	Defaults	Description
Operation Arguments	Hash	Yes		A hash of arguments.
`subscribeKey`	String	Yes		Specifies the `subscribeKey` to be used for subscribing to a channel. This key can be specified at initialization or along with a `subscribe()`.
`publishKey`	String	Optional		Specifies the `publishKey` to be used for publishing messages to a channel. This key can be specified at initialization or along with a `publish()`.
`cipherKey`	String	Optional		If passed, will encrypt the payloads.
`authKey`	String	Optional		If PAM enabled, this key will be used on all requests.
`logVerbosity`	Boolean	Optional	`false`	log HTTP information.
`uuid`	String	Yes	`SDK generated random 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.
`ssl`	Boolean	Optional	`true` for v4.20.0 onwards, `false` before v4.20.0	If set to `true`, requests will be made over HTTPS.
`origin`	String	Optional	`ps.pndsn.com`	If a custom domain is required, SDK accepts it here.
`presenceTimeout`	Number	Optional	`300`	How long the server will consider the client alive for presence. The value is in seconds.
`heartbeatInterval`	Number	Optional	`Not Set`	How often the client will announce itself to server. The value is in seconds.
`restore`	Boolean	Optional	`false`	`true` to allow catch up on the front-end applications.
`keepAlive`	Boolean	Optional	`true` for v4.18.0 onwards, `false` before v4.18.0	If set to `true`, SDK will use the same TCP connection for each HTTP request, instead of opening a new one for each new request.
`keepAliveSettings`	Object	Optional	`keepAliveMsecs`: 1000 `freeSocketKeepAliveTimeout`: 15000 `timeout`: 30000 `maxSockets`: Infinity `maxFreeSockets`: 256	Set a custom parameters for setting your connection `keepAlive` if this is set to `true`. `keepAliveMsecs: (Number)` how often to send TCP KeepAlive packets over sockets. `freeSocketKeepAliveTimeout: (Number)` sets the free socket to timeout after freeSocketKeepAliveTimeout milliseconds of inactivity on the free socket. `timeout: (Number)` sets the working socket to timeout after timeout milliseconds of inactivity on the working socket. `maxSockets: (Number)` maximum number of sockets to allow per host. `maxFreeSockets: (Number)` maximum number of sockets to leave open in a free state.
`suppressLeaveEvents`	Boolean	Optional	`false`	When `true` the SDK doesn't send out the leave requests.
`requestMessageCountThreshold`	Number	Optional	`100`	`PNRequestMessageCountExceededCategory` is thrown when the number of messages into the payload is above of `requestMessageCountThreshold`.
`listenToBrowserNetworkEvents`	Boolean	Optional	`false`	If the browser fails to detect the network changes from WiFi to LAN and vice versa or you get reconnection issues, set the flag to `false`. This allows the SDK reconnection logic to take over.

Basic Usage

var pubnub = new PubNub({
	subscribeKey: "mySubscribeKey",
	publishKey: "myPublishKey",
	cipherKey: "myCipherKey",
	authKey: "myAuthKey",
	logVerbosity: true,
	uuid: "myUniqueUUID",
	ssl: true,
	presenceTimeout: 130
});

Returns

It returns the Pubnub instance for invoking PubNub APIs like publish(), subscribe(), history(), hereNow(), etc.

Other Examples

var pubnub = new PubNub({
	subscribeKey: "mySubscribeKey",
	publishKey: "myPublishKey",
	ssl: true
})

Initialization for a Read-Only client:
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:
```
// Initialize for Read Only Client
 
var pubnub = new PubNub({
    subscribeKey : 'demo'
});
```

Set a custom UUID to identify your users.

var pubnub = new PubNub ({
    subscribeKey: "mySubscribeKey",
    publishKey: "myPublishKey",
    uuid: "myUniqueUUID"
})

Initializing with SSL Enabled:
This examples demonstrates how to enable PubNub Transport Layer Encryption with SSL. Just initialize the client with ssl 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.
```
var pubnub = new PubNub({
	subscribeKey: "mySubscribeKey",
	publishKey: "myPublishKey",
	cipherKey: "myCipherKey",
	authKey: "myAuthKey",
	logVerbosity: true,
	uuid: "myUniqueUUID",
	ssl: true,
	presenceTimeout: 130
});
```

For applications that will administer PAM permissions, the API is initialized with the secretKey as in the following example:

var pubnub = new PubNub({
    subscribeKey: "mySubscribeKey",
    publishKey: "myPublishKey",
    secretKey: "secretKey"
});

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.

UUID

Description

These functions are used to set/get a user ID on the fly.

Method(s)

To set/get UUID you can use the following method(s) in PhoneGap V4 SDK

pubnub.setUUID(string)
Parameter Type Required Description
uuid String Yes UUID to set.
pubnub.getUUID()
This method doesn't take any arguments.
PubNub.generateUUID()
This method doesn't take any arguments.

Parameter	Type	Required	Description
`uuid`	String	Yes	`UUID` to set.

Basic Usage

pubnub.setUUID("myUniqueUUID")

pubnub.getUUID();

Creating a function to subscribe to a channel with a unique name:

PubNub.generateUUID();

Other Examples

var channel = PubNub.generateUUID();

pubnub.subscribe({
    channels: [channel]
})

Creating a unique auth Key for PAM on initialization:

var newUUID = PubNub.generateUUID();

var pubnub = new PubNub ({ 
    uuid: newUUID, 
    subscribeKey: "mySubscribeKey",
    publishKey: "myPublishKey",
    secretKey: "secretKey"
});

var randomAuthKey = PubNub.generateUUID();
   
var pubnub = new PubNub ({
	authKey: randomAuthKey, 
	subscribeKey: "mySubscribeKey",
	publishKey: "myPublishKey",
	secretKey: "secretKey"
});

Authentication Key

Description

This function provides the capability to reset a user's auth Key.

Property

To Set Authentication Key you can use the following method(s) in the PhoneGap V4 SDK

pubnub.setAuthKey(string)
Parameter Type Required Description
key String Yes Auth key to set.

Parameter	Type	Required	Description
`key`	String	Yes	`Auth key` to set.

Basic Usage

pubnub.setAuthKey("my_authkey");

Returns

None.

Filter Expression

Description

To set/get filters you can use the following methods.

Method(s)

pubnub.setFilterExpression(String filterExpression)
Parameter Type Required Description
filterExpression String Yes PSV2 feature to subscribe with a custom filter expression.
pubnub.getFilterExpression()
This method doesn't take any arguments.

Parameter	Type	Required	Description
`filterExpression`	String	Yes	PSV2 feature to `subscribe` with a custom filter expression.

Basic Usage

pubnub.setFilterExpression("such=wow");

pubnub.getFilterExpression();

A beta release of the PubNub React framework, version 2.0 is now available. You can access it in the v2.0 branch of the react repository.

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

Initialization

PubNub React is a wrapper of PubNub JavaScript SDK version 4 that adds a few of extra features to simplify the integration with React\React Native:

Trigger Events: getMessage, getPresence, getStatus will make your life easier in the React' World.
Autoload: An easy and fast way to recovery the history messages of your channel.

You can still use the native PubNub JavaScript SDK if you feel this will be more suitable for your situation.

Differences in usage with native Javascript SDK

PubNub React is a wrapper of PubNub Javascript, which offers the same feature and in the same way like Javascript SDK makes, So if you have experience using Javascript SDK will be fast to learn the features included for React SDK in other way if you want to learn more about PubNub JavaScript features refer to native PubNub JavaScript SDK manual.

Differences between React and React Native

PubNub React works for both frameworks seamlessly the only difference will be how to you are going to implement all UI elements into the render() if your app is done with React or React Native.

That's it, you are ready to start using PubNub React SDK.

Description

Method(s)

To Initialize Pubnub you can use the following method(s) in the React V4 SDK:

  PubNub(
 {String subscribeKey, String publishKey, String cipherKey, String authKey, Boolean logVerbosity, String uuid, Boolean ssl, String origin, Number presenceTimeout, Number heartbeatInterval, Boolean restore, Boolean keepAlive, Object keepAliveSettings, Boolean useInstanceId, Boolean suppressLeaveEvents, Number requestMessageCountThreshold, Boolean listenToBrowserNetworkEvents} )

Parameter	Type	Required	Defaults	Description
Operation Arguments	Hash	Yes		A hash of arguments.
`subscribeKey`	String	Yes		Specifies the `subscribeKey` to be used for subscribing to a channel. This key can be specified at initialization or along with a `subscribe()`.
`publishKey`	String	Optional		Specifies the `publishKey` to be used for publishing messages to a channel. This key can be specified at initialization or along with a `publish()`.
`cipherKey`	String	Optional		If passed, will encrypt the payloads.
`authKey`	String	Optional		If PAM enabled, this key will be used on all requests.
`logVerbosity`	Boolean	Optional	`false`	log HTTP information.
`uuid`	String	Yes	`SDK generated random 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.
`ssl`	Boolean	Optional	`true` for v4.20.0 onwards, `false` before v4.20.0	If set to `true`, requests will be made over HTTPS.
`origin`	String	Optional	`ps.pndsn.com`	If a custom domain is required, SDK accepts it here.
`presenceTimeout`	Number	Optional	`300`	How long the server will consider the client alive for presence. The value is in seconds.
`heartbeatInterval`	Number	Optional	`Not Set`	How often the client will announce itself to server. The value is in seconds.
`restore`	Boolean	Optional	`false`	`true` to allow catch up on the front-end applications.
`keepAlive`	Boolean	Optional	`true` for v4.18.0 onwards, `false` before v4.18.0	If set to `true`, SDK will use the same TCP connection for each HTTP request, instead of opening a new one for each new request.
`keepAliveSettings`	Object	Optional	`keepAliveMsecs`: 1000 `freeSocketKeepAliveTimeout`: 15000 `timeout`: 30000 `maxSockets`: Infinity `maxFreeSockets`: 256	Set a custom parameters for setting your connection `keepAlive` if this is set to `true`. `keepAliveMsecs: (Number)` how often to send TCP KeepAlive packets over sockets. `freeSocketKeepAliveTimeout: (Number)` sets the free socket to timeout after freeSocketKeepAliveTimeout milliseconds of inactivity on the free socket. `timeout: (Number)` sets the working socket to timeout after timeout milliseconds of inactivity on the working socket. `maxSockets: (Number)` maximum number of sockets to allow per host. `maxFreeSockets: (Number)` maximum number of sockets to leave open in a free state.
`suppressLeaveEvents`	Boolean	Optional	`false`	When `true` the SDK doesn't send out the leave requests.
`requestMessageCountThreshold`	Number	Optional	`100`	`PNRequestMessageCountExceededCategory` is thrown when the number of messages into the payload is above of `requestMessageCountThreshold`.
`listenToBrowserNetworkEvents`	Boolean	Optional	`false`	If the browser fails to detect the network changes from WiFi to LAN and vice versa or you get reconnection issues, set the flag to `false`. This allows the SDK reconnection logic to take over.

Basic Usage

var pubnub = new PubNub({
	subscribeKey: "mySubscribeKey",
	publishKey: "myPublishKey",
	cipherKey: "myCipherKey",
	authKey: "myAuthKey",
	logVerbosity: true,
	uuid: "myUniqueUUID",
	ssl: true,
	presenceTimeout: 130
});

Returns

It returns the Pubnub instance for invoking PubNub APIs like publish(), subscribe(), history(), hereNow(), etc.

Other Examples

this.pubnub = new PubNubReact({
    publishKey: 'YOUR PUBLISH KEY',
    subscribeKey: 'YOUR SUBSCRIBE KEY',
    ssl: true 
});

Initialization for a Read-Only client:
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:
```
// Initialize for Read Only Client
 
var pubnub = new PubNub({
    subscribeKey : 'demo'
});
```

Set a custom UUID to identify your users.

var pubnub = new PubNub ({
    subscribeKey: "mySubscribeKey",
    publishKey: "myPublishKey",
    uuid: "myUniqueUUID"
})

Initializing with SSL Enabled:
This examples demonstrates how to enable PubNub Transport Layer Encryption with SSL. Just initialize the client with ssl 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.
```
var pubnub = new PubNub({
	subscribeKey: "mySubscribeKey",
	publishKey: "myPublishKey",
	cipherKey: "myCipherKey",
	authKey: "myAuthKey",
	logVerbosity: true,
	uuid: "myUniqueUUID",
	ssl: true,
	presenceTimeout: 130
});
```

For applications that will administer PAM permissions, the API is initialized with the secretKey as in the following example:

var pubnub = new PubNub({
    subscribeKey: "mySubscribeKey",
    publishKey: "myPublishKey",
    secretKey: "secretKey"
});

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.

UUID

Description

These functions are used to set/get a user ID on the fly.

Method(s)

To set/get UUID you can use the following method(s) in React V4 SDK

pubnub.setUUID(string)
Parameter Type Required Description
uuid String Yes UUID to set.
pubnub.getUUID()
This method doesn't take any arguments.
PubNub.generateUUID()
This method doesn't take any arguments.

Parameter	Type	Required	Description
`uuid`	String	Yes	`UUID` to set.

Basic Usage

pubnub.setUUID("myUniqueUUID")

pubnub.getUUID();

Creating a function to subscribe to a channel with a unique name:

PubNub.generateUUID();

Other Examples

var channel = PubNub.generateUUID();

pubnub.subscribe({
    channels: [channel]
})

Creating a unique auth Key for PAM on initialization:

var newUUID = PubNub.generateUUID();

var pubnub = new PubNub ({ 
    uuid: newUUID, 
    subscribeKey: "mySubscribeKey",
    publishKey: "myPublishKey",
    secretKey: "secretKey"
});

var randomAuthKey = PubNub.generateUUID();
   
var pubnub = new PubNub ({
	authKey: randomAuthKey, 
	subscribeKey: "mySubscribeKey",
	publishKey: "myPublishKey",
	secretKey: "secretKey"
});

Authentication Key

Description

This function provides the capability to reset a user's auth Key.

Property

To Set Authentication Key you can use the following method(s) in the React V4 SDK

pubnub.setAuthKey(string)
Parameter Type Required Description
key String Yes Auth key to set.

Parameter	Type	Required	Description
`key`	String	Yes	`Auth key` to set.

Basic Usage

pubnub.setAuthKey("my_authkey");

Returns

None.

Filter Expression

Description

To set/get filters you can use the following methods.

Method(s)

pubnub.setFilterExpression(String filterExpression)
Parameter Type Required Description
filterExpression String Yes PSV2 feature to subscribe with a custom filter expression.
pubnub.getFilterExpression()
This method doesn't take any arguments.

Parameter	Type	Required	Description
`filterExpression`	String	Yes	PSV2 feature to `subscribe` with a custom filter expression.

Basic Usage

pubnub.setFilterExpression("such=wow");

pubnub.getFilterExpression();

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

Initialization

PubNub Javascript SDK 4.27.1 has a distribution for Titanium which allows you to integrate PubNub to your mobile apps for iOS, Android and Mobile Web.

After downloading the source code and put this into the correct folder you can create an instance with simple lines of code in your app.js file.

var PubNub = require('pubnub');

var pubnub = new PubNub({
	subscribeKey: 'YOUR SUBSCRIBE KEY HERE',
	publishKey: 'YOUR PUBLISH KEY HERE'
});

That's it, you are ready to start using PubNub JS SDK.

Description

Method(s)

To Initialize Pubnub you can use the following method(s) in the Titanium V4 SDK:

  PubNub(
 {String subscribeKey, String publishKey, String cipherKey, String authKey, Boolean logVerbosity, String uuid, Boolean ssl, String origin, Number presenceTimeout, Number heartbeatInterval, Boolean restore, Boolean keepAlive, Object keepAliveSettings, Boolean useInstanceId, Boolean suppressLeaveEvents, Number requestMessageCountThreshold, Boolean listenToBrowserNetworkEvents} )

Parameter	Type	Required	Defaults	Description
Operation Arguments	Hash	Yes		A hash of arguments.
`subscribeKey`	String	Yes		Specifies the `subscribeKey` to be used for subscribing to a channel. This key can be specified at initialization or along with a `subscribe()`.
`publishKey`	String	Optional		Specifies the `publishKey` to be used for publishing messages to a channel. This key can be specified at initialization or along with a `publish()`.
`cipherKey`	String	Optional		If passed, will encrypt the payloads.
`authKey`	String	Optional		If PAM enabled, this key will be used on all requests.
`logVerbosity`	Boolean	Optional	`false`	log HTTP information.
`uuid`	String	Yes	`SDK generated random 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.
`ssl`	Boolean	Optional	`true` for v4.20.0 onwards, `false` before v4.20.0	If set to `true`, requests will be made over HTTPS.
`origin`	String	Optional	`ps.pndsn.com`	If a custom domain is required, SDK accepts it here.
`presenceTimeout`	Number	Optional	`300`	How long the server will consider the client alive for presence. The value is in seconds.
`heartbeatInterval`	Number	Optional	`Not Set`	How often the client will announce itself to server. The value is in seconds.
`restore`	Boolean	Optional	`false`	`true` to allow catch up on the front-end applications.
`keepAlive`	Boolean	Optional	`true` for v4.18.0 onwards, `false` before v4.18.0	If set to `true`, SDK will use the same TCP connection for each HTTP request, instead of opening a new one for each new request.
`keepAliveSettings`	Object	Optional	`keepAliveMsecs`: 1000 `freeSocketKeepAliveTimeout`: 15000 `timeout`: 30000 `maxSockets`: Infinity `maxFreeSockets`: 256	Set a custom parameters for setting your connection `keepAlive` if this is set to `true`. `keepAliveMsecs: (Number)` how often to send TCP KeepAlive packets over sockets. `freeSocketKeepAliveTimeout: (Number)` sets the free socket to timeout after freeSocketKeepAliveTimeout milliseconds of inactivity on the free socket. `timeout: (Number)` sets the working socket to timeout after timeout milliseconds of inactivity on the working socket. `maxSockets: (Number)` maximum number of sockets to allow per host. `maxFreeSockets: (Number)` maximum number of sockets to leave open in a free state.
`suppressLeaveEvents`	Boolean	Optional	`false`	When `true` the SDK doesn't send out the leave requests.
`requestMessageCountThreshold`	Number	Optional	`100`	`PNRequestMessageCountExceededCategory` is thrown when the number of messages into the payload is above of `requestMessageCountThreshold`.
`listenToBrowserNetworkEvents`	Boolean	Optional	`false`	If the browser fails to detect the network changes from WiFi to LAN and vice versa or you get reconnection issues, set the flag to `false`. This allows the SDK reconnection logic to take over.

Basic Usage

var pubnub = new PubNub({
	subscribeKey: "mySubscribeKey",
	publishKey: "myPublishKey",
	cipherKey: "myCipherKey",
	authKey: "myAuthKey",
	logVerbosity: true,
	uuid: "myUniqueUUID",
	ssl: true,
	presenceTimeout: 130
});

Returns

It returns the Pubnub instance for invoking PubNub APIs like publish(), subscribe(), history(), hereNow(), etc.

Other Examples

var pubnub = new PubNub({
    subscribeKey: 'YOUR SUBSCRIBE KEY HERE',
    publishKey: 'YOUR PUBLISH KEY HERE',
    ssl: true
});

Initialization for a Read-Only client:
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:
```
// Initialize for Read Only Client
 
var pubnub = new PubNub({
    subscribeKey : 'demo'
});
```

Set a custom UUID to identify your users.

var pubnub = new PubNub ({
    subscribeKey: "mySubscribeKey",
    publishKey: "myPublishKey",
    uuid: "myUniqueUUID"
})

Initializing with SSL Enabled:
This examples demonstrates how to enable PubNub Transport Layer Encryption with SSL. Just initialize the client with ssl 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.
```
var pubnub = new PubNub({
	subscribeKey: "mySubscribeKey",
	publishKey: "myPublishKey",
	cipherKey: "myCipherKey",
	authKey: "myAuthKey",
	logVerbosity: true,
	uuid: "myUniqueUUID",
	ssl: true,
	presenceTimeout: 130
});
```

For applications that will administer PAM permissions, the API is initialized with the secretKey as in the following example:

var pubnub = new PubNub({
    subscribeKey: "mySubscribeKey",
    publishKey: "myPublishKey",
    secretKey: "secretKey"
});

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.

UUID

Description

These functions are used to set/get a user ID on the fly.

Method(s)

To set/get UUID you can use the following method(s) in Titanium V4 SDK

pubnub.setUUID(string)
Parameter Type Required Description
uuid String Yes UUID to set.
pubnub.getUUID()
This method doesn't take any arguments.

Parameter	Type	Required	Description
`uuid`	String	Yes	`UUID` to set.

Basic Usage

pubnub.setUUID('myUniqueUUID');

var uuid = pubnub.getUUID();

Authentication Key

Description

This function provides the capability to reset a user's auth Key.

Property

To Set Authentication Key you can use the following method(s) in the Titanium V4 SDK

pubnub.setAuthKey(string)
Parameter Type Required Description
key String Yes Auth key to set.

Parameter	Type	Required	Description
`key`	String	Yes	`Auth key` to set.

Basic Usage

pubnub.setAuthKey("my_authkey");

Returns

None.

Filter Expression

Description

To set/get filters you can use the following methods.

Method(s)

pubnub.setFilterExpression(String filterExpression)
Parameter Type Required Description
filterExpression String Yes PSV2 feature to subscribe with a custom filter expression.
pubnub.getFilterExpression()
This method doesn't take any arguments.

Parameter	Type	Required	Description
`filterExpression`	String	Yes	PSV2 feature to `subscribe` with a custom filter expression.

Basic Usage

pubnub.setFilterExpression("such=wow");

pubnub.getFilterExpression();

Include PubNub JavaScript SDK

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

Initialization

You must include the PubNub JavaScript SDK in your code before initializing the client.


<script src="https://cdn.pubnub.com/sdk/javascript/pubnub.4.27.1.js"></script>

Description

Method(s)

To Initialize Pubnub you can use the following method(s) in the JavaScript V4 SDK:

  PubNub(
 {String subscribeKey, String publishKey, String cipherKey, String authKey, Boolean logVerbosity, String uuid, Boolean ssl, String origin, Number presenceTimeout, Number heartbeatInterval, Boolean restore, Boolean keepAlive, Object keepAliveSettings, Boolean useInstanceId, Boolean suppressLeaveEvents, Number requestMessageCountThreshold, Boolean autoNetworkDetection, Boolean listenToBrowserNetworkEvents} )

Parameter	Type	Required	Defaults	Description
Operation Arguments	Hash	Yes		A hash of arguments.
`subscribeKey`	String	Yes		Specifies the `subscribeKey` to be used for subscribing to a channel. This key can be specified at initialization or along with a `subscribe()`.
`publishKey`	String	Optional		Specifies the `publishKey` to be used for publishing messages to a channel. This key can be specified at initialization or along with a `publish()`.
`cipherKey`	String	Optional		If passed, will encrypt the payloads.
`authKey`	String	Optional		If PAM enabled, this key will be used on all requests.
`logVerbosity`	Boolean	Optional	`false`	log HTTP information.
`uuid`	String	Yes	`SDK generated random 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.
`ssl`	Boolean	Optional	`true` for v4.20.0 onwards, `false` before v4.20.0	If set to `true`, requests will be made over HTTPS.
`origin`	String	Optional	`ps.pndsn.com`	If a custom domain is required, SDK accepts it here.
`presenceTimeout`	Number	Optional	`300`	How long the server will consider the client alive for presence. The value is in seconds.
`heartbeatInterval`	Number	Optional	`Not Set`	How often the client will announce itself to server. The value is in seconds.
`restore`	Boolean	Optional	`false`	`true` to allow catch up on the front-end applications.
`keepAlive`	Boolean	Optional	`true` for v4.18.0 onwards, `false` before v4.18.0	If set to `true`, SDK will use the same TCP connection for each HTTP request, instead of opening a new one for each new request.
`keepAliveSettings`	Object	Optional	`keepAliveMsecs`: 1000 `freeSocketKeepAliveTimeout`: 15000 `timeout`: 30000 `maxSockets`: Infinity `maxFreeSockets`: 256	Set a custom parameters for setting your connection `keepAlive` if this is set to `true`. `keepAliveMsecs: (Number)` how often to send TCP KeepAlive packets over sockets. `freeSocketKeepAliveTimeout: (Number)` sets the free socket to timeout after freeSocketKeepAliveTimeout milliseconds of inactivity on the free socket. `timeout: (Number)` sets the working socket to timeout after timeout milliseconds of inactivity on the working socket. `maxSockets: (Number)` maximum number of sockets to allow per host. `maxFreeSockets: (Number)` maximum number of sockets to leave open in a free state.
			`keepAliveMsecs`: 1000	`keepAliveMsecs: (Number)` how often to send TCP KeepAlive packets over sockets.
			`freeSocketKeepAliveTimeout`: 15000	`freeSocketKeepAliveTimeout: (Number)` sets the free socket to timeout after freeSocketKeepAliveTimeout milliseconds of inactivity on the free socket.
			`timeout`: 30000	`timeout: (Number)` sets the working socket to timeout after timeout milliseconds of inactivity on the working socket.
			`maxSockets`: Infinity	`maxSockets: (Number)` maximum number of sockets to allow per host.
			`maxFreeSockets`: 256	`maxFreeSockets: (Number)` maximum number of sockets to leave open in a free state.
`suppressLeaveEvents`	Boolean	Optional	`false`	When `true` the SDK doesn't send out the leave requests.
`requestMessageCountThreshold`	Number	Optional	`100`	`PNRequestMessageCountExceededCategory` is thrown when the number of messages into the payload is above of `requestMessageCountThreshold`.
`autoNetworkDetection`	Boolean	Optional	`false`	This flag announces when the network is down or up using the states `PNNetworkDownCategory` and `PNNetworkUpCategory`.
`listenToBrowserNetworkEvents`	Boolean	Optional	`true`	If the browser fails to detect the network changes from WiFi to LAN and vice versa or you get reconnection issues, set the flag to `false`. This allows the SDK reconnection logic to take over.

Basic Usage

var pubnub = new PubNub({
	subscribeKey: "mySubscribeKey",
	publishKey: "myPublishKey",
	cipherKey: "myCipherKey",
	authKey: "myAuthKey",
	logVerbosity: true,
	uuid: "myUniqueUUID",
	ssl: true,
	presenceTimeout: 130
});

Returns

It returns the Pubnub instance for invoking PubNub APIs like publish(), subscribe(), history(), hereNow(), etc.

Other Examples

var pubnub = new PubNub({
	subscribeKey: "mySubscribeKey",
	publishKey: "myPublishKey",
	ssl: true
})

Initialization for a Read-Only client:
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:
```
// Initialize for Read Only Client
 
var pubnub = new PubNub({
    subscribeKey : 'demo'
});
```

Set a custom UUID to identify your users.

var pubnub = new PubNub ({
    subscribeKey: "mySubscribeKey",
    publishKey: "myPublishKey",
    uuid: "myUniqueUUID"
})

Initializing with SSL Enabled:
This examples demonstrates how to enable PubNub Transport Layer Encryption with SSL. Just initialize the client with ssl 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.
```
var pubnub = new PubNub({
	subscribeKey: "mySubscribeKey",
	publishKey: "myPublishKey",
	cipherKey: "myCipherKey",
	authKey: "myAuthKey",
	logVerbosity: true,
	uuid: "myUniqueUUID",
	ssl: true,
	presenceTimeout: 130
});
```

For applications that will administer PAM permissions, the API is initialized with the secretKey as in the following example:

var pubnub = new PubNub({
    subscribeKey: "mySubscribeKey",
    publishKey: "myPublishKey",
    secretKey: "secretKey"
});

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.

pubnub.setUUID(string)
Parameter Type Required Description
uuid String Yes UUID to set.
pubnub.getUUID()
This method doesn't take any arguments.
PubNub.generateUUID()
This method doesn't take any arguments.

Parameter	Type	Required	Description
`uuid`	String	Yes	`UUID` to set.

Basic Usage

pubnub.setUUID("myUniqueUUID")

pubnub.getUUID();

Creating a function to subscribe to a channel with a unique name:

PubNub.generateUUID();

Other Examples

var channel = PubNub.generateUUID();

pubnub.subscribe({
    channels: [channel]
})

Creating a unique auth Key for PAM on initialization:

var newUUID = PubNub.generateUUID();

var pubnub = new PubNub ({ 
    uuid: newUUID, 
    subscribeKey: "mySubscribeKey",
    publishKey: "myPublishKey",
    secretKey: "secretKey"
});

var randomAuthKey = PubNub.generateUUID();
   
var pubnub = new PubNub ({
	authKey: randomAuthKey, 
	subscribeKey: "mySubscribeKey",
	publishKey: "myPublishKey",
	secretKey: "secretKey"
});

pubnub.setAuthKey(string)
Parameter Type Required Description
key String Yes Auth key to set.

Parameter	Type	Required	Description
`key`	String	Yes	`Auth key` to set.

Basic Usage

pubnub.setAuthKey("my_authkey");

pubnub.setFilterExpression(String filterExpression)
Parameter Type Required Description
filterExpression String Yes PSV2 feature to subscribe with a custom filter expression.
pubnub.getFilterExpression()
This method doesn't take any arguments.

Parameter	Type	Required	Description
`filterExpression`	String	Yes	PSV2 feature to `subscribe` with a custom filter expression.

Basic Usage

pubnub.setFilterExpression("such=wow");

pubnub.getFilterExpression();