Home > @magiclane/maps-sdk > ContentStoreItem > asyncDownload
ContentStoreItem.asyncDownload() method
Asynchronously starts or resumes the download of the content store product content. Requires automatic map rendering. Disables the cursor if enabled.
Signature:
asyncDownload(onCompleteCallback: (err: GemError) => void, options?: {
onProgressCallback?: (progress: number) => void;
allowChargedNetworks?: boolean;
savePolicy?: DataSavePolicy;
priority?: ContentDownloadThreadPriority;
}): EventDrivenProgressListener;Parameters
Parameter | Type | Description |
|---|---|---|
onCompleteCallback | (err: GemError) => void | Callback for completion notification (cannot be empty). |
options | { onProgressCallback?: (progress: number) => void; allowChargedNetworks?: boolean; savePolicy?: DataSavePolicy; priority?: ContentDownloadThreadPriority; } | (Optional) Optional download options: onProgressCallback, allowChargedNetworks, savePolicy, priority. |
options properties:
- Optional onProgressCallback?: (progress: number) => void
- Optional allowChargedNetworks?: boolean
- Optional savePolicy?: DataSavePolicy
- Optional priority?: ContentDownloadThreadPriority
Returns:
The associated EventDrivenProgressListener.