android 10 doesn't support whitelist plugin

Question

Android 10 doesn't support "whitelist plugin", when I add android platform it skips whitelist plugin which cause "file transfer plugin" issues when building or running the application

ionic cordova platform add android@latest

Installing "cordova-plugin-whitelist" for android
Plugin doesn't support this project's cordova-android version. cordova-    android: 10.1.0, failed version requirement: >=4.0.0 <10.0.0
Skipping 'cordova-plugin-whitelist' for android

When creating the application, these errors will appear :

ionic cordova build android

Task :app:compileDebugJavaWithJavac D:\workspace\SCL\platforms\android\app\src\main\java\org\apache\cordova\filetransfer\FileTransfer.java:48: error: cannot find symbol import org.apache.cordova.Whitelist; ^ symbol: class Whitelist location: package org.apache.cordova D:\workspace\SCL\platforms\android\app\src\main\java\org\apache\cordova\filetransfer\FileTransfer.java:691: error: cannot find symbol Whitelist whitelist = (Whitelist)gwl.invoke(webView); ^ symbol: class Whitelist location: class org.apache.cordova.filetransfer.FileTransfer D:\workspace\SCL\platforms\android\app\src\main\java\org\apache\cordova\filetransfer\FileTransfer.java:691: error: cannot find symbol Whitelist whitelist = (Whitelist)gwl.invoke(webView); ^ symbol: class Whitelist location: class org.apache.cordova.filetransfer.FileTransfer Note: Some input files use or override a deprecated API. Note: Recompile with -Xlint:deprecation for details. Note: Some input files use unchecked or unsafe operations. Note: Recompile with -Xlint:unchecked for details. 3 errors

it seems like "file transfer" require "whitelist plugin" but "whitelist plugin" is being skipped when adding android > 10

this doesn't happen in android 9

anyone can help please ?

whitelist plugin is built in cordova-android 10, but file-transfer will need to be updated to use the new cordova-android classes instead of the old whitelist plugin classes — jcesarmobile, Aug 24 '21 at 17:58
but why it skip whitelist plugin when adding the android platform ? — BASSI Yassine, Aug 24 '21 at 21:03
Because it’s built in now and causes conflicts if installed — jcesarmobile, Aug 24 '21 at 21:10
Unlike, android@10.0.0, I think android@10.1.0 doesn't install the whitelist plugin automatically anymore. — MIWMIB, Sep 03 '21 at 10:17

score 59 · Answer 1 · edited Mar 20 '23 at 12:14

59

Cordova 10+ includes the Whitelist class and no external plugin is required. In addition to removing it you also need to update the file transfer plugin.

So, you need to do two things:

Update the file transfer plugin. Even though this plugin is no longer recommended, the developer has thankfully updated the plugin to support the new Whitelist class, which is now included by default in Cordova. You will have to do this by installing directly from the github repo:

cordova plugin add https://github.com/apache/cordova-plugin-file-transfer.git
Remove the whitelist plugin

cordova plugin rm cordova-plugin-whitelist

H/T to the original response in this [thread][1]

checkout the file transfer plugin issues [1]: https://githubmemory.com/repo/apache/cordova-plugin-file-transfer/issues/306

edited Mar 20 '23 at 12:14

AWE FRANCIS OLAWUMI

154
1
9

answered Nov 03 '21 at 10:24

Rajath Kedilaya

731
5
4

1

Life saver, worked – Mathias Rønnow Nørtoft Jan 14 '22 at 07:43
1

For Capacitor users: `npm i https://github.com/apache/cordova-plugin-file-transfer.git` to install plugin and then: `npm install @awesome-cordova-plugins/file-transfer ` then `ionic cap sync` – Najam Us Saqib Jun 21 '22 at 14:13
3

I needed this line in my config.xml as well `` – tanner burton Nov 16 '22 at 07:27
1

@tannerburton thank you for that comment! I needed that! – Christopher Mar 29 '23 at 09:54

fineTuneFork · Answer 2 · 2021-12-10T19:45:42.843

38

The replies from Sanjay and Francisco helped me to find the right solution. Along with fixing the package.json and other existence of 'whitelist plugin' from the project, you also need to run the following to uninstall it from the android/ios platforms.

ionic cordova plugin rm cordova-plugin-whitelist

Update - For whatever reason, this started throwing errors again. See Rajath's answer. (thank you, Rajath!) In short, add the plugin again from the github repo instead

cordova plugin add https://github.com/apache/cordova-plugin-file-transfer.git

edited Dec 10 '21 at 19:45

answered Oct 05 '21 at 00:36

fineTuneFork

683
7
21

1

Thanks for answer. But what about iOS build? Does it require to whitelist the urls in iOS ? – Nagendra Badiganti Oct 11 '21 at 05:47
Yes same question re iOS, and WIndows, but looks like this may only have even been for Android? (see https://cordova.apache.org/docs/en/9.x/reference/cordova-plugin-whitelist/ only support Andorid) – peterc Nov 18 '21 at 05:16
I've no idea, haven't gotten to iOS yet. If you've solved it, would appreciate the solution here. :) – fineTuneFork Dec 10 '21 at 19:54
`https://github.com/apache/cordova-plugin-file-transfer.git` is not reachable – AnR Jan 02 '23 at 17:29

Siddhartha Mukherjee · Answer 3 · 2022-10-26T05:56:45.150

13

The same thing happened to me. after replacing Whitelist Class . it works for me, so you might want to try it.

Replace Whitelist class with AllowList in

cordova-plugin-file-transfer > src > android > FileTransfer.java

 // replace
 import org.apache.cordova.Whitelist;

 import org.apache.cordova.AllowList;

// Replace
Whitelist whitelist = (Whitelist)gwl.invoke(webView);
shouldAllowRequest = whitelist.isUrlWhiteListed(source); 

AllowList whitelist = (AllowList)gwl.invoke(webView);
shouldAllowRequest = whitelist.isUrlAllowListed(source);

edited Oct 26 '22 at 05:56

answered Oct 24 '22 at 20:30

Siddhartha Mukherjee

2,703
2
24
29

replacing Whitelist with Allowlist gives the same `cannot find symbol` error – AnR Jan 02 '23 at 17:28
You didn't replace all the Whitelist, I think – Siddhartha Mukherjee Jan 02 '23 at 18:27

score 8 · Answer 4 · answered Sep 04 '21 at 12:46

8

cordova version 10.0.0 or later does not need cordova-plugin-whitelist plugin you can just simply remove them . cordova 10.0.0 or android 10.0.0 (API 30) have inbuild core whitelist so you can remove and make build again

answered Sep 04 '21 at 12:46

Sanjay Kumar

81
2

score 3 · Answer 5 · answered Aug 29 '21 at 13:35

3

I think you have the same problem i had to sorted out.

Go to your Cordova Folder path and edit the package.json file removing the two lines that references cordova-plugin-whitelist.

And all will be perfect after that.

answered Aug 29 '21 at 13:35

Francisco Gonçalves

31
3

score 0 · Answer 6 · answered Feb 18 '23 at 01:32

I had the same issue and it was fixed by installing the following:

ionic cordova plugin add cordova-plugin-androidx
ionic cordova plugin add cordova-plugin-androidx-adapter

The error comes because this app is not using androidX but these plugins solve errors.

score 0 · Answer 7 · answered Jul 18 '23 at 06:41

So even though it's suggest to replace the WhiteList with AllowedList there are no specification where should this replacement should happen so after many tries this is the working solution(code base) after WhiteList replaced with allowdList please find the code here.

Updated working WhiteListPlugin.java

android 10 doesn't support whitelist plugin

7 Answers7

Linked