JavaScriptVueVueNode.jsPhoneGapReactReduxTitaniumWebVue V4 Configuration API Reference for Realtime AppsNode.js V4 Configuration API Reference for Realtime AppsPhoneGap V4 Configuration API Reference for Realtime AppsTitanium V4 Configuration API Reference for Realtime AppsJavaScript V4 Configuration API Reference for Realtime Apps

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

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

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

Initialization

Description

Use this method to initialize the PubNub Client API context and establish account-level credentials such as publish and subscribe keys. You can create an account and get your keys from the PubNub Dashboard.

Method(s)

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

1. Vue.use(PubNubVue,
{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

Applications can initialize the PubNub object by passing the subscribeKey and publishKey keys from your account. Each client should also pass a UUID that represents the user or the device that connects to PubNub.

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
});

Server Operations

For servers connecting to PubNub, setting a UUID is different than for a client device as there can be multiple instances of the server on the same machine and there is no "authentication" process for a server (at least not like an end user).

The API can be initialized with the secretKey if the server needs to administer PAM permissions for client applications. When you initialize PubNub 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 channels or channel groups. The servers get all access on all channels and channel groups.

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

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.

Other Examples

1. 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:

   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.

   import Vue from 'vue';
   import PubNubVue from 'pubnub-vue';
   
   // Initialize for Read Only Client
   
   Vue.use(PubNubVue, { 
   	subscribeKey : 'demo' 
   });

2. Initializing with SSL Enabled:

   This examples demonstrates how to enable PubNub Transport Layer Encryption with TLS(formerly known as 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.

   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.

   var pubnub = new PubNub({
       subscribeKey: "mySubscribeKey",
       publishKey: "myPublishKey",
       cipherKey: "myCipherKey",
       authKey: "myAuthKey",
       logVerbosity: true, // set false for production
       uuid: "myUniqueUUID",
       ssl: true
   });

UUID

Description

A UUID (Universal Unique Identifier) is a unique alphanumeric identifier used to identify the client to the PubNub platform. Each client should pass a UUID that represents the user or the device that connects to PubNub.

Setting the UUID

Set the UUID parameter when you instantiate a PubNub instance (i.e., new PubNub()). It is important that your application reuse the UUID on each device instead of generating a new UUID on each connection.

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

1. pubnub.setUUID(string)

   Parameter	Type	Required	Description
   uuid	String	Yes	UUID to set.

import PubNubVue from 'pubnub-vue';

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

Saving the UUID

Providing a value for the uuid parameter in the PubNub object initialization will result in that value getting saved in the browser's localStorage key (described above) automatically by the PubNub SDK. You may implement a different local caching strategy, as required.

Consider the following when implementing a UUID reuse strategy:

1. On your server, generate a UUID the when a user creates a user profile (user registration process). You can generate this with the SDK, or by another method of your choosing.
2. Pass the UUID back to the user upon successful login (authentication process).
3. Persist the UUID on the device where it can be retrieved the next time the PubNub instance is instantiated. The PubNub instance might be instantiated multiple times as the app is left and re-entered, and you may not require a login with each new session.

Getting the UUID

Use this method to get the current UUID set on your application.This method doesn't take any arguments.

import PubNubVue from 'pubnub-vue';

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

Generating the UUID

If your application does not need to use the UUID parameter for presence operations and account is not billed based on Monthly Active Users (MAUs) based pricing model.

PubNub.generateUUID();

Authentication Key

Description

Property

1. pubnub.setAuthKey(string)

   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

Filter Expression

Description

Method(s)

1. pubnub.setFilterExpression(String filterExpression)

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

2. pubnub.getFilterExpression()

   This method doesn't take any arguments.

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();