Why getPreplannedMapAreasAsync returns empty List?

ShawnKleese

Hello Everybody,

i'am struggeling arround with Preplanned offline Maps and need some help.

The Problem:

offlinemaptask.getPreplannedMapAreasAsync returns a Empty UnmodifiableList.

What i have Done before:

• I have created a new Map in the Arcgis Gallery (I tried OSM and Street as Basemaps) and 
• Added a Offline Map Rectangle to the Map
• 
• Added the Permission to the API Key to use this Item
• 

   

Environment/License:

I used the Free Developer Tier. I Have also in the same app the MapView and it worked - So Credentials and API Key is Ok.

 

Code Snippet:

 

ArcGISRuntimeEnvironment.setInstallDirectory(arcgisInstallFolder);
ArcGISRuntimeEnvironment.setApiKey(arcgisApiKey);
AuthenticationManager.setAuthenticationChallengeHandler(new DefaultAuthenticationChallengeHandler());

Credential cred = new UserCredential("username", "password");
portal = new Portal("https://www.arcgis.com/");
portal.setCredential(cred);
portalItem = new PortalItem(portal, "2098a0d8b#Cleaned#74b67bf3");

OfflineMapTask offlineMapTask = new OfflineMapTask(portalItem);

ListenableFuture<List<PreplannedMapArea>> future = offlineMapTask.getPreplannedMapAreasAsync();

future.addDoneListener(() -> {


try {
    List<PreplannedMapArea> preplannedMaps = future.get(); // <---- preplannedMaps  is EMPTY :-((((

   
} catch (InterruptedException | ExecutionException e1) {
// TODO Auto-generated catch block
e1.printStackTrace();
}
} );

 

 

The Question:

What can be the Reason why the Preplanned Maps are empty ?

NFurness

Hi @ShawnKleese,

I have a theory about what's going on.

Can you comment out your line of code that sets the global API Key on the ArcGISRuntimeEnvironment please and try that?

Here's what I think is happening:

• Preplanned map areas are stored as hidden portal items that are related to the web map portal item (there's an area item for each preplanned map area, and each area item itself has related package items, all hidden).
• The API Key might have access to the web map, but we don't yet automatically extend the API Key access to these related portal items.
• By setting the global API Key on line 2, any Runtime object that doesn't have an explicit credential set will default to using that global API Key and bypass the authentication manager flow. I think that your OfflineTask can see the web map item, but cannot read the related area items to enumerate them.

We need to update our API Key scoping logic to include these related area and package items when scoping an API Key for a web map.

In the meantime you could do a couple of things:

1. Do not set the API Key globally, but set it on each Runtime object that needs it.
2. Explicitly set your credential (from line 5 in your code) on your OfflineMapTask with setCredential(). You should then be able to enumerate the preplanned areas. You will probably also need to set it on the DownloadPreplannedOfflineMapJob that you create from the OfflineMapTask

Let us know if that helps.

If not, you should create a test web map that is entirely public and we can investigate further from there.