ZPNs release notes

Version 2.6.0

Release Date: November 23, 2023

Warning

Upgrade guide for version 2.6.0, please read before upgrading >> >>

New Features

Feature	Description	Related APIs
Custom Notification Icon	In addition to displaying the app's default icon in offline push notifications, you can now customize the notification icon for offline pushes with ZPNs. This can be used to display the sender's avatar in push notifications for one-on-one or group messages. For more details, please refer to Custom notification icon.	-
Notification with Image	Supports including an image in offline push notifications. For more details, please refer to Notify with photo attachment.	ZIMPushConfig > resourceID Push message to all users
Update App Icon Badge	Supports updating the app icon badge to remind users of unread messages when they are offline. For more details, please refer to Modify a notification badge.	setServerBadge ZIMPushConfig > enableBadge ZIMPushConfig > badgeIncrement
Replace Notification	Supports replacing the content of a previously sent push notification. For more details, please refer to Update a push notification.	-

New Features

Feature	Description	Related APIs
Improved iOS VoIP development experience	To facilitate Flutter developers in implementing VoIP functionality, ZEGO has encapsulated some functions of iOS CallKit and PushKit libraries into a separate plugin called zego_callkit. For more details, please refer to the CallKit User Guide.	-

Version 2.5.0

Release Date: September 15, 2023

New Features

Feature	Description	Related APIs
Web Development	Support developing web applications using the Flutter framework, and implement offline push. For more details, please refer to Implement Push Notification (Web).	-
Local Logs	Add ZPNs local log component, call uploadLog of ZIM SDK to upload logs of both ZIM and ZPNs simultaneously.	uploadLog
Unregister Push	Support unregistering offline push and disabling push notifications.	unregisterPush
iOS Push Display Settings	registerPush adds parameter ZPNsIOSNotificationArrivedConfig, which allows specifying whether to display iOS push alerts, sounds, and badges when registering for offline push.	ZPNsIOSNotificationArrivedConfig
Push Private Messages to Android Devices	ZIMPushConfig > resourcesID

Improvements

Feature	Description	Related APIs
Automatic Detection of iOS Environment	ZPNsIOSEnvironment enum adds `Automatic`. When developers call registerPush to register for offline push and are not familiar with the iOS environment, they can pass this enum and ZPNs will automatically detect the environment.	ZPNsIOSEnvironment > Automatic
Initiate iOS Callkit Call Interface	Add `reportIncomingCall` interface to support initiating the iOS Callkit call interface.	`reportIncomingCall`

API Changes

Feature	Description	Related APIs
Data Class Member Variable Type Change	The type of `extras` in ZPNsMessage changes from `Map<String, Object>` to `Map<String, Object?>` to accommodate cases where the value of the Map field may be null when converting from JSON to Map. For more details, please refer to ZPNs upgrade guide.	ZPNsMessage > extras

Version 2.3.2

Release Date: 2023-04-21

Interface Changes

Feature	Description	Related Interfaces
Interface Change	The callback method `performSetMutedCallAction` in `CallKitEventHandler` has been changed to `performSetMutedCallAction`	`performSetMutedCallAction`

Bug Fixes

Fixed known issues.

Version 2.3.1

Release Date: 2023-03-29

Interface Changes

Feature	Description	Related Interfaces
Interface Change	Added `setBackgroundMessageHandler` interface for setting the callback triggered by Android silent push. Renamed `didReceiveIncomingPushWithPayload` method to `didReceiveIncomingPush`, with parameters changed from `payload` and `completion` to `extras` and `uuid`.	setBackgroundMessageHandler `didReceiveIncomingPush`

Bug Fixes

Fixed known issues.

Version 2.3.0

Release Date: 2023-03-14

New Features

Feature	Description	Related Interfaces
Support iOS VoIP Push	Support VoIP notification functionality through iOS CallKit.	-
Encapsulate iOS CallKit System API	Encapsulate iOS CallKit for easier cross-platform usage.	-
Support Silent Push	Support synchronizing data between the background-running app and the server through silent push.	-
Encapsulate Android Local Notification API	Flutter's local notification interface now supports Android platform.	addLocalNotification

Interface Changes

Feature	Description	Related Interfaces
Interface Change	Based on the requirements for implementing silent push on iOS, the onThroughMessageReceived callback method has added a parameter `iOSOnThroughMessageReceiveCompletion`, so that when the operations triggered by onThroughMessageReceived are completed, `iOSOnThroughMessageReceiveCompletion()` can be called to notify the iOS system that the relevant operations have been completed.	onThroughMessageReceived

Version 2.2.0

Release Date: 2023-01-11

New Features

Feature	Description	Related API
Encapsulate Android channel creation	For custom ringtones on Android 8.0 and above, a channel needs to be created. Flutter has simplified this API for easy use by customers.	createNotificationChannel
Encapsulate iOS local notification sending	Simplify the iOS local notification sending function for easy use by developers.	addLocalNotification

Improvements

Feature	Description	Related API
Changes to APIs	Differentiate between static functions and member functions. Removed meaningless asynchronous return values. enableDebug is no longer aligned with both iOS and Android platforms, only available on Android. registerPush added optional named parameter ZPNsIOSEnvironment. If running in iOS environment and this parameter is not filled, ZPNs SDK will throw an exception. In ZPNsEventHandler, the extendedData string in ZPNsMessage has been changed to an extra dictionary to resolve potential review issues on the Google Play Store.	-

Version 2.1.3

Release Date: 2022-09-01

Improvements

Feature	Description	Related API
Android version compatibility	Compatible with Android 12.	-

Version 2.1.2

Release Date: 2022-08-31

Bug Fixes

Fixed an error related to Android dependencies.

Version 2.1.1

Release Date: 2022-08-28

Bug Fixes

Fixed known issues.

Version 2.1.0

Release Date: 2022-07-28

ZPNs SDK is first released .To use it, please use it with ZIM SDK.

Feature	Description	Related API
Register for offline push	Register for offline push notifications from vendors. Please configure the vendor information before using.	setPushConfig registerPush
Receive vendor notification click callback	Vendor-specific notification click callbacks are unified and thrown in the related APIs.	onNotificationClicked
Receive vendor notification display callback	Vendor-specific notification display callbacks are thrown in this interface.	onNotificationArrived