Inizia a utilizzare

Copia un prompt di configurazione con i passaggi di installazione e la guida markdown completa per questo plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-downloader`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/downloader/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Installazione

bun add @capgo/capacitor-downloader
bunx cap sync

Importa

import { CapacitorDownloader } from '@capgo/capacitor-downloader';

API Panoramica

`download`

Avvia una nuova attività di download.

import { CapacitorDownloader } from '@capgo/capacitor-downloader';

const task = await Downloader.download({
  id: 'my-download',
  url: 'https://example.com/file.pdf',
  destination: 'downloads/file.pdf'
});

`pause`

Sospendi un download attivo. Il download può essere ripreso in seguito dalla stessa posizione.

import { CapacitorDownloader } from '@capgo/capacitor-downloader';

await CapacitorDownloader.pause({} as { id: string });

`resume`

Riprendi un download sospeso. Continua da dove era stato sospeso.

import { CapacitorDownloader } from '@capgo/capacitor-downloader';

await CapacitorDownloader.resume({} as { id: string });

`stop`

Stop e annulla una download permanentemente. I dati scaricati verranno eliminati.

import { CapacitorDownloader } from '@capgo/capacitor-downloader';

await CapacitorDownloader.stop({} as { id: string });

`checkStatus`

Verifica lo stato corrente di una download.

import { CapacitorDownloader } from '@capgo/capacitor-downloader';

await CapacitorDownloader.checkStatus({} as { id: string });

`getFileInfo`

Ottieni informazioni su un file scaricato.

import { CapacitorDownloader } from '@capgo/capacitor-downloader';

await CapacitorDownloader.getFileInfo({} as { path: string });

Riferimento di tipo

`DownloadOptions`

Opzioni di configurazione per avviare una download.

export interface DownloadOptions {
  /** Unique identifier for this download task */
  id: string;
  /** URL of the file to download */
  url: string;
  /** Local file path where the download will be saved */
  destination: string;
  /** Optional HTTP headers to include in the request */
  headers?: { [key: string]: string };
  /** Network type requirement for download */
  network?: 'cellular' | 'wifi-only';
  /** Download priority level */
  priority?: 'high' | 'normal' | 'low';
}

`DownloadTask`

Rappresenta lo stato attuale e il progresso di una task di download.

export interface DownloadTask {
  /** Unique identifier for the download task */
  id: string;
  /** Download progress from 0 to 100 */
  progress: number;
  /** Current state of the download */
  state: 'PENDING' | 'RUNNING' | 'PAUSED' | 'DONE' | 'ERROR';
}

Fonte di Verità

Questa pagina è generata dal plugin’s src/definitions.ts. Riavvia la sincronizzazione quando i dati pubblici API cambiano in modo upstream.

Continua da Iniziare

Se stai utilizzando Iniziare da Iniziare per pianificare il dashboard e le API operazioni, connettilo con Utilizza @capgo/capacitor-downloader per la capacità nativa in Utilizza @capgo/capacitor-downloader, API Panoramica per i dettagli di implementazione in API Panoramica, Introduzione per i dettagli di implementazione in Introduzione, API Chiavi per i dettagli di implementazione in API Chiavi, e Dispositivi per i dettagli di implementazione in Dispositivi.