You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[Xamarin.Android.Build.Tasks] Update XA5207 for VSCode (#8494)
Context: #8413
Context: #8522
The [XA5207][0] error message contained IDE-specific instructions:
# Visual Studio
error XA5207: Could not find android.jar for API Level 28. This means the Android SDK platform for API Level 28 is not installed.
Either install it in the Android SDK Manager (Tools > Android > Android SDK Manager...), or change your Xamarin.Android project
to target an API version that is installed.
# Visual Studio for Mac
error XA5207: Could not find android.jar for API Level 28. This means the Android SDK platform for API Level 28 is not installed.
Either install it in the Android SDK Manager (Tools > Open Android SDK Manager...), or change your Xamarin.Android project
to target an API version that is installed.
[Visual Studio for Mac is now deprecated][1]:
> Visual Studio for Mac is scheduled for retirement by August 31, 2024
Visual Studio Code is now supported, via [C# Dev Kit][2] and the
[.NET MAUI][3] extensions. ([Announcement][4].)
These changes mean that our error messages are obsolete (building on
macOS) or misleading (building within VSCode on Windows).
Update the XA5207 error generation logic to take these changes into
consideration. Visual Studio (Windows) will retain the existing
error message text. The Visual Studio for Mac instructions are
replaced with instructions for command-line builds, for use from
Visual Studio Code:
# Visual Studio
error XA5207: Could not find android.jar for API Level 28. This means the Android SDK platform for API Level 28 is not installed;
it was expected to be in `…`.
Either install it in the Android SDK Manager (Tools > Android > Android SDK Manager...), or change the .NET Android project
to target an API version that is installed.
See https://aka.ms/xa5207 for more details.
# Visual Studio Code
error XA5207: Could not find android.jar for API Level 28. This means the Android SDK platform for API Level 28 is not installed;
it was expected to be in `…`.
You can install the missing API level by running
`dotnet build -t:InstallAndroidDependencies -f net8.0-android "-p:AndroidSdkDirectory=…"`,
or change the project to target an API version that is installed.
See https://aka.ms/xa5207 for more details.
Update some of the documentation around the
`InstallAndroidDependencies` target to mention `dotnet build` options
which are required in order for the target to function correctly.
Finally, update various error messages, replacing "Xamarin.Android"
with ".NET Android".
[0]: https://github.com/xamarin/xamarin-android/blob/40cc8eaf78eb9f95abcc0e966ab274cef1692acc/Documentation/guides/messages/xa5207.md
[1]: https://learn.microsoft.com/en-us/visualstudio/mac/what-happened-to-vs-for-mac?view=vsmac-2022
[2]: https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit
[3]: https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.dotnet-maui
[4]: https://devblogs.microsoft.com/visualstudio/announcing-the-dotnet-maui-extension-for-visual-studio-code/
Calls the [`GetAndroidDependencies`](#getandroiddependencies) target, then installs
92
92
the Android SDK packages specified in the `@(AndroidDependency)` item group.
93
93
94
+
```dotnetcli
95
+
dotnet build -t:InstallAndroidDependencies -f net8.0-android "-p:AndroidSdkDirectory=<path to sdk>" "-p:JavaSdkDirectory=<path to java sdk>"
96
+
```
97
+
98
+
The `-f net8.0-android` is required as this target is a .NET Android specific target. If you omit this argument
99
+
you will get the following error:
100
+
101
+
```
102
+
error MSB4057: The target "InstallAndroidDependencies" does not exist in the project.
103
+
```
104
+
105
+
The `AndroidSdkDirectory` and `JavaSdkDirectory` properties are required as we need to know where to install the required components. These directories can be empty or existing. Sdk components
106
+
will be installed on top on an existing sdk installation.
107
+
94
108
The [`$(AndroidManifestType)`](~/android/deploy-test/building-apps/build-properties.md#androidmanifesttype)
95
109
MSBuild property controls which
96
110
[Visual Studio SDK Manager repository](~/android/get-started/installation/android-sdk.md?tabs=windows#repository-selection)
Copy file name to clipboardExpand all lines: Documentation/guides/messages/xa5207.md
+24-3Lines changed: 24 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -7,14 +7,35 @@ ms.date: 06/26/2019
7
7
8
8
## Example messages
9
9
10
-
```
10
+
```dotnetcli
11
11
XA5207: Could not find android.jar for API Level 28. This means the Android SDK platform for API Level 28 is not installed. Either install it in the Android SDK Manager (Tools > Android > Android SDK Manager...), or change your Xamarin.Android project to target an API version that is installed.
12
12
```
13
13
14
14
## Issue
15
15
16
-
In order to build a project, the Android SDK Platform matching the target API level must be installed.
16
+
In order to build a project, the Android SDK Platform matching the target API level must be installed.
17
17
18
18
## Solution
19
19
20
-
Use the Android SDK Manager to install the Android SDK Platform for the desired API level.
20
+
Use the Android SDK Manager (Tools > Android > Android SDK Manager...) to install the Android SDK Platform for the desired API level. Alternatively you can install the missing API level by running the following command from a terminal or command prompt:
21
+
22
+
```dotnetcli
23
+
dotnet build -t:InstallAndroidDependencies -f net8.0-android "-p:AndroidSdkDirectory=<path to sdk directory>"
24
+
```
25
+
26
+
Part of the new .net android system is when upgrading projects you will automatically be
27
+
upgraded to the latest API level. For example net7.0-android allowed you to target API 33,
28
+
but net8.0-android will automatically target API 34. If you want to keep your current
29
+
target API level you will need to add the 'uses-sdk' `android:targetSdkVersion` to your `AndroidManifest.xml` file.
Copy file name to clipboardExpand all lines: src/Xamarin.Android.Build.Tasks/Properties/Resources.resx
+20-16Lines changed: 20 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -416,7 +416,7 @@ The capitalized word "Portable" that appears earlier in the message is plain tex
416
416
<dataname="XA1019"xml:space="preserve">
417
417
<value>`LibraryProjectProperties` file `{0}` is located in a parent directory of the bindings project's intermediate output directory. Please adjust the path to use the original `project.properties` file directly from the Android library project directory.</value>
418
418
<comment>The following are literal names and should not be translated: LibraryProjectProperties, project.properties, Android
419
-
In this message, the term "binding" means a piece of generated code that makes it easy to access an Android API written in Java from a Xamarin.Android project written in C# or F#.
419
+
In this message, the term "binding" means a piece of generated code that makes it easy to access an Android API written in Java from a .NET Android project written in C# or F#.
420
420
{0} - The path of the LibraryProjectProperties file</comment>
421
421
</data>
422
422
<dataname="XA1020"xml:space="preserve">
@@ -438,8 +438,8 @@ In this message, the term "binding" means a piece of generated code that makes i
438
438
<comment>The following are literal names and should not be translated: DX, DEX, d8, AndroidDexTool.</comment>
439
439
</data>
440
440
<dataname="XA1024"xml:space="preserve">
441
-
<value>Ignoring configuration file '{0}'. .NET configuration files are not supported in Xamarin.Android projects that target .NET 6 or higher.</value>
442
-
<comment>The following are literal names and should not be translated: .NET, Xamarin.Android.
441
+
<value>Ignoring configuration file '{0}'. .NET configuration files are not supported in .NET Android projects that target .NET 6 or higher.</value>
442
+
<comment>The following are literal names and should not be translated: .NET, .NET Android.
443
443
{0} - The file name such as 'Foo.dll.config'</comment>
444
444
</data>
445
445
<dataname="XA1025"xml:space="preserve">
@@ -451,7 +451,7 @@ In this message, the term "binding" means a piece of generated code that makes i
451
451
<comment>The following are literal names and should not be translated: AAPT, AAPT2, Android, AndroidUseAapt2, true.</comment>
452
452
</data>
453
453
<dataname="XA1026_dotnet"xml:space="preserve">
454
-
<value>Using AAPT is not supported in Xamarin.Android projects that target .NET 6 or higher. Please enable 'Use incremental Android packaging system (aapt2)' in the Visual Studio project property pages or edit the project file in a text editor and set the 'AndroidUseAapt2' MSBuild property to 'true'.</value>
454
+
<value>Using AAPT is not supported in .NET Android projects that target .NET 6 or higher. Please enable 'Use incremental Android packaging system (aapt2)' in the Visual Studio project property pages or edit the project file in a text editor and set the 'AndroidUseAapt2' MSBuild property to 'true'.</value>
455
455
<comment>The following are literal names and should not be translated: AAPT, Android, AndroidUseAapt2, true.</comment>
456
456
</data>
457
457
<dataname="XA1027"xml:space="preserve">
@@ -505,7 +505,7 @@ Either change the value in the AndroidManifest.xml to match the $(SupportedOSPla
505
505
{1} - The SupportedOSPlatformVersion property value</comment>
506
506
</data>
507
507
<dataname="XA2000"xml:space="preserve">
508
-
<value>Use of AppDomain.CreateDomain() detected in assembly: {0}. .NET 6 and higher will only support a single AppDomain, so this API will no longer be available in Xamarin.Android once .NET 6 is released.</value>
508
+
<value>Use of AppDomain.CreateDomain() detected in assembly: {0}. .NET 6 and higher will only support a single AppDomain, so this API will no longer be available in .NET Android once .NET 6 is released.</value>
509
509
<comment>The following are literal names and should not be translated: AppDomain.CreateDomain(), AppDomain
510
510
{0} - The name of the assembly</comment>
511
511
</data>
@@ -704,12 +704,12 @@ In this message, "root element" refers to the root element of an XML file.
704
704
<comment>{0} - The exception message and stack trace of the associated exception</comment>
705
705
</data>
706
706
<dataname="XA4231"xml:space="preserve">
707
-
<value>The Android class parser value '{0}' is deprecated and will be removed in a future version of Xamarin.Android. Update the project properties to use 'class-parse'.</value>
707
+
<value>The Android class parser value '{0}' is deprecated and will be removed in a future version of .NET Android. Update the project properties to use 'class-parse'.</value>
708
708
<comment>The following are literal names and should not be translated: class-parse
709
709
{0} - The name of the current class parser value</comment>
710
710
</data>
711
711
<dataname="XA4232"xml:space="preserve">
712
-
<value>The Android code generation target '{0}' is deprecated and will be removed in a future version of Xamarin.Android. Update the project properties to use 'XAJavaInterop1'.</value>
712
+
<value>The Android code generation target '{0}' is deprecated and will be removed in a future version of .NET Android. Update the project properties to use 'XAJavaInterop1'.</value>
713
713
<comment>The following are literal names and should not be translated: XAJavaInterop1
714
714
{0} - The name of the current code generation target</comment>
715
715
</data>
@@ -790,7 +790,7 @@ The following are literal names and should not be translated: ABI, 'libs/armeabi
790
790
"Wear" is a short version of the full product name "Wear OS" and so should not be translated.</comment>
791
791
</data>
792
792
<dataname="XA4312"xml:space="preserve">
793
-
<value>Referencing the Android Wear application project '{0}' from an Android application project is deprecated and will no longer be supported in a future version of Xamarin.Android. Remove the Android Wear application project reference from the Android application project and distribute the Wear application as a standalone application instead.</value>
793
+
<value>Referencing the Android Wear application project '{0}' from an Android application project is deprecated and will no longer be supported in a future version of .NET Android. Remove the Android Wear application project reference from the Android application project and distribute the Wear application as a standalone application instead.</value>
794
794
<comment>The following are literal names and should not be translated: Android Wear, Android, Wear.
795
795
{0} - The referenced Android Wear project.</comment>
796
796
</data>
@@ -861,19 +861,23 @@ Remove the '{0}' reference from your project and add the '{1}' NuGet package ins
861
861
{0} - The missing tool name</comment>
862
862
</data>
863
863
<dataname="XA5207"xml:space="preserve">
864
-
<value>Could not find android.jar for API level {0}. This means the Android SDK platform for API level {0} is not installed. Either install it in the Android SDK Manager ({2}), or change the Xamarin.Android project to target an API version that is installed. ({1} missing.)</value>
864
+
<value>Could not find android.jar for API level {0}. This means the Android SDK platform for API level {0} is not installed; it was expected to be in `{1}`.
865
+
{2}
866
+
See https://aka.ms/xa5207 for more details.</value>
865
867
<comment>The following are literal names and should not be translated: android.jar
866
868
{0} - The API level name
867
869
{1} - The expected path of the android.jar file
868
-
{2} - The menu location in Visual Studio that can be used to launch the Android SDK Manager</comment>
<comment>This string is the location of a menu command in Visual Studio.</comment>
873
+
<value>Either install it in the Android SDK Manager (Tools > Android > Android SDK Manager...), or change the .NET Android project to target an API version that is installed.</value>
874
+
<comment>This string is the instrucitons to install the component</comment>
<value>You can install the missing API level by running `dotnet build -t:InstallAndroidDependencies -f {0} "-p:AndroidSdkDirectory={1}"`, or change the project to target an API version that is installed.</value>
878
+
<comment>This string is the instrucitons to install the component
879
+
{0} - The TargetFramework the app is targeting.
880
+
{1} - The current AndroidSdkDirectory path.</comment>
877
881
</data>
878
882
<dataname="XA5211"xml:space="preserve">
879
883
<value>Embedded Wear app package name differs from handheld app package name ({0} != {1}).</value>
Assert.IsTrue(builder.DesignTimeBuild(proj),"DesignTime build should succeed.");
818
819
Assert.IsFalse(builder.LastBuildOutput.ContainsText("error XA5207:"),"XA5207 should not have been raised.");
819
820
builder.Target="AndroidPrepareForBuild";
@@ -823,6 +824,10 @@ public void IfAndroidJarDoesNotExistThrowXA5207 ()
823
824
}),"Build should have failed");
824
825
Assert.IsTrue(builder.LastBuildOutput.ContainsText("error XA5207:"),"XA5207 should have been raised.");
825
826
Assert.IsTrue(builder.LastBuildOutput.ContainsText($"Could not find android.jar for API level {proj.TargetSdkVersion}"),"XA5207 should have had a good error message.");
827
+
if(buildingInsideVisualStudio)
828
+
Assert.IsTrue(builder.LastBuildOutput.ContainsText($"Either install it in the Android SDK Manager"),"XA5207 should have an error message for Visual Studio.");
829
+
else
830
+
Assert.IsTrue(builder.LastBuildOutput.ContainsText($"You can install the missing API level by running"),"XA5207 should have an error message for the command line.");
0 commit comments