Mobile Push Notifications API for PubNub AngularJs SDK

Mobile Push Notifications feature enables developers to bridge native PubNub publishing with 3rd-party push notification services including Google Android FCM (Firebase Cloud Messaging) and Apple iOS APNs (Apple Push Notification service).

By using the Mobile Push Notifications feature, developers can eliminate the need for developing, configuring, and maintaining additional server-side components for third-party push notification providers.

Add Device to Channel

note

Requires Mobile Push Notifications add-on

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

Enable mobile push notifications on provided set of channels.

Method(s)

To run Adding Device to Channel you can use the following method(s) in the AngularJS SDK:

Pubnub.push.addChannels({Array channels, String device, String pushGateway},Function callback)

Parameter	Type	Required	Description
Operation Arguments	Hash	Yes	A hash of arguments.
channels	Array	Yes	Specifies channel to associate with mobile push notifications.
device	String	Yes	The device ID to associate with mobile push notifications.
pushGateway	String	Yes	apns or gcm.
callback	Function	Optional	Executes on a successful/unsuccessful addChannels.

Basic Usage

Pubnub.push.addChannels(
    {
        channels: ['my_chat'],
        device: 'A655FBA9931AB',
        pushGateway: 'apns' // apns, gcm
    },
    function(status) {
        if (status.error) {
            console.log("operation failed w/ error:", status);
        } else {
            console.log("operation done!")
        }
    }
);

Response

{
    error: false,
    operation: 'PNPushNotificationEnabledChannelsOperation',
    statusCode: 200
}

List Channels For Device

note

Requires Mobile Push Notifications add-on

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

Request for all channels on which push notification has been enabled using specified pushToken.

Method(s)

To run Listing Channels For Device you can use the following method(s) in the AngularJS SDK:

1. Pubnub.push.listChannels({String device, String pushGateway},Function callback)

   Parameter	Type	Required	Description
   Operation Arguments	Hash	Yes	A hash of arguments.
   device	String	Yes	The device ID to associate with mobile push notifications.
   pushGateway	String	Yes	apns or gcm.
   callback	Function	Optional	Executes on a successful/unsuccessful listChannels.

Basic Usage

Listing Channels For Device:

Pubnub.push.listChannels(
    {
        device: 'A655FBA9931AB',
        pushGateway: 'apns' // apns, gcm
    },
    function (status, response) {
        if (status.error) {
            console.log("operation failed w/ error:", status);
            return;
        }

        console.log("listing push channel for device")
        response.channels.forEach( function (channel) {
            console.log(channel)
        })

show all 17 lines

Response

// Example of status
{
    error: false,
    operation: 'PNPushNotificationEnabledChannelsOperation',
    statusCode: 200
}

// Example of response
{
    channels: [ 'a', 'b' ]
}

Remove Device From Channel

note

Requires Mobile Push Notifications add-on

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

Disable mobile push notifications on provided set of channels.

Method(s)

To run Removing Device From Channel you can use the following method(s) in the AngularJS SDK:

Pubnub.push.removeChannels({Array channels, String device, String pushGateway},Function callback)

Parameter	Type	Required	Description
Operation Arguments	Hash	Yes	A hash of arguments.
channels	Array	Yes	Specifies channel to associate with mobile push notifications.
device	String	Yes	The device ID to associate with mobile push notifications.
pushGateway	String	Yes	apns or gcm.
callback	Function	Optional	Executes on a successful/unsuccessful removeChannels.

Basic Usage

Pubnub.push.removeChannels(
    {
        channels: ['my_chat'],
        device: 'A655FBA9931AB',
        pushGateway: 'apns' // apns, gcm
    },
    function(status) {
        if (status.error) {
            console.log("operation failed w/ error:", status);
        } else {
            console.log("operation done!")
        }
    }
);

Response

{
    error: false,
    operation: 'PNPushNotificationEnabledChannelsOperation',
    statusCode: 200
}

Remove all mobile push notifications

note

Requires Mobile Push Notifications add-on

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

Disable mobile push notifications from all channels registered with the specified pushToken.

Method(s)

To run Remove all mobile push notifications, you can use the following method(s) in the AngularJS SDK:

Pubnub.push.deleteDevice({String device, String pushGateway},Function callback)

Parameter	Type	Required	Description
Operation Arguments	Hash	Yes	A hash of arguments.
device	String	Yes	The device ID to associate with mobile push notifications.
pushGateway	String	Yes	apns or gcm.
callback	Function	Optional	Executes on a successful/unsuccessful deleteDevice.

Basic Usage

Pubnub.push.deleteDevice(
    {
        device: 'A655FBA9931AB',
        pushGateway: 'apns' // apns, gcm
    },
    function (status) {
        if (status.error) {
            console.log("operation failed w/ error:", status);
        } else {
            console.log("operation done!")
        }
    }
);

Response

{
    error: false,
    operation: 'PNPushNotificationEnabledChannelsOperation',
    statusCode: 200
}