Skip to content

Commit 944d758

Browse files
committed
Update MIGRATION_GUIDE.md
1 parent 1824c2f commit 944d758

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

MIGRATION_GUIDE.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h1 align="center">OneSignal iOS SDK v5.0.0-alpha-02 Migration Guide</h1>
1+
<h1 align="center">OneSignal iOS SDK v5.0.0-beta-01 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-alpha-02` 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-beta-01` 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-alpha-02`. 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-beta-01`. 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-alpha-02`. 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-beta-01`. 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
@@ -213,7 +213,7 @@ Email and/or SMS subscriptions can be added or removed via the following methods
213213

214214
# API Reference
215215

216-
Below is a comprehensive reference to the `5.0.0-alpha-02` OneSignal SDK.
216+
Below is a comprehensive reference to the `5.0.0-beta-01` OneSignal SDK.
217217

218218
## OneSignal
219219

@@ -727,14 +727,12 @@ The Debug namespace is accessible via `OneSignal.Debug` and provide access to de
727727
728728
# Limitations
729729

730-
- Recommend using only in development and staging environments for Alpha releases
731-
- Aliases will be available in a future release
730+
- Recommend using only in development and staging environments for Beta releases
732731
- Outcomes will be available in a future release
733-
- Users are deleted when the last Subscription (push, email, or sms) is removed
734732
- Any `User` namespace calls must be invoked **after** initialization. Example: `OneSignal.User.addTag("tag", "2")`
735733

736734
# Known issues
737735
- User properties may not update correctly when Subscriptions are transferred
738736
- Please report any issues you find with this
739737
- Identity Verification
740-
- We will be introducing JWT in a follow up Alpha or Beta release
738+
- We will be introducing JWT in a follow up Beta release

0 commit comments

Comments
 (0)