@capgo/capacitor-downloader
Capacitor plugin for downloading files with background support. Provides resumable downloads with progress tracking.
Overview
Section titled “Overview”Capacitor plugin for downloading files with background support. Provides resumable downloads with progress tracking.
Core Capabilities
Section titled “Core Capabilities”download- Start a new download task.pause- Pause an active download. Download can be resumed later from the same position.resume- Resume a paused download. Continues from where it was paused.stop- Stop and cancel a download permanently. Downloaded data will be deleted.
Public API
Section titled “Public API”| Method | Description |
|---|---|
download | Start a new download task. |
pause | Pause an active download. Download can be resumed later from the same position. |
resume | Resume a paused download. Continues from where it was paused. |
stop | Stop and cancel a download permanently. Downloaded data will be deleted. |
checkStatus | Check the current status of a download. |
getFileInfo | Get information about a downloaded file. |
addListener | Listen for download progress updates. Fired periodically as download progresses. |
addListener | Listen for download completion. Fired when a download finishes successfully. |
addListener | Listen for download failures. Fired when a download encounters an error. |
removeAllListeners | Remove all event listeners. Cleanup method to prevent memory leaks. |
getPluginVersion | Get the plugin version number. |
Source Of Truth
Section titled “Source Of Truth”This reference is synced from src/definitions.ts in capacitor-downloader.