Skip to content

Commit 23f346e

Browse files
authored
Updated links, rebranding (coronalabs#46)
Updated OneSignal link to GitHub repo - old one was broken Updated forums link Added link to Discord channel Changed branding to Solar2D Removed <nobr> for notification services' names
1 parent 6dece94 commit 23f346e

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

markdown/guide/events/appNotification/index.markdown

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ To use __push__ notifications, remember the following points:
5353

5454
* If using iOS/Apple, your app cannot send push requests directly to their servers.
5555

56-
* We recommend that you use a <nobr>third-party</nobr> service to send push requests to Apple or Google, who in turn sends them onward to devices. That service can be a company like [OneSignal](https://documentation.onesignal.com/docs/corona-sdk-overview), [PushWoosh](http://www.pushwoosh.com), or [Urban Airship](http://urbanairship.com) that specializes in push notifications.
56+
* We recommend that you use a third-party service to send push requests to Apple or Google, who in turn sends them onward to devices. That service can be a company like [OneSignal](https://github.com/OneSignal/OneSignal-Solar2D-SDK), [PushWoosh](http://www.pushwoosh.com), or [Urban Airship](http://urbanairship.com) that specializes in push notifications.
5757

5858

5959

@@ -101,9 +101,9 @@ local notifications = require( "plugin.notifications.v2" )
101101
<div class="guide-notebox-imp">
102102
<div class="notebox-title-imp">Important</div>
103103

104-
* For Android, all __new__ apps, or existing apps being updated with push notifications for the first time, must use <nobr>[Firebase](https://firebase.google.com/) Cloud Messaging (FCM)</nobr>, supported by the current [Notifications][plugin.notifications-v2] plugin (above). If you have a legacy app already configured for <nobr>Google Cloud Messaging (GCM)</nobr>, it will continue to work indefinitely, but you should continue using the [legacy][plugin.notifications] plugin instead of the current notifications plugin.
104+
* For Android, all __new__ apps, or existing apps being updated with push notifications for the first time, must use [Firebase Cloud Messaging (FCM)](https://firebase.google.com/), supported by the current [Notifications][plugin.notifications-v2] plugin (above). If you have a legacy app already configured for Google Cloud Messaging (GCM), it will continue to work indefinitely, but you should continue using the [legacy][plugin.notifications] plugin instead of the current notifications plugin.
105105

106-
* For iOS, you can either use the <nobr>Apple Push Notification Service (APNS)</nobr> or <nobr>Firebase Cloud Messaging (FCM)</nobr> for push notifications (see&nbsp;below).
106+
* For iOS, you can either use the Apple Push Notification Service (APNS) or Firebase Cloud Messaging (FCM) for push notifications (see&nbsp;below).
107107

108108
</div>
109109

@@ -136,9 +136,9 @@ application =
136136

137137
### Firebase
138138

139-
If you want to use Google <nobr>[Firebase](https://firebase.google.com) Cloud Messaging (FCM)</nobr> for push notifications, follow these additional steps:
139+
If you want to use [Google Firebase Cloud Messaging (FCM)](https://firebase.google.com) for push notifications, follow these additional steps:
140140

141-
1. Copy `GoogleService-Info.plist`, provided in the Firebase console, to your Corona project's root directory alongside `main.lua`.
141+
1. Copy `GoogleService-Info.plist`, provided in the Firebase console, to your project's root directory alongside `main.lua`.
142142

143143
2. Add the following entries to the <nobr>`iphone` &rarr; `plist`</nobr> table of `build.settings`:
144144

@@ -169,7 +169,7 @@ settings =
169169

170170
Android also requires some additional configuration for __push__ notifications:
171171

172-
1. Copy <nobr>`google-services.json`</nobr>, provided in the Firebase console, to your Corona project's root directory alongside `main.lua`.
172+
1. Copy `google-services.json`, provided in the Firebase console, to your project's root directory alongside `main.lua`.
173173

174174
2. Add an additional `useGoogleServicesJson` entry into the `android` table of `build.settings`. When added, the build server will read the settings from the JSON file and integrate them into your app during the build phase.
175175

@@ -191,7 +191,7 @@ settings =
191191

192192
### Android Icons
193193

194-
You can set custom notification icons in a Corona project by adding the following files to the root of the project directory, just like custom application icons. Please see Google's official [documentation](https://developer.android.com/guide/practices/ui_guidelines/icon_design_status_bar.html) for further details.
194+
You can set custom notification icons in a project by adding the following files to the root of the project directory, just like custom application icons. Please see [Google's official documentation](https://developer.android.com/guide/practices/ui_guidelines/icon_design_status_bar.html) for further details.
195195

196196
<div class="inner-table">
197197

@@ -248,7 +248,7 @@ To cancel a local notification before it triggers, use the [notifications.cancel
248248

249249
## Handling Notification Events
250250

251-
In accordance with the Corona event/listener model, if your app is running in either the foreground or background and a notification arrives, you'll receive a [notification][api.event.notification] event. It's your responsibility to initialize the system and set up a listener function to handle these events. Please review the following framework and then read the detailed subsections below.
251+
In accordance with the CORONA_CORE_PRODUCT event/listener model, if your app is running in either the foreground or background and a notification arrives, you'll receive a [notification][api.event.notification] event. It's your responsibility to initialize the system and set up a listener function to handle these events. Please review the following framework and then read the detailed subsections below.
252252

253253
``````lua
254254
local function notificationListener( event )
@@ -345,7 +345,7 @@ On iOS, when you're ready to ask the user for permission to allow __push__ notif
345345
<div class="guide-notebox-imp">
346346
<div class="notebox-title-imp">Important</div>
347347

348-
If you're using Google <nobr>[Firebase](https://firebase.google.com/) Cloud Messaging (FCM)</nobr> for push notifications, you should pass an additional parameter to [notifications.registerForPushNotifications()][plugin.notifications-v2.registerForPushNotifications]. This parameter should be a [table][api.type.Table] containing the `useFCM` key with a value of `true`:
348+
If you're using [Google Firebase Cloud Messaging (FCM)](https://firebase.google.com/) for push notifications, you should pass an additional parameter to [notifications.registerForPushNotifications()][plugin.notifications-v2.registerForPushNotifications]. This parameter should be a [table][api.type.Table] containing the `useFCM` key with a value of `true`:
349349

350350
``````lua
351351
notifications.registerForPushNotifications( { useFCM=true } )
@@ -377,7 +377,7 @@ end
377377
</div>
378378
<div class="docs-tip-inner-right">
379379

380-
The code required to register your device varies depending on the service. Please consult your preferred provider's documentation or seek assistance in the [Corona Forums](https://forums.coronalabs.com/).
380+
The code required to register your device varies depending on the service. Please consult your preferred provider's documentation or seek assistance in the [forums](https://forums.solar2d.com/) or [Discord](https://discord.gg/Abf5V9G).
381381

382382
</div>
383383
</div>

0 commit comments

Comments
 (0)