-
Notifications
You must be signed in to change notification settings - Fork 58
Push Notifications
Android must use Firebase Cloud Messaging.
Apple have two systems regarding push notifications. The most recent is a p8 file with a token. The older one was a p12 certificate that has to be renewed each year, so it was a hazzle. For newer apps a p8 file is recommended.
Also these guides are useful
-
apn push <device token> -m <the content for the notification> -c <path of the APNS certificate> -
apn push <device token> -m <the content for the notification> -c <path of the APNS certificate> -e production
This tool can help with testing notifications for iOS and Android.
Jasonette cames with a push notification wrapper. It easy to integrate push notifications in your iOS app.
The "PUSH" constant is defined in Constants.h (iOS only)
By default PUSH is disabled. To turn it on, go to Constants.h and uncomment the #define statement, and then go to the capabilities tab and switch the push notification feature on.
-
$push.registeraction ⇒ Registers this device to Apple for push notification -
Then Apple server returns a device token ⇒ this triggers “$push.onregister” event with
$jason.tokenset as the newly assigned device token -
You need to store this token somewhere so you can use it later. In the following example we send it to our server. It will probably store the token under current user’s database entry, so other users can send push notifications to this device through this user’s device token.
-
When sending a push notification, you make a POST request to APN/GCM server with metadata such as the destination token, message to display, and a JSON payload. The APN/GCM servers then sends push notifications to each device based on the device token.
-
For the payload you should either pass a JASON action or href object. This will be used later when the receiver device handles the push notification.
-
The sending can be done both from the client side and the server side (normally we use the server because that way we can keep a centralized database of all users' device tokens. Otherwise each device should have complete knowledge of all other users it wants to send push to).
When a user receives a push notification, the device could be either in the backgroud or foreground
-
In case the app is in the background
-
it just displays the push notification on the lock screen.
-
when you open the notification from the lock screen, the "href" or "action" payload attached to the push notification gets executed. This way you can customize the behavior whichever way you want.
-
-
In case the app is in the foreground
-
it triggers “$push.onmessage” event on the current view
-
if the current view doesn’t have a “$push.onmessage” event defined under $jason.head.actions, nothing happens.
-
if the current view has a "$push.onmessage" event defined, the payload object gets passed in as “{{$jason}}”. You can utilize this to do whatever you want but in most cases you probably want to use it as is to be consistent with the background behavior mentioned above
-
To register a device token you need to call "$push.register" action.
Then you need to handle the "$push.onregister" event which returns a device_token.
{
"$jason": {
"head": {
"title": "PUSH TEST",
"actions": {
"$load": {
"type": "$push.register"
},
"$push.onregister": {
"type": "$network.request",
"options": {
"url": "https://myserver.com/register_device.json",
"data": {
"token": "{{$jason.token}}"
}
}
}
}
}
}
}[A] Let’s say, from phase 2, we’re sending the following JSON payload to APNS:
{
"href": {
"url": "https://news.ycombinator.com",
"view": "web"
}
}When you open the notification, Jasonette would automatically detect the "href" object and run the href, resulting in a new browser that opens the link “https://news.ycombinator.com”;.
[B] You can also include an “action” attribute to trigger an action instead of an “href”:
{
"action": {
"type": "$util.banner",
"options": {
"title": "Hello",
"description": "World"
}
}
}When you open the notification, Jasonette will automatically detect the "action" object and run the action, displaying a banner.
To handle push notifications when the app is in the foreground, you need to define a “$push.onmessage” event handler to the current view. Note that each view has its own “$push.onmessage” handler and can behave in their own ways. For example in a chat app, if you’re in a chatroom, new chat messages should be appended, but if you’re in the lobby where it displays a list of chatrooms, it should just display a "new" badge to the chatroom item which just received the new message.
[A] Default payload handling
Let’s say, from phase 2, we’re sending the following JSON payload to APNS:
{
"action": {
"type": "$util.banner",
"options": {
"title": "Hello",
"description": "World"
}
}
}You will need to define the “$push.onmessage” handler in the view:
{
"$jason": {
"head": {
"title": "PUSH TEST",
"actions": {
"$push.onmessage": "{{$jason.action}}"
}
}
}
}This will run the "action" object from the push payload.
[B] Using custom payload
You don’t need to use the "action" or "href" attributes, you can simply pass some custom attribute as a payload from the server:
{
"href": {
"url": "https://news.ycombinator.com",
"view": "web"
},
"some_custom_attribute": {
"text": "Hello world"
}
}And in your view you can access the "custom" attribute simply by accessing “{{$jason.custom}}”
{
"$jason": {
"head": {
"title": "PUSH TEST",
"actions": {
"$push.onmessage": {
"type": "$util.toast",
"options": {
"text": "{{$jason.some_custom_attribute.text}}"
}
}
}
}
}
}You can forge a special json object to trigger Jasonette actions from the notification. You can use href or action. Note: Firebase need that data properties are only string. So we have to use JSON.stringify. in iOS you can get the FCM Token by using the Firebase Extension
const message = {
notification: {
title: 'My Notification Title',
body: 'My message',
},
token, // FCM token from Firebase SDK
data: {
action: JSON.stringify({
type: "$global.set",
options: {
notifyurl: 'http://special_url'
},
success: {
type: "$href",
options: {
view: "jason",
transition: "push",
fresh:true,
url: "file://browser.json"
}
}
})
}
};
// Send a message to the device corresponding to the provided
// registration token.
// https://firebase.google.com/docs/cloud-messaging/send-message#send_messages_to_specific_devices
return firebase
.messaging()
.send(message)
.then((response) => {
// Message Sent
})
.catch((error) => {
// Message Error
});- Telegram: https://t.me/jasonelle
- Website: https://jasonelle.com
- Additional: https://jasonelle-archive.github.io/docs/legacy/