From 339ddd85c1abd57bf7d4b51308bd8ccd7243d9af Mon Sep 17 00:00:00 2001 From: Kilian Finger Date: Mon, 18 Nov 2024 08:39:09 +0100 Subject: [PATCH] docs: codegen --- docs/docs.json | 14 +++++++------- docs/offlineManager.md | 12 ++++++------ 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/docs.json b/docs/docs.json index 779d92ee7..343987404 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -5051,17 +5051,17 @@ "name": "progressListener", "description": "Callback that listens for status events while downloading the offline resource.", "type": { - "name": "Callback" + "name": "ProgressListener" }, - "optional": true + "optional": false }, { "name": "errorListener", "description": "Callback that listens for status events while downloading the offline resource.", "type": { - "name": "Callback" + "name": "ErrorListener" }, - "optional": true + "optional": false } ], "examples": [ @@ -5299,7 +5299,7 @@ "name": "packName", "description": "Name of the offline pack.", "type": { - "name": "String" + "name": "string" }, "optional": false }, @@ -5307,7 +5307,7 @@ "name": "progressListener", "description": "Callback that listens for status events while downloading the offline resource.", "type": { - "name": "Callback" + "name": "ProgressListener" }, "optional": false }, @@ -5315,7 +5315,7 @@ "name": "errorListener", "description": "Callback that listens for status events while downloading the offline resource.", "type": { - "name": "Callback" + "name": "ErrorListener" }, "optional": false } diff --git a/docs/offlineManager.md b/docs/offlineManager.md index 5b6f74bf3..5c70b971e 100644 --- a/docs/offlineManager.md +++ b/docs/offlineManager.md @@ -5,7 +5,7 @@ OfflineManager implements a singleton (shared object) that manages offline packs ## Methods -### `createPack(options, [progressListener], [errorListener])` +### `createPack(options, progressListener, errorListener)` Creates and registers an offline pack that downloads the resources needed to use the given region offline. @@ -13,8 +13,8 @@ Creates and registers an offline pack that downloads the resources needed to use | Name | Type | Required | Description | | ---- | :--: | :------: | :----------: | | `options` | `OfflineCreatePackOptions` | `Yes` | Create options for a offline pack that specifices zoom levels, style url, and the region to download. | -| `progressListener` | `Callback` | `No` | Callback that listens for status events while downloading the offline resource. | -| `errorListener` | `Callback` | `No` | Callback that listens for status events while downloading the offline resource. | +| `progressListener` | `ProgressListener` | `Yes` | Callback that listens for status events while downloading the offline resource. | +| `errorListener` | `ErrorListener` | `Yes` | Callback that listens for status events while downloading the offline resource. | @@ -199,9 +199,9 @@ Subscribe to download status/error events for the requested offline pack.
No #### Arguments | Name | Type | Required | Description | | ---- | :--: | :------: | :----------: | -| `packName` | `String` | `Yes` | Name of the offline pack. | -| `progressListener` | `Callback` | `Yes` | Callback that listens for status events while downloading the offline resource. | -| `errorListener` | `Callback` | `Yes` | Callback that listens for status events while downloading the offline resource. | +| `packName` | `string` | `Yes` | Name of the offline pack. | +| `progressListener` | `ProgressListener` | `Yes` | Callback that listens for status events while downloading the offline resource. | +| `errorListener` | `ErrorListener` | `Yes` | Callback that listens for status events while downloading the offline resource. |