Merge pull request #21 from ArcGIS/sample/Generate-offline-map

New Sample: Generate offline map

Author: shubham7109

generate-offline-map/.gitignore

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

generate-offline-map/README.md

@@ -0,0 +1,42 @@
+# Generate offline map
+
+Take a web map offline.
+
+![Image of generate offline map](generate-offline-map.png)
+
+## Use case
+
+Taking a web map offline allows users continued productivity when their network connectivity is poor or nonexistent. For example, by taking a map offline, a field worker inspecting utility lines in remote areas could still access a feature's location and attribute information.
+
+## How to use the sample
+
+Once the map loads, zoom to the extent you want to take offline. The red border shows the extent that will be downloaded. Tap the "Take Map Offline" button to start the offline map job. The progress bar will show the job's progress. When complete, the offline map will replace the online map in the map view.
+
+## How it works
+
+1. Create an `ArcGISMap` with a `Portal` item pointing to the web map.
+2. Create `GenerateOfflineMapParameters` specifying the download area geometry, minimum scale, and maximum scale.
+3. Create an `OfflineMapTask` with the map.
+4. Create the `OfflineMapJob` with `OfflineMapTask.generateOfflineMap(params, downloadDirectoryPath)` and start it with `OfflineMapJob.start()`.
+5. When the job is done, get the offline map with `OfflineMapJob.result.offlineMap`.
+
+## Relevant API
+
+* GenerateOfflineMapJob
+* GenerateOfflineMapParameters
+* GenerateOfflineMapResult
+* OfflineMapTask
+* Portal
+
+## About the data
+
+The map used in this sample shows the [stormwater network](https://arcgisruntime.maps.arcgis.com/home/item.html?id=acc027394bc84c2fb04d1ed317aac674) within Naperville, IL, USA, with cartography designed for web and mobile devices with offline support.
+
+## Additional information
+
+The creation of the offline map can be fine-tuned using [parameter overrides for feature layers](https://github.com/Esri/arcgis-runtime-samples-android/tree/master/java/generate-offline-map-overrides), or by using [local basemaps](https://github.com/Esri/arcgis-runtime-samples-android/tree/master/java/generate-offline-map-with-local-basemap)
+to achieve more customised results.
+
+## Tags
+
+download, offline, save, web map

generate-offline-map/README.metadata.json

@@ -0,0 +1,35 @@
+{
+  "category": "Edit and Manage Data",
+  "description": "Take a web map offline.",
+  "formal_name": "GenerateOfflineMap",
+  "ignore": false,
+  "images": [
+    "generate-offline-map.png"
+  ],
+  "keywords": [
+    "download",
+    "offline",
+    "save",
+    "web map",
+    "GenerateOfflineMapJob",
+    "GenerateOfflineMapParameters",
+    "GenerateOfflineMapResult",
+    "OfflineMapTask",
+    "Portal"
+  ],
+  "language": "kotlin",
+  "redirect_from": [
+    "/android/latest/sample-code/generate-offline-map.htm"
+  ],
+  "relevant_apis": [
+    "GenerateOfflineMapJob",
+    "GenerateOfflineMapParameters",
+    "GenerateOfflineMapResult",
+    "OfflineMapTask",
+    "Portal"
+  ],
+  "snippets": [
+    "src/main/java/com/esri/arcgismaps/sample/generateofflinemap/MainActivity.kt"
+  ],
+  "title": "Generate offline map"
+}

generate-offline-map/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.generateofflinemap"
+        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"
+}

generate-offline-map/generate-offline-map.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

generate-offline-map/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.arcgismaps.sample.generateofflinemap">
+
+    <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>