Mobile Push Notifications API for Vue SDK

The Mobile Push Notifications feature connects native PubNub publishing to third-party push services. Supported services include Google Android FCM (Firebase Cloud Messaging) and Apple iOS APNs (Apple Push Notification service).

To learn more, read about Mobile Push Notifications.

Add a device to a push notifications channel

note

Requires Mobile Push Notifications add-on

Enable Mobile Push Notifications for your key in the Admin Portal. See how to enable add-on features.

Enable mobile push notifications on a set of channels.

Method(s)

Use the following method(s) in the Vue SDK:

pubnub.push.addChannels({Array channels, String device, String pushGateway, String environment, String topic},Function callback)

* required

Parameter	Description
channels * Type: Array Default: n/a	Channels to enable for push notifications.
device * Type: String Default: n/a	Device token.
pushGateway * Type: String Default: n/a	Accepted values: apns, apns2, gcm.
environment Type: String Default: development	APNs environment. Required if pushGateway is apns2.
topic Type: String Default: n/a	APNs topic (bundle identifier). Required if pushGateway is apns2.
callback Type: Function Default: n/a	Callback on success or error.

Sample code

Add device to channel

import PubNubVue from 'pubnub-vue';

const pubnub = PubNubVue.getInstance();

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

show all 18 lines

Response

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

List push notifications channels for a device

note

Requires Mobile Push Notifications add-on

Enable Mobile Push Notifications for your key in the Admin Portal. See how to enable add-on features.

List channels that have push notifications enabled for the specified device token.

Method(s)

Use the following method(s) in the Vue SDK:

pubnub.push.listChannels({String device, String pushGateway, String environment, String topic},Function callback)

* required

Parameter	Description
device * Type: String Default: n/a	Device token.
pushGateway * Type: String Default: n/a	Accepted values: apns, apns2, gcm.
environment Type: String Default: development	APNs environment. Required if pushGateway is apns2.
topic Type: String Default: n/a	APNs topic (bundle identifier). Required if pushGateway is apns2.
callback Type: Function Default: n/a	Callback on success or error.

Sample code

List channels for device

import PubNubVue from 'pubnub-vue';

const pubnub = PubNubVue.getInstance();

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

show all 21 lines

Response

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

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

Remove a device from push notifications channels

note

Requires Mobile Push Notifications add-on

Enable Mobile Push Notifications for your key in the Admin Portal. See how to enable add-on features.

Disable mobile push notifications on a set of channels.

Method(s)

Use the following method(s) in the Vue SDK:

pubnub.push.removeChannels({Array channels, String device, String pushGateway, String environment, String topic},Function callback)

* required

Parameter	Description
channels * Type: Array Default: n/a	Channels to disable for push notifications.
device * Type: String Default: n/a	Device token.
pushGateway * Type: String Default: n/a	Accepted values: apns, apns2, gcm.
environment Type: String Default: development	APNs environment. Required if pushGateway is apns2.
topic Type: String Default: n/a	APNs topic (bundle identifier). Required if pushGateway is apns2.
callback Type: Function Default: n/a	Callback on success or error.

Sample code

Remove device from channel

import PubNubVue from 'pubnub-vue';

const pubnub = PubNubVue.getInstance();

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

show all 18 lines

Response

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

Remove a device from all push notifications channels

note

Requires Mobile Push Notifications add-on

Enable Mobile Push Notifications for your key in the Admin Portal. See how to enable add-on features.

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

Method(s)

Use the following method(s) in the Vue SDK:

pubnub.push.deleteDevice({String device, String pushGateway, String environment, String topic},Function callback)

* required

Parameter	Description
device * Type: String Default: n/a	Device token.
pushGateway * Type: String Default: n/a	Accepted values: apns, apns2, gcm.
environment Type: String Default: development	APNs environment. Required if pushGateway is apns2.
topic Type: String Default: n/a	APNs topic (bundle identifier). Required if pushGateway is apns2.
callback Type: Function Default: n/a	Callback on success or error.

Sample code

Remove all mobile push notifications

import PubNubVue from 'pubnub-vue';

const pubnub = PubNubVue.getInstance();

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

show all 17 lines

Response

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