Send Notifications to Mobile AppsAdmin Scope

The Catalyst CloudScale Push Notifications component enables you to send notifications to mobile applications built on the Android or iOS platforms.

Catalyst enables you to send push notifications to 50 users in a single function call. You can send push notifications to a specific target user by using their Catalyst user IDs or email address. You can include alerts, updates, or promotional content for the user to engage with your application.

To set up push notifications for your mobile application, you must meet the following prerequisites:

1. You must register your mobile application with Catalyst and note down the Application ID (appId) from the console after configuring. You can opt to register your application installed in the target device either using individual platform-specific Catalyst mobile SDK methods (available in Android and iOS) or using the Flutter SDK.
   
   The appId can be fetched by configuring Android Push Notifications service directly in the Catalyst console.

2. The mobile application must use the Catalyst Authentication component.

3. Once step 1 and 2 are completed, the Catalyst user must be logged in on their device to receive the notification promptly.

Once the prerequisites are complete, you can send notifications by calling the JavaScript SDK method below, using your generated Application ID to target the specific app.

Get Mobile Notification Instance

You can create a mobile notification instance and use it to refer to a specific mobile app registered in the Catalyst console. This is done by fetching the mobile notification instance with the pushNotification().mobile() method, by passing the generated appID as a parameter.

We will use this mobile notification instance to perform additional operations with the Node.js SDK methods, such as sending push notifications, which will be covered in the next section.

const notification = new pushNotification().mobile("1234567890");

Here, 1234567890 is the appID. Alternatively, if your application involves Catalyst scope-based access, you can pass the ZCProject project parameter along with the appID.

const notification = new pushNotification().mobile("1234567890", project);

Send Android Push Notifications

After you have registered your Android application with Catalyst for sending push notifications, you can use the sendAndroidNotification() method to send push notifications to your application.

Parameters Used

You can use the below code snippet to call the sendAndroidNotification() method in your application:

notification.sendAndroidNotification({
 message: 'This message is to test if the functionality is working fine!',
 badge_count: 1
}, 'emma.b@zylker.com');

Send iOS Push Notifications

After you have registered your iOS application with Catalyst for sending push notifications, you can use the sendIOSNotification() method to send push notifications to your application.

Parameters Used

You need to pass the required parameters to the sendIOSNotification() method in the following manner:

MobileNotification.sendIOSNotification(notifyObj: ICatalystPushDetails, recipient: string): Promise

You can use the below code snippet to call the sendIOSNotification() method in your application:

notification.sendIOSNotification({
 message: 'This message is to test if the functionality is working fine!',
 badge_count: 1
}, 'emma@zylker.com');