Home > @magiclane/maps-sdk > ContentUpdater > update
ContentUpdater.update() method
Starts or resumes the update process.
Signature:
update(allowChargeNetwork: boolean, input?: {
onStatusUpdated?: (status: ContentUpdaterStatus) => void;
onProgressUpdated?: (progress: number) => void;
onCompleteCallback?: (error: GemError) => void;
dataSavePolicy?: DataSavePolicy;
}): ProgressListener | null;Parameters
Parameter | Type | Description |
|---|---|---|
allowChargeNetwork | boolean | Whether to allow use of a metered/charged network for updates. |
{ onStatusUpdated, onProgressUpdated, onCompleteCallback, dataSavePolicy, } | (not declared) | (Optional) |
input | { onStatusUpdated?: (status: ContentUpdaterStatus) => void; onProgressUpdated?: (progress: number) => void; onCompleteCallback?: (error: GemError) => void; dataSavePolicy?: DataSavePolicy; } | (Optional) |
input properties:
- Optional onStatusUpdated?: (status: ContentUpdaterStatus) => void
- Optional onProgressUpdated?: (progress: number) => void
- Optional onCompleteCallback?: (error: GemError) => void
- Optional dataSavePolicy?: DataSavePolicy
Returns:
ProgressListener | null
The associated ProgressListener for this operation if the update can be started, otherwise null.