AngularJSAngularJS V4 Configuration API Reference for Realtime Apps

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

Pubnub Angular service is a wrapper for PubNub JavaScript SDK that adds a few extra features to simplify Angular integrations:

  • Multiple instance behavior: All instances are accessible throughout application via Pubnub service.
  • Events: Delegated methods accept the triggerEvents option which will broadcast certain callback as an AngularJS event.
  • A $pubnubChannel object that seamlessly binds a PubNub channel to a scope variable that gets updated with realtime data and allows you to interact with the channel through dedicated methods.
  • A $pubnubChannelGroup object that provides an easy-to-use interface for channel groups. It stores the incoming messages in containers split by the channel and exposes an interface to directly fetch messages by channel.

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

Your HTML page will include 2 key libraries:

  • PubNub JavaScript SDK
  • PubNub JavaScript SDK AngularJS Service
  1. Include AngularJS:
     
            <script src="//ajax.googleapis.com/ajax/libs/angularjs/1.5.8/angular.min.js"></script>
    
    
  2. Include the latest version of PubNub's Javascript SDK.
  3. Include PubNub's AngularJS SDK:
     
            <script src="<location-of-PubNub-SDK>/pubnub-angular-4.1.0.min.js"></script>
    
<body ng-app="PubNubAngularApp">

Where PubNubAngularApp is the name of the AngularJS module containing your app.

<script src="scripts/app.js"></script>
angular.module('PubNubAngularApp', ["pubnub.angular.service"])

This will make sure that the Pubnub object is available to get injected into your controllers.

<script src="scripts/controllers/main.js"></script>
.controller('MainCtrl', function($scope, Pubnub) { ... });

To learn about Pubnub JavaScript features refer to native Pubnub JavaScript SDK manual. All methods of this SDK are wrapped with Pubnub AngularJS Service.

Native Pubnub JavaScript SDK provides instance creation using Pubnub.init(), which returns new instance with given credentials. In Pubnub AngularJS SDK instances are hidden inside service and are accessible via instance getter. Methods of default instance are mapped directly to Pubnub service just like Pubnub.publish({...}). In most use cases usage of the only default Pubnub instance will be enough, but if you need multiple instances with different credentials, you should use Pubnub.getInstance(instanceName) getter. In this case publish method will looks like Pubnub.getInstance(instanceName).publish({}).

To summarize above let's check out the following 2 examples. Both of them performs the same job - creation of 2 Pubnub instances with different credentials. Publish method is invoked on the defaultInstance and grant method on anotherInstance.

var defaultInstance = new PubNub({
    publishKey: 'your pub key',
    subscribeKey: 'your sub key'
});

defaultInstance.publish(
    {
        message: { 
            such: 'Hello!' 
        },
        channel: 'myChannel'
    },
    function (status, response) {
        if (status.error) {
            console.log(status)
        } else {
            console.log("message Published w/ timetoken", response.timetoken)
        }
    }
);
Pubnub.init({
    publishKey: 'your pub key',
    subscribeKey: 'your sub key'
});

Pubnub.publish(
    {
        message: { 
            such: 'Hello!' 
        },
        channel: 'myChannel'
    },
    function (status, response) {
        if (status.error) {
            console.log(status)
        } else {
            console.log("message Published w/ timetoken", response.timetoken)
        }
    }
);

That's it - you're ready to start using the PubNub AngularJS SDK!

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 AngularJS V4 SDK:
  1. ParameterTypeRequiredDefaultsDescription
    Operation Arguments Hash YesA hash of arguments.
    subscribeKey String YesSpecifies the subscribeKey to be used for subscribing to a channel. This key can be specified at initialization or along with a subscribe().
    publishKey String OptionalSpecifies 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 OptionalIf passed, will encrypt the payloads.
    authKey StringOptionalIf PAM enabled, this key will be used on all requests.
    logVerbosity Boolean Optionalfalselog HTTP information.
    uuid String Optional SDK generated random uuidUUID to use, if not passed, a random will be generated.
    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 pubsub.pubnub.comIf 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 OptionalNot Set

    How often the client will announce itself to server.


    The value is in seconds.

    restore Boolean Optionalfalsetrue to allow catch up on the front-end applications.
    keepAliveBooleanOptional

    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.
    keepAliveSettingsObjectOptional

    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 OptionalfalseWhen true the SDK doesn't send out the leave requests.
    requestMessageCountThresholdNumberOptional100

    PNRequestMessageCountExceededCategory 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.
Pubnub.init({
    subscribeKey: "my_subkey",
    publishKey: "my_pubkey",
    ssl: true
});
It returns the Pubnub instance for invoking PubNub APIs like publish(), subscribe(), history(), hereNow(), etc.
  1. Pubnub.init({
        subscribeKey: "mySubscribeKey",
        publishKey: "myPublishKey",
        ssl: true
    })
  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:
    Pubnub.init({
        subscribeKey: 'my_subkey'
    })
  3. Set a custom UUID to identify your users.
    Pubnub.init({
        publishKey: 'demo',
        subscribeKey: 'demo',
        uuid: 'Stephen'
    })
  4. 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.

    Pubnub.init({
        subscribeKey: "my_subkey",
        publishKey: "my_pubkey",
        ssl: true
    });
    
  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 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:
    Pubnub.init({
        subscribeKey: 'my_subkey',
        publishKey: 'my_pubkey',
        secretKey: 'my_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.
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 AngularJS V4 SDK
  1. ParameterTypeRequiredDescription
    uuid String YesUUID to set.
  2. This method doesn't take any arguments.

  3. This method doesn't take any arguments.

Pubnub.setUUID("CustomUUID")
Pubnub.getUUID();
PubNub.generateUUID();
  1. var channel = PubNub.generateUUID();
    
    Pubnub.subscribe({
        channels: [channel]
    })
  2. var newUUID = PubNub.generateUUID();
    
    Pubnub.init({ 
        uuid: newUUID, 
        subscribeKey: "mySubscribeKey",
        publishKey: "myPublishKey",
        secretKey: "secretKey"
    });
  3. var randomAuthKey = PubNub.generateUUID();
       
    Pubnub.init({
        authKey: randomAuthKey, 
        subscribeKey: "mySubscribeKey",
        publishKey: "myPublishKey",
        secretKey: "secretKey"
    });
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().
To Set Authentication Key you can use the following method(s) in the AngularJS V4 SDK
  1. ParameterTypeRequiredDescription
    key String YesAuth key to set.
Pubnub.setAuthKey('my_new_authkey')
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.
To set/get filters you can use the following methods.
  1. ParameterTypeRequiredDescription
    filterExpressionStringYesPSV2 feature to subscribe with a custom filter expression.
  2. This method doesn't take any arguments.

Pubnub.setFilterExpression("such=wow");
Pubnub.getFilterExpression();

Go to Publish & Subscribe