Offline API ref documentation #929

shubham7109 · 2025-07-08T20:35:55Z

Related to issue: #6118

Description:

PR to add API ref documentation for the Offline map areas toolkit component.

To generate doc run: ./gradlew :kdoc:dokkaHtml

Pre-merge Checklist

a vTest Job for this PR has been run
- link: https://runtime-kotlin.esri.com/view/all/job/vtest/job/toolkit/825/

shubham7109 · 2025-07-08T20:48:48Z

toolkit/offline/src/main/java/com/arcgismaps/toolkit/offline/OfflineMapState.kt

-public class OfflineMapState(
-    private val arcGISMap: ArcGISMap,
-    private val onSelectionChanged: (ArcGISMap) -> Unit = { }
-) {
+public class OfflineMapState {
+    private val arcGISMap: ArcGISMap
+    private val onSelectionChanged: ((ArcGISMap) -> Unit)


Added this change to allow doc for the two constructors.

shubham7109 · 2025-07-08T20:50:09Z

toolkit/offline/src/main/java/com/arcgismaps/toolkit/offline/OfflineRepository.kt

     * @since 200.8.0
     */
-    public fun removeDownloadsForWebmap(context: Context, offlineMapInfo: OfflineMapInfo) {
+    public fun removeDownloadsForOfflineMapInfo(context: Context, offlineMapInfo: OfflineMapInfo) {


Thoughts on this change? Felt this gives more clarity for this purposes of this function ^

I can go either ways. Initially I thought removeDownloadsForWebmap gave user an idea that this will remove all downloads for the Webmap and in order to do it they need to provide OfflineMapInfo as the parameter. Taking the WebMap out from the name removes that association. We do state that in the doc though,
Removes all downloads for a specific web map's [OfflineMapInfo]

If you want to take out the Webmap from the name then I think we should just call the method removeDownloads. As offlineMapInfo is implied because of the offlineMapInfo parameter. It will also make it inline with Swift

public func removeDownloads(for offlineMapInfo: OfflineMapInfo)

Added change :)

puneet-pdx

@shubham7109 Looks good.

puneet-pdx · 2025-07-09T00:10:29Z

toolkit/offline/src/main/java/com/arcgismaps/toolkit/offline/OfflineRepository.kt

     * @since 200.8.0
     */
-    public fun removeDownloadsForWebmap(context: Context, offlineMapInfo: OfflineMapInfo) {
+    public fun removeDownloadsForOfflineMapInfo(context: Context, offlineMapInfo: OfflineMapInfo) {


I can go either ways. Initially I thought removeDownloadsForWebmap gave user an idea that this will remove all downloads for the Webmap and in order to do it they need to provide OfflineMapInfo as the parameter. Taking the WebMap out from the name removes that association. We do state that in the doc though,
Removes all downloads for a specific web map's [OfflineMapInfo]

If you want to take out the Webmap from the name then I think we should just call the method removeDownloads. As offlineMapInfo is implied because of the offlineMapInfo parameter. It will also make it inline with Swift

public func removeDownloads(for offlineMapInfo: OfflineMapInfo)

…c-improvements

shubham7109 · 2025-07-09T16:15:32Z

Thanks @puneet-pdx, ready for your review!

puneet-pdx

@shubham7109 looks good 👍🏽

* Create offline toolkit module & microapp (#835) * Changes to initialize preplanned map area (#843) * Changes to initialize preplanned map area * update apiDump file * add newline and copyright header * remove initializer for modifier * address code review comments * remove spacer * Enhance preplanned area list (#846) * Changes to enhance the preplanned map areas list * Add preplanned areas state, offlineMapInfo * add newline add strings.xml to t9nmanifest.txt * update api file remove composableSingletons * address code review comments * Add Workmanager to OfflineMapAreas (#844) * Wire workmanager with UI (#849) * Add backing properties (#850) * Add backing properties * remove commented code * remove unused imports * Add WorkManagerRepository (#851) * WIP * pair programming progress * clean up app code * Make parent directory if absent * more pair programming progress * Monday refactor work, updated workmanager to observe UUID, updated OfflineMapState to initialize with Context, changed microapp to use ViewModel * add newline and TODO * add portalItemId of the webmap's portalItem to the file download path --------- Co-authored-by: Shubham Sharma <shubhamsharma@esri.com> * OfflineMapAreas: Doc rework (#852) * Add fix so that we always run the workManagerRepository funs in viewModel scope (#856) * Add fix so that we always run the workManagerRepository fun in the viewModel scope so the long running collect operations survive orientation changes * update api file remove unused code * address code review comments * update api file * removed unused import * Update feature branch with latest v.next changes (#864) * Add additional functionality (#859) * Add fix so that we always run the workManagerRepository fun in the viewModel scope so the long running collect operations survive orientation changes * update api file remove unused code * WIP * WIP * some clean up and added currently open message * remove unused fun update api file * update api file * remove unused import * address code review comments * revert notification changes * move WorkManagerRepository to workmanager package * Switch between online and offline map (#865) * Add fix so that we always run the workManagerRepository fun in the viewModel scope so the long running collect operations survive orientation changes * update api file remove unused code * WIP * WIP * some clean up and added currently open message * remove unused fun update api file * update api file * remove unused import * Add changes to toggle between online and offline map * remove unused code * refactor onSelectionChangedListerner name in PreplannedMapAreaState * Notification cancel fix (#866) * Offline map info (#870) * OfflineMapInfo patch changes & cleanup (#876) * Add MapAreaDetails screen (#875) * WIP * WIP * Changes to show map area details in a modal bottomsheet * copy info file only if it exists in the pending directory * add scroll to bottomsheet add logic to delete offlinemapinfo along with the last map area to be deleted * refactor MapAreaDetailsScreen * add newline * update build.gradle to omit composableSingleton for MapAreaDetailsScreen * cancel scope after initialization * Add remove download methods to OfflineRepository rename delete download button Text * update offlineMapInfos * address code review comments * address code review comments * apply feedback * Changes to make OfflineRepository Singleton, to support single instan… (#883) * Changes to make OfflineRepository Singleton, to support single instance of OfflineMapInfos to work as a SnapShotStateList * some clean up * update api file * Remove usage of ExperimentalMaterial3Api and copy ModalBottomSheet (#888) * WIP * clean up * remove Experimental api usage add style for ComponentDialog * update build.gradle * update offline.api * Support map areas various fail reasons and errors (#885) * Enhance OfflineMapAreas microapp (#893) * Add sheetGesturesEnabled (#894) Add Modifications to copyright * Init on demand map areas selector screen (#895) * Init OnDemand map areas screen (#900) * refactor common code * WIP * add newline * update build.gradle * address code review comments * Level of detail (#902) * Add functionality to OnDemand (#904) * Support in-progress download restoration (#907) * Offline Map Areas: Cleanup changes. (#913) * Add bug fix (#924) * update check to determine if the device is offline (#925) * update check to determine if the device is offline * update logic * address code review feedback * update micro app upate offlineMapState * Offline API ref documentation (#929) * Update feature branch using v.next (#933) * Revert "Update feature branch using v.next (#933)" (#938) This reverts commit f332467. * Resolve merge by removing duplicate singleVariant --------- Co-authored-by: Puneet Prakash <puneet_prakash@esri.com>

add toollkit api doc

f1df52d

shubham7109 self-assigned this Jul 8, 2025

shubham7109 added 2 commits July 8, 2025 13:43

set properties scope

3f4c4dd

Update offline.api

5ec75e3

shubham7109 marked this pull request as ready for review July 8, 2025 20:47

shubham7109 commented Jul 8, 2025

View reviewed changes

shubham7109 requested a review from puneet-pdx July 8, 2025 20:50

puneet-pdx reviewed Jul 9, 2025

View reviewed changes

shubham7109 added 2 commits July 9, 2025 09:13

Merge branch 'feature-branches/offline-map-areas' into shubham/oma-do…

b968e89

…c-improvements

PR feedback

76cd9f6

shubham7109 requested a review from puneet-pdx July 9, 2025 16:15

puneet-pdx approved these changes Jul 9, 2025

View reviewed changes

shubham7109 merged commit 405601c into feature-branches/offline-map-areas Jul 9, 2025

shubham7109 deleted the shubham/oma-doc-improvements branch July 9, 2025 16:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Offline API ref documentation #929

Offline API ref documentation #929

Uh oh!

shubham7109 commented Jul 8, 2025 •

edited

Loading

Uh oh!

shubham7109 Jul 8, 2025

Uh oh!

shubham7109 Jul 8, 2025

Uh oh!

puneet-pdx Jul 9, 2025 •

edited

Loading

Uh oh!

shubham7109 Jul 9, 2025

Uh oh!

puneet-pdx left a comment

Uh oh!

puneet-pdx Jul 9, 2025 •

edited

Loading

Uh oh!

shubham7109 commented Jul 9, 2025

Uh oh!

puneet-pdx left a comment

Uh oh!

Uh oh!

Offline API ref documentation #929

Offline API ref documentation #929

Uh oh!

Conversation

shubham7109 commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Pre-merge Checklist

Uh oh!

shubham7109 Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

shubham7109 Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

puneet-pdx Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shubham7109 Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

puneet-pdx left a comment

Choose a reason for hiding this comment

Uh oh!

puneet-pdx Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shubham7109 commented Jul 9, 2025

Uh oh!

puneet-pdx left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shubham7109 commented Jul 8, 2025 •

edited

Loading

puneet-pdx Jul 9, 2025 •

edited

Loading

puneet-pdx Jul 9, 2025 •

edited

Loading