OneSignal / onesignal-dotnet-api

Other
13 stars 11 forks source link

Fixed Notification class description #35

Closed michelebastione closed 7 months ago

michelebastione commented 1 year ago

Description

One Line Summary

Changed the "data" parameter's platform descriptor in the Notification models from "Huawei" to "All".

Details

Motivation

I have been working on a multi-platform application implementing push notifications using the onesignal-dotnet-api. Needing to send additional information along with the notification, I was confused as the description of the "data" parameter in the Notification class, meant for this purpose, stated "Platform Huawei". I decided to try it out and it worked flawlessly both on Android and iOS, so I assumed it must have been a typo of sorts. I changed it to "All" for the Notification, NotificationWithMeta, BasicNotification and BasicNotificationAllOf classes, and relative docs. I also decided to rename it to additionalData, to match the name of the respective parameter in the OneSignal-DotNet-SDK's Notification model.

Scope

As this was a description fix involving only a parameter rename no effective change is expected to take place. That's the reason I opted to do a pull request rather than opening a new issue. Being fairly new to open source projects, I hope it was the right call to make.

Testing

Manual testing

I tested the changes on my project a few times and no problem arised on the server side (.NET MAUI Blazor Hybrid) nor on the client side (Android + iOS).

Checklist

Overview

Testing

Final pass