Installation<\/h2>\n
For Ionic:<\/p>\n
For Cordova:<\/p>\n Please see the Ionic demo for the exact usage example.<\/p>\n Clone this repo:<\/p>\n CD into the cloned project and the Ionic demo project:<\/p>\n Install the dependencies:<\/p>\n Install the platform and plugins (please note that this process may take a while to complete):<\/p>\n Add the plugin (either one of three options would work):<\/p>\n or<\/p>\n or like this:<\/p>\n Prepare the project:<\/p>\n Open the project in XCode by going into If you don’t have an AppID and VoIP push certificate created in your Apple developer account<\/a>, you can do so by following my instructions from the How to create a native iOS app that can receive VoIP push notifications<\/a> tutorial.<\/p>\n Take your time to do that an then come back, I’ll wait.<\/em><\/p>\n To use the VoIP push in the app, you need to turn ON the Make sure you select the following options:<\/p>\n Next, you need to add PushKit framework to your project:<\/p>\n Also (yeah, I know, a lot of setup<\/em>), you need to make sure that you set the appropriate Bundle Identifier. You should have read about this in the tutorial<\/a> I linked above.<\/em><\/p>\n After you run the project, in the XCode console you should see<\/p>\n and on your device:<\/p>\n You can send VoIP pushes to yourself by editing the \n Disclaimer: Also, I don’t ‘do’ ObjectiveC for a living (but I may change my mind after completing this :)), so I would really appreciate the constructive feedback in making this plugin better, so I look forward to your comments and potential pull requests!\n<\/p><\/blockquote>\n In my previous tutorial<\/a> I showed how to create a native iOS app with Swift (ObjectiveC code also available) that can receive VoIP push notifications sent with Houston, custom PHP script or through Amazon SNS.<\/p>\n In this tutorial I’m going to present to you the Cordova plugin that does the same thing; it allows hybrid iOS applications to receive the VoIP push notifications.<\/p>\n I won’t go into the details of Cordova plugin building in this document. If you’re new to building Cordova plugins, you can check out this tutorial<\/a> and official docs<\/a>, as they were indispensable in my quest to learn as much as possible about it.<\/p>\n In this file you basically define:<\/p>\n This file, stripped of it’s comments is very short (75 LOC):<\/p>\n This code follows the structure of the phonegap-plugin-push<\/a> push.js.<\/p>\n Once you call the Since we’re writing in ObjectiveC, we need to define the functions in the .h file. Here we do few things:<\/p>\n In the implementation file we define our functions. The first one is Then, to satisfy that, we implement two functions: The first one is triggered with the device token, which we then send back to the ‘JS world’. We listen for this in our Ionic\/Cordova apps and send this information to our backend so that later when we’re going to send the push we know to which device id.<\/p>\n The second one is triggered when we receive the actual VoIP push notification. In this example, we take out the message ( Again, I have to stress here that you may wanna alter this to your liking and process even more data which you receive through the VoIP push notification.<\/p>\n I hope this plugin will come handy to you. Also, I hope that this will give you enough information so that you’ll be dangerous enough to go and fiddle with the code yourself.<\/p>\n As I’ve mentioned before, I would really appreciate the constructive feedback so that we can make this plugin better, so I look forward to your comments and optional pull requests.<\/p>\n Btw, I updated these posts with this solution:<\/p>\n and I have also asked the main maintainer of phonegap-plugin-push plugin<\/a> if this would make sense to put as a PR on that plugin.<\/p>\n I will update you on the progress of all this, and till then – code on!<\/p>\n #Cordova<\/a> plugin for #VoIP<\/a> push notifications https:\/\/t.co\/jkn56YWGTU<\/a><\/p>\n — Nikola Bre\u017enjak (@HitmanHR) September 30, 2016<\/a><\/p><\/blockquote>\nionic plugin add cordova-ios-voip-push<\/code><\/p>\ncordova plugin add cordova-ios-voip-push<\/code><\/p>\nUsage<\/h2>\n
var push = VoIPPushNotification.init();\n\npush.on('registration', function(data) {\n log(\"[Ionic] registration callback called\");\n log(data);\n\n \/\/data.deviceToken;\n \/\/do something with the device token (probably save it to your backend service)\n});\n\npush.on('notification', function(data) {\n log(\"[Ionic] notification callback called\");\n log(data);\n\n \/\/ do something based on received data\n});\n\npush.on('error', function(e) {\n log(e);\n});\n<\/code><\/pre>\nRunning the demo<\/h2>\n
Ionic setup<\/h3>\n
git clone https:\/\/github.com\/Hitman666\/cordova-ios-voip-push.git<\/code><\/p>\ncd cordova-ios-voip-push && cd ionicDemo<\/code><\/p>\nnpm install && bower install<\/code><\/p>\nionic state reset<\/code><\/p>\nionic plugin add cordova-ios-voip-push<\/code><\/p>\nionic plugin add ..\/thePlugin\/VoIPPushNotification<\/code><\/p>\nionic plugin add https:\/\/github.com\/Hitman666\/cordova-ios-voip-push.git<\/code><\/p>\nionic prepare ios<\/code><\/p>\nplatforms\/ios<\/code> and opening up the pluginTest.xcodeproj<\/code> file.<\/p>\nXCode setup<\/h3>\n
Background Modes<\/code> for your app and check few of the checkboxes:<\/p>\n![\"\"](\"http:\/\/i.imgur.com\/U8Xcrlj.png\")
<\/p>\n\n
![\"\"](\"http:\/\/i.imgur.com\/NdLMkC4.png\")
<\/p>\n![\"\"](\"http:\/\/i.imgur.com\/7NRFrUql.png\")
<\/p>\n![\"\"](\"http:\/\/i.imgur.com\/C25JdgQl.jpg\")
<\/p>\nsimplepush.php<\/code> file (in the pushSendingScript<\/code> folder from the Github repo). Just make sure you add your own device id that you’ll see show up on your phone. You have more options to send VoIP push, two of which you can read in the post<\/a> linked few times above.<\/p>\n!TL;DR<\/h2>\n
\n This tutorial was inspired by the official phonegap-plugin-push plugin<\/a>, and the fact that this kind of VoIP support didn’t exist. There were requests for it here<\/a>, here<\/a> and here<\/a>. As well as on freelance sites like here<\/a>, here<\/a> – hehe, hope these guys will send some donations to my favorite charity if they end up using this now \ud83d\ude09<\/p>\nBuilding Cordova plugins<\/h3>\n
plugin.xml<\/h4>\n
<?xml version='1.0' encoding='utf-8'?>\n<plugin id=\"com.nikola-breznjak.voippush\" version=\"1.0.0\" xmlns=\"http:\/\/apache.org\/cordova\/ns\/plugins\/1.0\" xmlns:android=\"http:\/\/schemas.android.com\/apk\/res\/android\">\n <name>VoIPPushNotification<\/name>\n <js-module name=\"VoIPPushNotification\" src=\"www\/VoIPPushNotification.js\">\n <clobbers target=\"VoIPPushNotification\" \/>\n <\/js-module>\n\n <platform name=\"ios\">\n <config-file target=\"config.xml\" parent=\"\/*\">\n <feature name=\"VoIPPushNotification\">\n <param name=\"ios-package\" value=\"VoIPPushNotification\" \/>\n <\/feature>\n <\/config-file>\n\n <header-file src=\"src\/ios\/VoIPPushNotification.h\" \/>\n <source-file src=\"src\/ios\/VoIPPushNotification.m\" \/>\n <\/platform>\n<\/plugin>\n<\/code><\/pre>\n\n
<platform name=\"ios\"><\/code>)<\/li>\nheader-file<\/code> and source-file<\/code> elements)<\/li>\njs-module<\/code> tag src<\/code> property)<\/li>\n<clobbers target=\"VoIPPushNotification\" \/><\/code>)<\/li>\n<\/ul>\nwww\/VoIPPushNotification.js<\/h4>\n
var exec = cordova.require('cordova\/exec');\n\nvar VoIPPushNotification = function() {\n this._handlers = {\n 'registration': [],\n 'notification': [],\n 'error': []\n };\n\n \/\/ triggered on registration and notification\n var that = this;\n var success = function(result) {\n if (result && result.registration === 'true') {\n that.emit('registration', result);\n }\n else if (result) {\n that.emit('notification', result);\n }\n };\n\n \/\/ triggered on error\n var fail = function(msg) {\n var e = (typeof msg === 'string') ? new Error(msg) : msg;\n that.emit('error', e);\n };\n\n \/\/ wait at least one process tick to allow event subscriptions\n setTimeout(function() {\n exec(success, fail, 'VoIPPushNotification', 'init');\n }, 10);\n};\n\nVoIPPushNotification.prototype.on = function(eventName, callback) {\n if (this._handlers.hasOwnProperty(eventName)) {\n this._handlers[eventName].push(callback);\n }\n};\n\nVoIPPushNotification.prototype.off = function (eventName, handle) {\n if (this._handlers.hasOwnProperty(eventName)) {\n var handleIndex = this._handlers[eventName].indexOf(handle);\n if (handleIndex >= 0) {\n this._handlers[eventName].splice(handleIndex, 1);\n }\n }\n};\n\nVoIPPushNotification.prototype.emit = function() {\n var args = Array.prototype.slice.call(arguments);\n var eventName = args.shift();\n\n if (!this._handlers.hasOwnProperty(eventName)) {\n return false;\n }\n\n for (var i = 0, length = this._handlers[eventName].length; i < length; i++) {\n var callback = this._handlers[eventName][i];\n if (typeof callback === 'function') {\n callback.apply(undefined,args);\n } else {\n console.log('event handler: ' + eventName + ' must be a function');\n }\n }\n\n return true;\n};\n\n\nmodule.exports = {\n init: function(options) {\n return new VoIPPushNotification(options);\n },\n\n VoIPPushNotification: VoIPPushNotification\n};\n<\/code><\/pre>\ninit<\/code> method, you get the new VoIPPushNotification object which then exposes the methods for listening to the registration<\/code>, notification<\/code> and error<\/code> events.<\/p>\nsrc\/ios\/VoIPPushNotification.h<\/h4>\n
#import <Cordova\/CDV.h>\n#import <PushKit\/PushKit.h>\n\n@interface VoIPPushNotification : CDVPlugin <PKPushRegistryDelegate>\n\n@property (nonatomic, copy) NSString *VoIPPushCallbackId;\n- (void)init:(CDVInvokedUrlCommand*)command;\n\n@end\n<\/code><\/pre>\n\n
VoIPPushCallbackId<\/code><\/li>\ninit<\/code> function declaration<\/li>\n<\/ul>\nsrc\/ios\/VoIPPushNotification.m<\/h4>\n
#import \"VoIPPushNotification.h\"\n#import <Cordova\/CDV.h>\n\n@implementation VoIPPushNotification\n\n@synthesize VoIPPushCallbackId;\n\n- (void)init:(CDVInvokedUrlCommand*)command\n{\n self.VoIPPushCallbackId = command.callbackId;\n NSLog(@\"[objC] callbackId: %@\", self.VoIPPushCallbackId);\n\n \/\/http:\/\/stackoverflow.com\/questions\/27245808\/implement-pushkit-and-test-in-development-behavior\/28562124#28562124\n PKPushRegistry *pushRegistry = [[PKPushRegistry alloc] initWithQueue:dispatch_get_main_queue()];\n pushRegistry.delegate = self;\n pushRegistry.desiredPushTypes = [NSSet setWithObject:PKPushTypeVoIP];\n}\n\n- (void)pushRegistry:(PKPushRegistry *)registry didUpdatePushCredentials:(PKPushCredentials *)credentials forType:(NSString *)type{\n if([credentials.token length] == 0) {\n NSLog(@\"[objC] No device token!\");\n return;\n }\n\n \/\/http:\/\/stackoverflow.com\/a\/9372848\/534755\n NSLog(@\"[objC] Device token: %@\", credentials.token);\n const unsigned *tokenBytes = [credentials.token bytes];\n NSString *sToken = [NSString stringWithFormat:@\"%08x%08x%08x%08x%08x%08x%08x%08x\",\n ntohl(tokenBytes[0]), ntohl(tokenBytes[1]), ntohl(tokenBytes[2]),\n ntohl(tokenBytes[3]), ntohl(tokenBytes[4]), ntohl(tokenBytes[5]),\n ntohl(tokenBytes[6]), ntohl(tokenBytes[7])];\n\n NSMutableDictionary* results = [NSMutableDictionary dictionaryWithCapacity:2];\n [results setObject:sToken forKey:@\"deviceToken\"];\n [results setObject:@\"true\" forKey:@\"registration\"];\n\n CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:results];\n [pluginResult setKeepCallback:[NSNumber numberWithBool:YES]]; \/\/[pluginResult setKeepCallbackAsBool:YES];\n [self.commandDelegate sendPluginResult:pluginResult callbackId:self.VoIPPushCallbackId];\n}\n\n- (void)pushRegistry:(PKPushRegistry *)registry didReceiveIncomingPushWithPayload:(PKPushPayload *)payload forType:(NSString *)type\n{\n NSDictionary *payloadDict = payload.dictionaryPayload[@\"aps\"];\n NSLog(@\"[objC] didReceiveIncomingPushWithPayload: %@\", payloadDict);\n\n NSString *message = payloadDict[@\"alert\"];\n NSLog(@\"[objC] received VoIP msg: %@\", message);\n\n NSMutableDictionary* results = [NSMutableDictionary dictionaryWithCapacity:2];\n [results setObject:message forKey:@\"function\"];\n [results setObject:@\"someOtherDataForField\" forKey:@\"someOtherField\"];\n\n CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:results];\n [pluginResult setKeepCallback:[NSNumber numberWithBool:YES]];\n [self.commandDelegate sendPluginResult:pluginResult callbackId:self.VoIPPushCallbackId];\n}\n\n@end\n<\/code><\/pre>\ninit<\/code>, and here we basically register for VoIP push notifications by using PKPushRegistry<\/code>.<\/p>\ndidUpdatePushCredentials<\/code> and didReceiveIncomingPushWithPayload<\/code>.<\/p>\n@alert<\/code>) and return it to the ‘JS world’. In my particular case, this can be a message with a certain keyword, so that then I know what to do in my app based on that keyword.<\/p>\nConclusion<\/h2>\n
\n
\n