Configuration API for PubNub Angular2 SDK

Angular2 V4 complete API reference for building real-time applications on PubNub, including basic usage and sample code.

Initialization

PubNub Angular2 is a wrapper for the PubNub JavaScript SDK v4 that adds a few extra features to simplify integration with Angular v2 and v4.

  • Support: Available to use with TypeScript or plain JavaScript.
  • Events: Delegate methods accept the triggerEvents option which will broadcast certain callback and binding these directly to the HTML.
  • Autoload: An easy and fast way to retrieve history messages from your channel.
  • Multiple instance behavior: All instances are accessible throughout your application via the PubNub service.

You can also use the native PubNub JavaScript SDK if you feel it is more suitable for your situation.

How to use PubNubAngular for Angular4

npm install --save pubnub pubnub-angular2

There are two ways to register PubNubAngular in your list of providers in your Angular App: ngModules or ngComponents.

Using your ngModule

Angular Module lets you to use the same instance of PubNub in all Angular Components declared in this. Then you will not need to register PubNub in any Angular Component hosted by the Angular Module.

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { PubNubAngular } from 'pubnub-angular2';
import { AppComponent } from './appComponent';
@NgModule({
imports:[ BrowserModule ],
declarations:[ AppComponent ],
providers:[ PubNubAngular ],
bootstrap:[ AppComponent ]
})
export class AppModule {
constructor() {}
}

Angular Component only lets you use the same instance of PubNub inside itself and its Angular Components children. For more information about this, refer to Dependency Injection and Hierarchical Dependency Injectors

import { Component } from '@angular/core';
import { PubNubAngular } from 'pubnub-angular2';
@Component({
selector: 'appComponent',
template: '<H1>PubNub Angular2 SDK Demo</H1>',
providers:[ PubNubAngular ]
})
export class AppComponent {
constructor() {}
}

Now, you can inject PubNubAngular into your ngComponents

Note

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 { Component } from '@angular/core';
import { PubNubAngular } from 'pubnub-angular2';
@Component({
selector: 'appComponent',
template: '<H1>PubNub Angular2 SDK Demo</H1>'
})
export class AppComponent {
constructor(pubnub: PubNubAngular) {
pubnub.init({
publishKey: 'YOUR PUB_KEY',
subscribeKey: 'YOUR SUB_KEY'
});
}
}

How to use PubNubAngular for Angular2

For Angular2 you have to add some extra steps in order to setup the environment. Your HTML page will have to include the following libraries:

  • Global dependencies for Angular2
  • Angular2
  • PubNub JavaScript SDK
  • PubNub Angular2 SDK

With JavaScript, it is possible to use the libraries from CDN, NPM, and Bower.

  1. Include global dependencies for Angular2:

    <script src="node_modules/core-js/client/shim.min.js"></script>
    <script src="node_modules/zone.js/dist/zone.js"></script>
    <script src="node_modules/reflect-metadata/Reflect.js"></script>
    <script src="node_modules/rxjs/bundles/Rx.js"></script>
  2. Include Angular2

    <script src="node_modules/@angular/core/bundles/core.umd.js"></script>
    <script src="node_modules/@angular/common/bundles/common.umd.js"></script>
    <script src="node_modules/@angular/compiler/bundles/compiler.umd.js"></script>
    <script src="node_modules/@angular/platform-browser/bundles/platform-browser.umd.js"></script>
    <script src="node_modules/@angular/forms/bundles/forms.umd.js"></script>
    <script src="node_modules/@angular/platform-browser-dynamic/bundles/platform-browser-dynamic.umd.js"></script>
  3. Include the latest version of the PubNub JavaScript SDK:

    <script src="node_modules/pubnub/dist/web/pubnub.js"></script>
  4. Include the PubNub Angular2 SDK:

    <script src="node_modules/pubnub-angular2/dist/pubnub-angular2.js"></script>

Integrate PubNub Angular2 SDK into your app with TypeScript

Your HTML page needs to include the libraries described above, but you need to load Angular2 and the PubNub Angular2 SDK from NPM modules.

  1. Include global dependencies for Angular2:

    <script src="node_modules/core-js/client/shim.min.js"></script>
    <script src="node_modules/zone.js/dist/zone.js"></script>
    <script src="node_modules/reflect-metadata/Reflect.js"></script>
    <script src="node_modules/rxjs/bundles/Rx.js"></script>
  2. Include the latest version of the PubNub JavaScript SDK:

    <script src="node_modules/pubnub/dist/web/pubnub.js"></script>
  3. Include and load libraries from systemjs:

    <script src="node_modules/systemjs/dist/system.src.js"></script>
    <script src="systemjs.config.js"></script>
    <script>
    System.import('app').catch(function(err){
    console.error(err);
    });
    </script>

Angular2 uses systemjs.config.js. Include the following libraries inside the map attribute:

  • Rxjs
  • Angular2
  • PubNub Angular2 SDK

Your systemjs.config.js should look like this:

map: {
'rxjs': 'npm:rxjs',
'@angular/core': 'npm:@angular/core/bundles/core.umd.js',
'@angular/common': 'npm:@angular/common/bundles/common.umd.js',
'@angular/compiler': 'npm:@angular/compiler/bundles/compiler.umd.js',
'@angular/platform-browser': 'npm:@angular/platform-browser/bundles/platform-browser.umd.js',
'@angular/platform-browser-dynamic': 'npm:@angular/platform-browser-dynamic/bundles/platform-browser-dynamic.umd.js',
'@angular/http': 'npm:@angular/http/bundles/http.umd.js',
'@angular/router': 'npm:@angular/router/bundles/router.umd.js',
'@angular/forms': 'npm:@angular/forms/bundles/forms.umd.js',
'pubnub-angular2': 'npm:pubnub-angular2/dist/pubnub-angular2.js'
}

Register the PubNub Angular2 SDK into Angular's list of Providers

There are two ways to register the PubNub Angular2 SDK in your app's list of providers: Angular Modules, and Components.

An Angular Module lets you use the same instance of PubNub in all Angular Components declared in the module. Then, you do not need to register PubNub in any Angular Component hosted by the Angular Module.

Registering inside an Angular Module using JavaScript
'use strict';

(function (app) {
app.appModule = ng.core.NgModule({
imports: [ng.platformBrowser.BrowserModule],
declarations: [app.appComponent],
providers: [ PubNubAngular ],
bootstrap: [app.appComponent]
}).Class({
constructor: function(){}
});

document.addEventListener('DOMContentLoaded', function(){
ng.platformBrowserDynamic.platformBrowserDynamic().bootstrapModule(app.appModule);
});
show all 16 lines
Registering inside an Angular Module using TypeScript
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { PubNubAngular } from 'pubnub-angular2';
import { AppComponent } from './appComponent';
@NgModule({
imports:[ BrowserModule ],
declarations:[ AppComponent ],
providers:[ PubNubAngular ],
bootstrap:[ AppComponent ]
})
export class AppModule {
constructor() {}
}

An Angular Component only lets to use the same instance of PubNub inside itself and its Angular Components children. For more information about this, refer to Dependency Injection and Hierarchical Dependency Injectors

Registering inside an Angular Component using JavaScript
(function (app) {
app.appComponent = ng.core.Component({
selector: 'appComponent',
template: '<H1>PubNub Angular2 SDK Demo</H1>'
providers: [ PubNubAngular ]
}).Class({
constructor: function () {}
});
})(window.app || (window.app = {}));
Registering inside an Angular Component using TypeScript
import { Component } from '@angular/core';
import { PubNubAngular } from 'pubnub-angular2';
@Component({
selector: 'appComponent',
template: '<H1>PubNub Angular2 SDK Demo</H1>',
providers: [PubNubAngular]
})
export class AppComponent {
constructor() {}
}

How to inject PubNubAngular

Registering PubNubAngular within the provider list in an Angular Module or Component lets you inject a PubNub instance into an Angular Component according to the Hierarchical Dependency then this will be a shared instance.

After injecting the PubNub instance in the Angular Component's constructor, initialize the service including the PUB_KEY and SUB_KEY. This process only has to be done once, since this instance is shared by all Angular Components within the same dependency scope.

Injecting an instance of PubNub using JavaScript
Note

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.

(function (app) {
app.appComponent = ng.core.Component({
selector: 'appComponent',
template: '<H1>PubNub Angular2 SDK Demo</H1>'
}).Class({
constructor: [PubNubAngular, function(pubnub){
pubnub.init({
publishKey: 'YOUR PUB_KEY',
subscribeKey: 'YOUR SUB_KEY'
});
}]
});
})(window.app || (window.app = {}));
Injection an instance of PubNub using TypeScript
Note

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 { Component } from '@angular/core';
import { PubNubAngular } from 'pubnub-angular2';
@Component({
selector: 'appComponent',
template: '<H1>PubNub Angular2 SDK Demo</H1>'
})
export class AppComponent {
constructor(pubnub: PubNubAngular) {
pubnub.init({
publishKey: 'YOUR PUB_KEY',
subscribeKey: 'YOUR SUB_KEY'
});
}
}

Differences in usage with native JavaScript SDK

To learn about PubNub JavaScript features, refer to the PubNub JavaScript SDK documentation All methods of this SDK are wrapped with PubNubAngular

Native PubNub JavaScript SDK provides instance creation using Pubnub.init(), which returns a new instance with given credentials. In PubNub Angular2 SDK instances are hidden inside the service and are accessible via instance getters. Methods of default instance are mapped directly to the PubNub service, such as Pubnub.publish({...}). In most use cases, you can use only the default PubNub instance, but if you need multiple instances with different credentials, you should use the Pubnub.getInstance(instanceName) getter. In this case, the publish method is Pubnub.getInstance(instanceName).publish({}).

How to use the native PubNub JavaScript SDK

Native PubNub JavaScript SDK
Note

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 defaultInstance = new PubNub({
publishKey: 'YOUR PUB_KEY',
subscribeKey: 'YOUR SUB_KEY'
});

var anotherInstance = new PubNub({
publishKey: 'ANOTHER PUB_KEY',
subscribeKey: 'ANOTHER SUB_KEY'
});

defaultInstance.publish(
{
message: {such: 'Hello!'},
channel: 'my_channel'
},
show all 35 lines
Native PubNub JavaScript SDK using TypeScript
Note

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.

declare var PubNub: any;

var defaultInstance = new PubNub({
publishKey: 'YOUR PUB_KEY',
subscribeKey: 'YOUR SUB_KEY'
});

var anotherInstance = new PubNub({
publishKey: 'ANOTHER PUB_KEY',
subscribeKey: 'ANOTHER SUB_KEY'
});

defaultInstance.publish(
{
message: {such: 'Hello!'},
show all 37 lines

How to use PubNubAngular SDK

Using the PubNub Angular2 SDK with JavaScript
Note

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.

(function (app) {
app.appComponent = ng.core.Component({
selector: 'appComponent',
template: '<H1>PubNub Angular2 SDK Demo</H1>'
}).Class({
constructor: [PubNubAngular, function(pubnub){
pubnub.init({
publishKey: 'YOUR PUB_KEY',
subscribeKey: 'YOUR SUB_KEY'
});

pubnub.getInstance("another").init({
publishKey: 'ANOTHER PUB_KEY',
subscribeKey: 'ANOTHER SUB_KEY'
});
show all 46 lines
Using the PubNub Angular2 SDK with TypeScript
Note

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 { Component } from '@angular/core';
import { PubNubAngular } from 'pubnub-angular2';

@Component({
selector: 'appComponent',
template: '<H1>PubNub Angular2 SDK Demo</H1>'
})

export class AppComponent {
constructor(pubnub: PubNubAngular) {
pubnub.init({
publishKey: 'YOUR PUB_KEY',
subscribeKey: 'YOUR SUB_KEY'
});

show all 46 lines

That's it, you're ready to start using the PubNub Angular SDK

Description

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.

Method(s)

To Initialize PubNub you can use the following method(s) in the Angular2 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} )
ParameterTypeRequiredDefaultDescription
Operation ArgumentsHashYesA hash of arguments.
subscribeKeyStringYesSpecifies the subscribeKey to be used for subscribing to a channel. This key can be specified at initialization or along with a subscribe().
publishKeyStringOptionalSpecifies the publishKey to be used for publishing messages to a channel. This key can be specified at initialization or along with a publish().
cipherKeyStringOptionalIf passed, will encrypt the payloads.
authKeyStringOptionalIf Access Manager enabled, this key will be used on all requests.
logVerbosityBooleanOptionalfalselog HTTP information.
uuidStringYesUUID to use. You should set a unique UUID to identify the user or the device that connects to PubNub.
If you don't set the UUID, you won't be able to connect to PubNub.
sslBooleanOptionaltrueIf set to true, requests will be made over HTTPS.
originStringOptionalps.pndsn.comIf a custom domain is required, SDK accepts it here.
presenceTimeoutNumberOptional300How long the server will consider the client alive for presence.The value is in seconds.
heartbeatIntervalNumberOptionalNot SetHow often the client will announce itself to server.The value is in seconds.
restoreBooleanOptionalfalsetrue to allow catch up on the front-end applications.
keepAliveBooleanOptionalfalseIf set to true, SDK will use the same TCP connection for each HTTP request, instead of opening a new one for each new request.
keepAliveSettingsObjectOptionalkeepAliveMsecs: 1000 freeSocketKeepAliveTimeout: 15000 timeout: 30000 maxSockets: Infinity maxFreeSockets: 256Set 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.
suppressLeaveEventsBooleanOptionalfalseWhen true the SDK doesn't send out the leave requests.
requestMessageCountThresholdNumberOptional100PNRequestMessageCountExceededCategory is thrown when the number of messages into the payload is above of requestMessageCountThreshold.
listenToBrowserNetworkEventsBooleanOptionalfalseIf 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

Initialize the PubNub client API

Note

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. If you don't set the UUID, you won't be able to connect to PubNub.

pubnub.init({
subscribeKey: "YOUR SUB_KEY",
publishKey: "YOUR PUB_KEY",
ssl: true
});

Returns

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

Other Examples

Initialize the client

Note

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. If you don't set the UUID, you won't be able to connect to PubNub.

pubnub.init({
subscribeKey: 'YOUR SUB_KEY',
publishKey: 'YOUR PUB_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:

Note

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. If you don't set the UUID, you won't be able to connect to PubNub.

pubnub.init({
subscribeKey: "YOUR SUB_KEY"
});

Use a custom UUID

Set a custom UUID to identify your users.

Note

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. If you don't set the UUID, you won't be able to connect to PubNub.

pubnub.init({
publishKey: 'myPublishKey',
subscribeKey: 'mySubscribeKey',
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.

Note

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. If you don't set the UUID, you won't be able to connect to PubNub.

pubnub.init({
subscribeKey: "YOUR SUB_KEY",
publishKey: "YOUR PUB_KEY",
ssl: true
});

Initializing with Access Manager

Requires Access Manager add-on

This method requires that the Access Manager add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Note

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 Access Manager permissions, the API is initialized with the secretKey as in the following example:

Note

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. If you don't set the UUID, you won't be able to connect to PubNub.

pubnub.init({
subscribeKey: 'YOUR SUB_KEY',
publishKey: 'YOUR PUB_KEY',
secretKey: 'YOUR SECRET_KEY'
});

Now that the pubnub object is instantiated the client will be able to access the Access Manager functions. The pubnub object will use the secretKey to sign all Access Manager 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 Angular2 V4 SDK:

pubnub.setUUID(string)
ParameterTypeRequiredDescription
uuidStringYesUUID to set.
pubnub.getUUID()

This method doesn't take any arguments.

Basic Usage

Set UUID

Note

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. If you don't set the UUID, you won't be able to connect to PubNub.

pubnub.setUUID('myUniqueUUID');

Get UUID

var uuid = pubnub.getUUID();

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 Angular2 V4 SDK:

pubnub.setAuthKey(string)
ParameterTypeRequiredDescription
keyStringYesAuth key to set.

Basic Usage

pubnub.setAuthKey('my_authkey');

Returns

None.

Filter Expression

Requires Stream Controller add-on

This method requires that the Stream Controller add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Description

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.

Method(s)

pubnub.setFilterExpression(String filterExpression)
ParameterTypeRequiredDescription
filterExpressionStringYesPSV2 feature to subscribe with a custom filter expression.
pubnub.getFilterExpression()

This method doesn't take any arguments.

Basic Usage

Set Filter Expression

pubnub.setFilterExpression("such=wow");

Get Filter Expression

pubnub.getFilterExpression();