https://github.com/HazemKhaled/TiPushNotification
CommonJS module to handle push notifications for both iOS and Android into Appcelerator Titanium apps
https://github.com/HazemKhaled/TiPushNotification
appcelerator gcm titanium
Last synced: 5 months ago
JSON representation
CommonJS module to handle push notifications for both iOS and Android into Appcelerator Titanium apps
- Host: GitHub
- URL: https://github.com/HazemKhaled/TiPushNotification
- Owner: HazemKhaled
- License: mit
- Created: 2015-09-29T21:54:23.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-09-18T15:49:12.000Z (about 9 years ago)
- Last Synced: 2024-11-15T18:34:45.880Z (11 months ago)
- Topics: appcelerator, gcm, titanium
- Language: JavaScript
- Size: 28.3 KB
- Stars: 41
- Watchers: 10
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TiPushNotification
Yes you can use it with your self-hosted server or any other cloud services like Parse.com or Appcelerator cloud.
## Get it [](http://gitt.io/component/ti-push-notification)
Download the latest distribution [ZIP-file](https://github.com/HazemKhaled/TiPushNotification/releases) with latest [Android GCM module](https://github.com/morinel/gcmpush) and consult the [Titanium Documentation](http://docs.appcelerator.com/titanium/latest/#!/guide/Using_a_Module) on how install it, or simply use the [gitTio CLI](http://gitt.io/cli):
`$ gittio install ti-push-notification`
## How to
Titanium has APIs for iOS push notifications, but unfortunately you need module to for Android.
1. Install this CommonJS module
_Note: [Android GCM module](https://github.com/morinel/gcmpush) will be installed automaticly_
`$ gittio install ti-push-notification`
2. Add this code into your app.js or alloy.js
```javascript
if (Ti.Platform.name === 'android') {
// set android-only options
var pnOptions = {
senderId: 'XXXXXXXX', // It's the same as your project id
notificationSettings: {
sound: 'mysound.mp3', // Place soudn file in platform/android/res/raw/mysound.mp3
smallIcon: 'appicon.png', // Place icon in platform/android/res/drawable/notification_icon.png
largeIcon: 'appicon.png', // Same
vibrate: true, // Whether the phone should vibrate
insistent: true, // Whether the notification should be insistent
group: 'News', // Name of group to group similar notifications together
localOnly: false, // Whether this notification should be bridged to other devices
priority: 2 // Notification priority, from -2 to 2
}
};
} else if (Ti.Platform.name === 'iPhone OS') { // set ios-only options.
// Sets interactive notifications as well if iOS8 and above. Interactive notifications is optional.
if (parseInt(Ti.Platform.version.split(".")[0], 10) >= 8) {
var thumbUpAction = Ti.App.iOS.createUserNotificationAction({
identifier: "THUMBUP_IDENTIFIER",
title: "Agree",
activationMode: Ti.App.iOS.USER_NOTIFICATION_ACTIVATION_MODE_BACKGROUND,
destructive: false,
authenticationRequired: false
});
var thumbDownAction = Ti.App.iOS.createUserNotificationAction({
identifier: "THUMBDOWN_IDENTIFIER",
title: "Disagree",
activationMode: Ti.App.iOS.USER_NOTIFICATION_ACTIVATION_MODE_BACKGROUND,
destructive: false,
authenticationRequired: false
});
var thumbUpDownCategory = Ti.App.iOS.createUserNotificationCategory({
identifier: "THUMBUPDOWN_CATEGORY",
// The following actions will be displayed for an alert dialog
actionsForDefaultContext: [thumbUpAction, thumbDownAction],
// The following actions will be displayed for all other notifications
actionsForMinimalContext: [thumbUpAction, thumbDownAction]
});
var pnOptions = {
types: [Ti.App.iOS.USER_NOTIFICATION_TYPE_ALERT, Ti.App.iOS.USER_NOTIFICATION_TYPE_SOUND],
categories: [thumbUpDownCategory]
};
} else { //No support for interactive notifications, omit categories
var pnOptions = {
types: [Ti.App.iOS.USER_NOTIFICATION_TYPE_ALERT, Ti.App.iOS.USER_NOTIFICATION_TYPE_SOUND]
};
}
}
// set cross-platform event
var onReceive = function(event) {
// Your code here
};
// Create instance with base url
var tiPush = require('ti-push-notification').init({
backendUrl: "http://domain.tld/register.php"
});
// register this device
tiPush.registerDevice({
pnOptions: pnOptions,
onReceive: onReceive,
extraOptions: {
something: "a",
key2: true,
user_id: 1234,
whatever: "youwant"
}
});
```
### Contributions
Your issues and pull requests are most welcome, also you can pick a task from [TODOs](#todos).
### TODOs
1. Server-side snippets for PHP and NodeJS
2. Parse.com example
3. Wordpress self-hosted example
4. APN Server API setup tutorial
5. GCM Server API setup tutorial
6. Add option to depend on [CaffeinaLab GCM](https://github.com/CaffeinaLab/GCM) or [Jeroen GCM](https://github.com/morinel/gcmpush) module.
### Changelog
**v0.1.3**
Add `extraOptions` parameter to be uploaded to backend too
**v0.1.2**
Implementation changed, no need for factory, use init function directly Now module Titaniumified
**v0.1.0**
Initialed base of [ACS Push Notifications](https://github.com/ricardoalcocer/acspushmod)
### Credits
This module is based on [ACS Push Notifications](https://github.com/ricardoalcocer/acspushmod) CommonJS module by my Ricardo Alcocer.
## License
Original code written in my full-time @ [Rize Inno](https://github.com/RizeInno), code open source by Rize Innovations, FZO under MIT license.