JavaScriptTitaniumTitaniumNode.jsPhoneGapReactReduxVueWebTitanium V4 Mobile Push API Reference for Realtime AppsNode.js V4 Mobile Push API Reference for Realtime AppsPhoneGap V4 Mobile Push API Reference for Realtime AppsVue V4 Mobile Push API Reference for Realtime AppsJavaScript V4 Mobile Push API Reference for Realtime Apps

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

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

Learn more about our Mobile Push Gateway here.

Adding Device to Channel

Description

Method(s)

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

   Parameter	Type	Required	Defaults	Description
   Operation Arguments	Hash	Yes		A hash of arguments.
   channels	Array	Yes		Specifies channel to associate with push notifications.
   device	String	Yes		The device id to associate with push notifications.
   pushGateway	String	Yes		apns, apns2 or gcm.
   environment	String	Optional	development	Environment within which device should manage list of channels with enabled notifications (works only if pushGateway set to apns2).
   topic	String	Optional		Notifications topic name (usually it is bundle identifier of applicationfor Apple platform). Required only if pushGateway set to apns2.
   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
}

Listing Channels For Device

Description

Method(s)

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

   Parameter	Type	Required	Defaults	Description
   Operation Arguments	Hash	Yes		A hash of arguments.
   device	String	Yes		The device id to associate with push notifications.
   pushGateway	String	Yes		apns, apns2 or gcm.
   environment	String	Optional	development	Environment within which device should manage list of channels with enabled notifications (works only if pushGateway set to apns2).
   topic	String	Optional		Notifications topic name (usually it is bundle identifier of applicationfor Apple platform). Required only if pushGateway set to apns2.
   callback	Function	Optional		Executes on a successful/unsuccessful listChannels.

Basic Usage

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

Response

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

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

Removing Device From Channel

Description

Method(s)

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

   Parameter	Type	Required	Defaults	Description
   Operation Arguments	Hash	Yes		A hash of arguments.
   channels	Array	Yes		Specifies channel to associate with push notifications.
   device	String	Yes		The device id to associate with push notifications.
   pushGateway	String	Yes		apns, apns2 or gcm.
   environment	String	Optional	development	Environment within which device should manage list of channels with enabled notifications (works only if pushGateway set to apns2).
   topic	String	Optional		Notifications topic name (usually it is bundle identifier of applicationfor Apple platform). Required only if pushGateway set to apns2.
   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 push notifications

Description

Method(s)

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

   Parameter	Type	Required	Defaults	Description
   Operation Arguments	Hash	Yes		A hash of arguments.
   device	String	Yes		The device id to associate with push notifications.
   pushGateway	String	Yes		apns, apns2 or gcm.
   environment	String	Optional	development	Environment within which device should manage list of channels with enabled notifications (works only if pushGateway set to apns2).
   topic	String	Optional		Notifications topic name (usually it is bundle identifier of applicationfor Apple platform). Required only if pushGateway set to apns2.
   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
}