onesignal-api-ext
Mobile icon

OneSignal API Ext

Stable version 1.1.9 (Compatible with OutSystems 11)
Uploaded
 on 24 May (12 days ago)
 by 
5.0
 (2 ratings)
onesignal-api-ext

OneSignal API Ext

Details
Designed to extend SendPushNotification API feature which is missing in original OneSignal Plugin, like Headings, Android Background Image, Android Channel (sounds etc), Android Accent Color.
Read more

Designed to extend part of OneSignalAPI module of the official OneSignal Plugin.

Extended Features:

  • GetPlayerId - Get the Player Id for the current app/device.
  • GetPushNotificationStatus - Retrieve notification status to get status for a single NotificationId
  • Sending returns the new NotificiationId for tracking.
  • Headings addition in Notification.
  • Name - Serves as an internal identifier to help organize your notification campaigns.
  • TTL - The "Time To Live" (TTL) defines the duration in seconds for which a notification remains valid if the device is offline, ensuring that outdated notifications aren't delivered if the device reconnects after some time.
  • Colapse_Id - Prevent duplicate notifications by merging notifications with the same identifier into a single one.
  • Android Background Image (cannot use with action buttons and big picture; small icon and large icon is not displayed, must be baked into background image itself)

          https://documentation.onesignal.com/docs/android-customizations

  • Android Channel Id: can be used to set sound on Android push notification etc. (read more in documentation) and Notification LED colour.
  • Android Accent Color: to gave accent colour in Action Buttons and also small_icon (if alpha channel exists)
  • More to come if we had time (if you want to help, please apply for Team)


Original author mostly only extend Android functionality because they only had an Android device.


Limitation:

Original SendPushNotificationToUserid cannot be extended since it read private entity inside original OneSignalAPI.

So we change the method by using OneSignal's external user id feature to implement SendPushNotificationToUserid.


How to use:

1. Uncheck dependencies from original OneSignalAPI (All PushNotifications folder)


2. Add dependency from OneSignalAPI_Ext


3. Do the usual OneSignal Plugin configuration

4. Call SetExternalUserId client action after calling RegisterWithUser, it will set external user id in OneSignal

Set AsyncRegistration = false in RegisterWithUser, to make sure registration already finished before calling SetExternalUserId

5. Call RemoveExternalUserId client action on Logout, before calling OneSignal Plugin's Unregister

6. Use SendPushNotificationToUserid or other methods.

Release notes (1.1.9)

Bug fix only for GetPushNotificationStatus to bypass the JSON conversions in OnBeforeRequest.

License (1.1.9)
Reviews (2)
by 
22 May (14 days ago)
in version 1.1.7
thanks useful component.
by 
2022-04-14
in version 1.0.1
Very good plugin, interesting functionality.
Team
Other assets in this category