AngularJS 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 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.
Adding Device to Channel
Requires Mobile Push Notifications add-on Requires that you enable the Mobile Push Notifications for your key. Refer to the following page for details on enabling add-on features on your keys:
https://support.pubnub.com/hc/en-us/articles/360051974791-How-do-I-enable-add-on-features-for-my-keys-
Description
Enable 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 V4 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 push notifications.device
String Yes The device
ID to associate with push notifications.pushGateway
String Yes apns
orgcm
.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
Requires Mobile Push Notifications add-on Requires that you enable the Mobile Push Notifications for your key. Refer to the following page for details on enabling add-on features on your keys:
https://support.pubnub.com/hc/en-us/articles/360051974791-How-do-I-enable-add-on-features-for-my-keys-
Description
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 V4 SDK:
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 push notifications.pushGateway
String Yes apns
orgcm
.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
Requires Mobile Push Notifications add-on Requires that you enable the Mobile Push Notifications for your key. Refer to the following page for details on enabling add-on features on your keys:
https://support.pubnub.com/hc/en-us/articles/360051974791-How-do-I-enable-add-on-features-for-my-keys-
Description
Disable 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 V4 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 push notifications.device
String Yes The device
ID to associate with push notifications.pushGateway
String Yes apns
orgcm
.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
Requires Mobile Push Notifications add-on Requires that you enable the Mobile Push Notifications for your key. Refer to the following page for details on enabling add-on features on your keys:
https://support.pubnub.com/hc/en-us/articles/360051974791-How-do-I-enable-add-on-features-for-my-keys-
Description
Disable push notifications from all channels registered with the specified pushToken.
Method(s)
To run Remove all push notifications
you can use the following method(s) in the AngularJS V4 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 push notifications.pushGateway
String Yes apns
orgcm
.callback
Function Optional Executes on a successful/unsuccessful deleteDevice
.
Basic Usage
Remove all push notifications:
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
}