Merge pull request #25 from ArcGIS/sample/Download-vector-tiles-to-local-cache

Download vector tiles to local cache

Author: shubham7109

download-vector-tiles-to-local-cache/.gitignore

@@ -0,0 +1 @@
+/build

download-vector-tiles-to-local-cache/README.md

@@ -0,0 +1,41 @@
+# Download vector tiles to local cache
+
+Export tiles from an online vector tile service.
+
+![Image of download vector tiles to local cache](download-vector-tiles-to-local-cache.png)
+
+## Use case
+
+Field workers with limited network connectivity can use exported vector tiles as a basemap for use while offline.
+
+## How to use the sample
+
+When the vector tiled layer loads, zoom in to the extent you want to export. The red box shows the extent that will be exported. Click the "Export Vector Tiles" button to start the job. An error will show if the extent is larger than the maximum limit allowed. When finished, a dialog will show the exported result in a new map view.
+
+## How it works
+
+1. Create an `ArcGISVectorTiledLayer` from the map's base layers.
+2. Create an `ExportVectorTilesTask` using the vector tiled layer's URL.
+3. Create default `ExportVectorTilesParameters` from the task, specifying extent and maximum scale.
+4. Create a `ExportVectorTilesJob` from the task using the parameters, and specifying a vector tile cache path and an item resource path. The resource path is required if you want to export the tiles with the style.
+5. Start the job, and once it completes successfully, get the resulting `ExportVectorTilesResult`.
+6. Get the `VectorTileCache` from the result to create an `ArcGISVectorTiledLayer` that can be displayed to the map view.
+
+## Relevant API
+
+* ArcGISVectorTiledLayer
+* ExportVectorTilesJob
+* ExportVectorTilesParameters
+* ExportVectorTilesResult
+* ExportVectorTilesTask
+* VectorTileCache
+
+## Additional information
+
+**NOTE:** Downloading Tiles for offline use requires authentication with the web map's server. To use this sample, you will require an [ArcGIS Online](https://www.arcgis.com) account.
+
+Vector tiles have high drawing performance and smaller file size compared to regular tiled layers, due to consisting solely of points, lines, and polygons. However, in ArcGIS Maps SDK they cannot be displayed in scenes. Visit the [ArcGiS Online Developer's portal](https://developers.arcgis.com/android/layers/layer-types/) to Learn more about the characteristics of ArcGIS vector tiled layers.
+
+## Tags
+
+cache, download, offline, vector

download-vector-tiles-to-local-cache/README.metadata.json

@@ -0,0 +1,37 @@
+{
+    "category": "Edit and Manage Data",
+    "description": "Export tiles from an online vector tile service.",
+    "formal_name": "DownloadVectorTilesToLocalCache",
+    "ignore": false,
+    "images": [
+        "download-vector-tiles-to-local-cache.png"
+    ],
+    "keywords": [
+        "cache",
+        "download",
+        "offline",
+        "vector",
+        "ArcGISVectorTiledLayer",
+        "ExportVectorTilesJob",
+        "ExportVectorTilesParameters",
+        "ExportVectorTilesResult",
+        "ExportVectorTilesTask",
+        "VectorTileCache"
+    ],
+    "language": "kotlin",
+    "redirect_from": [
+        "/android/latest/sample-code/download-vector-tiles-to-local-cache.htm"
+    ],
+    "relevant_apis": [
+        "ArcGISVectorTiledLayer",
+        "ExportVectorTilesJob",
+        "ExportVectorTilesParameters",
+        "ExportVectorTilesResult",
+        "ExportVectorTilesTask",
+        "VectorTileCache"
+    ],
+    "snippets": [
+        "src/main/java/com/esri/com/arcgismaps/sample/downloadvectortilestolocalcache/MainActivity.kt"
+    ],
+    "title": "Download vector tiles to local cache"
+}

download-vector-tiles-to-local-cache/build.gradle

@@ -0,0 +1,33 @@
+apply plugin: 'com.android.application'
+apply plugin: 'org.jetbrains.kotlin.android'
+
+android {
+    compileSdkVersion rootProject.ext.compileSdkVersion
+
+    defaultConfig {
+        applicationId "com.esri.arcgismaps.sample.downloadvectortilestolocalcache"
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode rootProject.ext.versionCode
+        versionName rootProject.ext.versionName
+        buildConfigField("String", "API_KEY", API_KEY)
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+
+    buildFeatures {
+        dataBinding true
+        viewBinding true
+    }
+}
+
+dependencies {
+    // lib dependencies from rootProject build.gradle
+    implementation "androidx.constraintlayout:constraintlayout:$constraintLayoutVersion"
+    implementation "com.google.android.material:material:$materialVersion"
+}

download-vector-tiles-to-local-cache/download-vector-tiles-to-local-cache.png

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

download-vector-tiles-to-local-cache/proguard-rules.pro

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.esri.com.arcgismaps.sample.downloadvectortilestolocalcache">
+
+    <uses-permission android:name="android.permission.INTERNET" />
+
+    <application
+        android:allowBackup="true"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:roundIcon="@mipmap/ic_launcher_round"
+        android:supportsRtl="true"
+        android:theme="@style/AppTheme">
+        <activity
+            android:exported="true"
+            android:name=".MainActivity"
+            android:label="@string/app_name">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+        </activity>
+    </application>
+
+</manifest>