Skip to content

Commit

Permalink
Add commas
Browse files Browse the repository at this point in the history
  • Loading branch information
@shepherd-l @jinliu9508
shepherd-l authored and jinliu9508 committed Feb 27, 2024
1 parent 3db92c1 commit 4306cd3
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 18 deletions.
21 changes: 12 additions & 9 deletions MIGRATION_GUIDE_v3_to_v5.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,19 @@ OneSignal uses a built-in **alias label** called `external_id` which supports ex
Follow one of the following sections based on your previous install method of the OneSignal SDK.

### Unity Package Manager
1. If you have them delete the directory at `Assets/OneSignal` and the xml file at `Assets/Plugins/Android/OneSignalConfig.plugin/AndroidManifest.xml`
2. In Unity open **Window > Package Manager**
3. From the **Package Manager** window select **Packages:** in the top left and click on **In Project**
1. If you have them, delete the directory at `Assets/OneSignal` and the xml file at `Assets/Plugins/Android/OneSignalConfig.plugin/AndroidManifest.xml`
2. In Unity, open **Window > Package Manager**
3. From the **Package Manager** window, select **Packages:** in the top left and click on **In Project**
4. Select the OneSignal Unity SDK(s) and press the **Upgrade to 5.x.x** button (make sure to update both Android and iOS packages)
5. Follow the [API Reference](#api-reference) guide below to fix any compilation errors with the new namespaces and updated method calls
6. Check the menu at **Window > OneSignal SDK Setup** to see if there are any remaining steps to run

### Unity Asset Store
1. Delete the directory at `Assets/OneSignal` and the xml file at `Assets/Plugins/Android/OneSignalConfig.plugin/AndroidManifest.xml`
2. In Unity open **Window > Package Manager**
3. From the **Package Manager** window select **Packages:** in the top left and click on **My Assets**
2. In Unity, open **Window > Package Manager**
3. From the **Package Manager** window, select **Packages:** in the top left and click on **My Assets**
4. Select the **OneSignal SDK** from the list and press the **Update** button.
5. Once the update has completed click the **Import** button
5. Once the update has completed, click the **Import** button
6. Navigate to **Window > OneSignal SDK Setup**
7. Click **Run All Steps**
8. Follow the [API Reference](#api-reference) guide below to fix any compilation errors with the new namespaces and updated method calls
Expand All @@ -52,7 +52,7 @@ Follow one of the following sections based on your previous install method of th
### Unitypackage Distributable
1. Delete the directory at `Assets/OneSignal` and the xml file at `Assets/Plugins/Android/OneSignalConfig.plugin/AndroidManifest.xml`
2. Download the latest release from our [releases page](https://github.com/OneSignal/OneSignal-Unity-SDK/releases)
3. In Unity navigate to **Assets > Import Package > Custom Package...** and select the newly downloaded `*.unitypackage` file
3. In Unity, navigate to **Assets > Import Package > Custom Package...** and select the newly downloaded `*.unitypackage` file
4. Navigate to **Window > OneSignal SDK Setup**
7. Click **Run All Steps**
8. Follow the [API Reference](#api-reference) guide below to fix any compilation errors with the new namespaces and updated method calls
Expand Down Expand Up @@ -248,12 +248,15 @@ The debug namespace is accessible via `OneSignal.Debug` and provides access to d
- We will be introducing JWT in follow up Beta release

# Troubleshooting

If you run into the following errors :

`Assets/OneSignal/Example/OneSignalExampleBehaviou.cs: error CS0246: The type or namespace name '...' could not be found (are you missing a using directive or an assembly reference?)`

`Assets/OneSignal/Attribution/OneSignalVSAttribution.cs: error CS0117: 'OneSignal' does not contain a definition for '...'`

- Delete the directory at `Assets/OneSignal` and the xml file at `Assets/Plugins/Android/OneSignalConfig.plugin/AndroidManifest.xml`
1. Delete the directory at `Assets/OneSignal` and the xml file at `Assets/Plugins/Android/OneSignalConfig.plugin/AndroidManifest.xml`

- Check the menu at **Window > OneSignal SDK Setup** to see if there are any remaining steps to run
2. Check the menu at **Window > OneSignal SDK Setup** to see if there are any remaining steps to run

If you would like to regenerate the OneSignal assets, remove the OneSignal Unity SDK packages (Android, Core, iOS) from your project and import the OneSignal SDK again.
21 changes: 12 additions & 9 deletions OneSignalExample/Assets/OneSignal/MIGRATION_GUIDE_v3_to_v5.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,19 @@ OneSignal uses a built-in **alias label** called `external_id` which supports ex
Follow one of the following sections based on your previous install method of the OneSignal SDK.

### Unity Package Manager
1. If you have them delete the directory at `Assets/OneSignal` and the xml file at `Assets/Plugins/Android/OneSignalConfig.plugin/AndroidManifest.xml`
2. In Unity open **Window > Package Manager**
3. From the **Package Manager** window select **Packages:** in the top left and click on **In Project**
1. If you have them, delete the directory at `Assets/OneSignal` and the xml file at `Assets/Plugins/Android/OneSignalConfig.plugin/AndroidManifest.xml`
2. In Unity, open **Window > Package Manager**
3. From the **Package Manager** window, select **Packages:** in the top left and click on **In Project**
4. Select the OneSignal Unity SDK(s) and press the **Upgrade to 5.x.x** button (make sure to update both Android and iOS packages)
5. Follow the [API Reference](#api-reference) guide below to fix any compilation errors with the new namespaces and updated method calls
6. Check the menu at **Window > OneSignal SDK Setup** to see if there are any remaining steps to run

### Unity Asset Store
1. Delete the directory at `Assets/OneSignal` and the xml file at `Assets/Plugins/Android/OneSignalConfig.plugin/AndroidManifest.xml`
2. In Unity open **Window > Package Manager**
3. From the **Package Manager** window select **Packages:** in the top left and click on **My Assets**
2. In Unity, open **Window > Package Manager**
3. From the **Package Manager** window, select **Packages:** in the top left and click on **My Assets**
4. Select the **OneSignal SDK** from the list and press the **Update** button.
5. Once the update has completed click the **Import** button
5. Once the update has completed, click the **Import** button
6. Navigate to **Window > OneSignal SDK Setup**
7. Click **Run All Steps**
8. Follow the [API Reference](#api-reference) guide below to fix any compilation errors with the new namespaces and updated method calls
Expand All @@ -52,7 +52,7 @@ Follow one of the following sections based on your previous install method of th
### Unitypackage Distributable
1. Delete the directory at `Assets/OneSignal` and the xml file at `Assets/Plugins/Android/OneSignalConfig.plugin/AndroidManifest.xml`
2. Download the latest release from our [releases page](https://github.com/OneSignal/OneSignal-Unity-SDK/releases)
3. In Unity navigate to **Assets > Import Package > Custom Package...** and select the newly downloaded `*.unitypackage` file
3. In Unity, navigate to **Assets > Import Package > Custom Package...** and select the newly downloaded `*.unitypackage` file
4. Navigate to **Window > OneSignal SDK Setup**
7. Click **Run All Steps**
8. Follow the [API Reference](#api-reference) guide below to fix any compilation errors with the new namespaces and updated method calls
Expand Down Expand Up @@ -248,12 +248,15 @@ The debug namespace is accessible via `OneSignal.Debug` and provides access to d
- We will be introducing JWT in follow up Beta release

# Troubleshooting

If you run into the following errors :

`Assets/OneSignal/Example/OneSignalExampleBehaviou.cs: error CS0246: The type or namespace name '...' could not be found (are you missing a using directive or an assembly reference?)`

`Assets/OneSignal/Attribution/OneSignalVSAttribution.cs: error CS0117: 'OneSignal' does not contain a definition for '...'`

- Delete the directory at `Assets/OneSignal` and the xml file at `Assets/Plugins/Android/OneSignalConfig.plugin/AndroidManifest.xml`
1. Delete the directory at `Assets/OneSignal` and the xml file at `Assets/Plugins/Android/OneSignalConfig.plugin/AndroidManifest.xml`

- Check the menu at **Window > OneSignal SDK Setup** to see if there are any remaining steps to run
2. Check the menu at **Window > OneSignal SDK Setup** to see if there are any remaining steps to run

If you would like to regenerate the OneSignal assets, remove the OneSignal Unity SDK packages (Android, Core, iOS) from your project and import the OneSignal SDK again.

0 comments on commit 4306cd3

Please sign in to comment.