Skip to content

Commit b8a5588

Browse files
committed
Update Migration Guide for 5.0.0 release
1 parent da1b268 commit b8a5588

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

MIGRATION_GUIDE.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h1 align="center">OneSignal iOS SDK v5.0.0-beta-04 Migration Guide</h1>
1+
<h1 align="center">OneSignal iOS SDK v5.0.0 Migration Guide</h1>
22

33
![OneSignal Omni Channel Banner](https://user-images.githubusercontent.com/11739227/208625336-d28c8d01-a7cf-4f8e-9643-ac8d1948e9ae.png)
44

@@ -8,7 +8,7 @@ In this release, we are making a significant shift from a device-centered model
88

99
To facilitate this change, the `externalId` approach for identifying users is being replaced by the `login` and `logout` methods. In addition, the SDK now makes use of namespaces such as `User`, `Notifications`, and `InAppMessages` to better separate code.
1010

11-
The iOS SDK is making the jump from `v3` to `v5`, in order to align across OneSignal’s suite of client SDKs. This guide will walk you through the iOS SDK `5.0.0-beta-04` changes as a result of this shift.
11+
The iOS SDK is making the jump from `v3` to `v5`, in order to align across OneSignal’s suite of client SDKs. This guide will walk you through the iOS SDK `5.0.0` changes as a result of this shift.
1212

1313
# Overview
1414

@@ -60,10 +60,10 @@ As mentioned above, the iOS SDK is making the jump from `v3` to `v5`, in order t
6060
```
6161

6262
### Option 1. Swift Package Manager
63-
Update the version of the OneSignal-XCFramework your application uses to `5.0.0-beta-04`. In addition, the Package Product name has been changed from `OneSignal` to `OneSignalFramework`. See [the existing installation instructions](https://documentation.onesignal.com/docs/swift-package-manager-setup).
63+
Update the version of the OneSignal-XCFramework your application uses to `5.0.0`. In addition, the Package Product name has been changed from `OneSignal` to `OneSignalFramework`. See [the existing installation instructions](https://documentation.onesignal.com/docs/swift-package-manager-setup).
6464

6565
### Option 2. CocoaPods
66-
Update the version of the OneSignalXCFramework your application uses to `5.0.0-beta-04`. Other than updating the import statement above, there are no additional changes needed to import the OneSignal SDK in your Xcode project. See [the existing installation instructions](https://documentation.onesignal.com/docs/ios-sdk-setup#step-3-import-the-onesignal-sdk-into-your-xcode-project).
66+
Update the version of the OneSignalXCFramework your application uses to `5.0.0`. Other than updating the import statement above, there are no additional changes needed to import the OneSignal SDK in your Xcode project. See [the existing installation instructions](https://documentation.onesignal.com/docs/ios-sdk-setup#step-3-import-the-onesignal-sdk-into-your-xcode-project).
6767

6868
# API Changes
6969
## Namespaces
@@ -214,7 +214,7 @@ Email and/or SMS subscriptions can be added or removed via the following methods
214214

215215
# API Reference
216216

217-
Below is a comprehensive reference to the `5.0.0-beta-04` OneSignal SDK.
217+
Below is a comprehensive reference to the `5.0.0` OneSignal SDK.
218218

219219
## OneSignal
220220

@@ -756,11 +756,10 @@ The Debug namespace is accessible via `OneSignal.Debug` and provide access to de
756756
757757
# Limitations
758758

759-
- This is a Beta release so please test thorougly prior to production use.
760759
- Changing app IDs is not supported.
761760
- Any `User` namespace calls must be invoked **after** initialization. Example: `OneSignal.User.addTag("tag", "2")`
762761
- In the SDK, the user state is only refreshed from the server when a new session is started (cold start or backgrounded for over 30 seconds) or when the user is logged in. This is by design.
763762

764763
# Known issues
765764
- Identity Verification
766-
- We will be introducing JWT in a follow up Beta release
765+
- We will be introducing Identity Verification using JWT in a follow up release

0 commit comments

Comments
 (0)