Repository navigation
APNS FORMAT
pvicente edited this page Sep 25, 2013
·
7 revisions
##Apple Push Notifications
One task of KatooServer is to send notification to mobile devices when they are in background.
A push notification is a JSON document in apple binary format
Here there is a reference to apple developer docs.
All push notifications have a common fields like:
- alert
- badge
- sound
- custom
In custom we can set extra notification parameters with functional purposes in application
###Chat Message Format
| Parameters** | |
|---|---|
| alert | String: chat message with the following "{favorite_emoji or ''}{Contact Name (max 2 words)}:{message}" |
| badge | Integer: an application count about notifications not read |
| sound | String: favorite sound or normal sound |
| custom | Dict: jid: user identifier (ex: jj@gmail.com) |
###Application User Event
| Parameters** | |
|---|---|
| alert | String: message with the following "{favorite_emoji or ''}{Contact Name (max 2 words)}:{application user event}" |
| badge | Integer: an application count about notifications not read |
| sound | String: favorite sound or normal sound |
| custom | Dict: jid: user identifier (ex: jj@gmail.com), ignore: true or false (if app can ignore it in foreground), type: type message string |
**{} encloses string format