Skip to content

Commit 32086d7

Browse files
shepherd-lshepherd-l
committed
Update migration guide
1 parent 8a4cb38 commit 32086d7

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

‎MIGRATION_GUIDE_v3_to_v5.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ The user name space is accessible via `OneSignal.Default.User` and provides acce
126126
| ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
127127
| `IPushSubscription PushSubscription` | *The push subscription associated to the current user.* |
128128
| `string Language` | *Set the 2-character language either as a detected language or explicitly set for this user.* |
129-
| `PushSubsription.Changed` <br><br> `delegate void SubscriptionChangedDelegate(IPushSubscriptionState current)` <br><br> `event SubscriptionChangedDelegate Changed` | *Adds a change event that will run whenever the push subscription has been changed.* |
129+
| `PushSubsription.Changed` <br><br> `event EventHandler<PushSubscriptionChangedEventArgs> Changed` <br><br> `PushSubscriptionChangedEventArgs { PushSubscriptionChangedState State }` | *Adds a change event that will run whenever the push subscription has been changed.* |
130130
| `void AddAlias(string label, string id)` | *Set an alias for the current user. If this alias already exists it will be overwritten.* |
131131
| `void AddAliases(Dictionary<string, string> aliases)` | S*et aliases for the current user. If any alias already exists it will be overwritten.* |
132132
| `void RemoveAlias(string label)` | *Remove an alias from the current user.* |
@@ -156,12 +156,12 @@ The notification namespace is accessible via `OneSignal.Default.Notifications` a
156156

157157
| **C#** | **Description** |
158158
| -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
159-
| `bool Permission: Boolean` | *Whether this app has push notification permission.* |
159+
| `bool Permission` | *Whether this app has push notification permission.* |
160160
| `Task<bool> RequestPermissionAsync(bool fallbackToSettings)` | *Prompt the user for permission to push notifications. This will display the native OS prompt to request push notification permission. If the user enables, a push subscription to this device will be automatically added to the user.* |
161161
| `void ClearAllNotifications()` | *Removes all OneSignal notifications.* |
162162
| `event EventHandler<NotificationPermissionChangedEventArgs> PermissionChanged` <br><br> `NotificationPermissionChangedEventArgs { bool Permission }` | *The [PermissionChanged] event will be fired when a notification permission setting changes. This happens when the user enables or disables notifications for your app from the system settings outside of your app.* |
163-
| `event EventHandler<NotificationWillDisplayEventArgs> ForegroundWillDisplay` <br><br> `NotificationWillDisplayEventArgs { Notification Notification }` | *Set an event to fire before displaying a notification while the app is in focus. Use this event to read notification data or decide if the notification should show or not.* |
164-
| `event EventHandler<NotificationClickEventArgs> Clicked` <br><br> `NotificationClickEventArgs { Notification Notification, NotificationClickResult Result }` | *Set an event that will fire whenever a notification is clicked on by the user.* |
163+
| `event EventHandler<NotificationWillDisplayEventArgs> ForegroundWillDisplay` <br><br> `NotificationWillDisplayEventArgs { IDisplayableNotification Notification, void PreventDefault() }` | *Set an event to fire before displaying a notification while the app is in focus. Use this event to read notification data or decide if the notification should show or not.* |
164+
| `event EventHandler<NotificationClickEventArgs> Clicked` <br><br> `NotificationClickEventArgs { INotification Notification, INotificationClickResult Result }` | *Set an event that will fire whenever a notification is clicked on by the user.* |
165165

166166

167167
**Location Namespace**
@@ -179,13 +179,13 @@ The In App Messages namespace is accessible via `OneSignal.Default.InAppMessages
179179
| **C#** | **Description** |
180180
| ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
181181
| `bool Paused` | *Whether the in app messaging is currently paused. When set to `true` no IAM will be presented to the user regardless of whether they qualify for them. When set to 'false` any IAMs the user qualifies for will be presented to the user at the appropriate time.* |
182-
| `void AddTrigger(string key, object value)` | *Add a trigger for the current user. Triggers are currently explicitly used to determine whether a specific IAM should be displayed to the user. See [Triggers](https://documentation.onesignal.com/docs/iam-triggers).*<br><br>*If the trigger key already exists, it will be replaced with the value provided here. Note that triggers are not persisted to the backend. They only exist on the local device and are applicable to the current user.* |
183-
| `void AddTriggers(Dictionary<string, object> triggers)` | *Add multiple triggers for the current user. Triggers are currently explicitly used to determine whether a specific IAM should be displayed to the user. See [Triggers](https://documentation.onesignal.com/docs/iam-triggers).*<br><br>*If the trigger key already exists, it will be replaced with the value provided here. Note that triggers are not persisted to the backend. They only exist on the local device and are applicable to the current user.* |
182+
| `void AddTrigger(string key, string value)` | *Add a trigger for the current user. Triggers are currently explicitly used to determine whether a specific IAM should be displayed to the user. See [Triggers](https://documentation.onesignal.com/docs/iam-triggers).*<br><br>*If the trigger key already exists, it will be replaced with the value provided here. Note that triggers are not persisted to the backend. They only exist on the local device and are applicable to the current user.* |
183+
| `void AddTriggers(Dictionary<string, string> triggers)` | *Add multiple triggers for the current user. Triggers are currently explicitly used to determine whether a specific IAM should be displayed to the user. See [Triggers](https://documentation.onesignal.com/docs/iam-triggers).*<br><br>*If the trigger key already exists, it will be replaced with the value provided here. Note that triggers are not persisted to the backend. They only exist on the local device and are applicable to the current user.* |
184184
| `void RemoveTrigger(string key)` | *Remove the trigger with the provided key from the current user.* |
185185
| `void RemoveTriggers(params string[] keys)` | *Remove multiple triggers from the current user.* |
186186
| `void ClearTriggers()` | *Clear all triggers from the current user.* |
187-
| `event EventHandler<InAppMessageWillDisplayEventArgs> WillDisplay` <br><br> `event EventHandler<InAppMessageDidDisplayEventArgs> DidDisplay` <br><br> `event EventHandler<InAppMessageWillDismissEventArgs> WillDismiss` <br><br> `event EventHandler<InAppMessageDidDismissEventArgs> DidDismiss` <br><br><br> `InAppMessageWillDisplayEventArgs { InAppMessage Message }` <br><br> `InAppMessageDidDisplayEventArgs { InAppMessage Message }` <br><br> `InAppMessageWillDismissEventArgs { InAppMessage Message }` <br><br> `InAppMessageDidDismissEventArgs { InAppMessage Message }`| *Set the IAM lifecycle events.* |
188-
| `event EventHandler<InAppMessageClickEventArgs> Clicked` <br><br> `InAppMessageClickEventArgs { InAppMessage Message, InAppMessageClickResult Result }` | *Set the IAM click events.* |
187+
| `event EventHandler<InAppMessageWillDisplayEventArgs> WillDisplay` <br><br> `event EventHandler<InAppMessageDidDisplayEventArgs> DidDisplay` <br><br> `event EventHandler<InAppMessageWillDismissEventArgs> WillDismiss` <br><br> `event EventHandler<InAppMessageDidDismissEventArgs> DidDismiss` <br><br><br> `InAppMessageWillDisplayEventArgs { IInAppMessage Message }` <br><br> `InAppMessageDidDisplayEventArgs { IInAppMessage Message }` <br><br> `InAppMessageWillDismissEventArgs { IInAppMessage Message }` <br><br> `InAppMessageDidDismissEventArgs { IInAppMessage Message }`| *Set the IAM lifecycle events.* |
188+
| `event EventHandler<InAppMessageClickEventArgs> Clicked` <br><br> `InAppMessageClickEventArgs { IInAppMessage Message, IInAppMessageClickResult Result }` | *Set the IAM click events.* |
189189

190190

191191
**LiveActivities Namespace**

0 commit comments

Comments
 (0)