Per iniziare

Installa

Puoi usare il nostro setup assistito dall'IA per installare il plugin. Aggiungi le skill Capgo al tuo strumento di IA usando il seguente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Poi usa il seguente prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-downloader` plugin in my project.

Se preferisci la configurazione manuale, installa il plugin eseguendo questi comandi e segui le istruzioni specifiche per piattaforma qui sotto:

bun add @capgo/capacitor-downloader
bunx cap sync

Importa

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

Avvio rapido

Scarica in una cartella nota, monitora il progresso e riprendi il download dopo il riavvio dell'app, se supportato.

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

const progressListener = await CapacitorDownloader.addListener('downloadProgress', (event) => {
  if (event.id === 'offline-pack') {
    console.log(event.progress);
  }
});

const task = await CapacitorDownloader.download({
  id: 'offline-pack',
  url: 'https://cdn.example.com/large-pack.zip',
  destination: 'downloads/offline-pack.zip',
});

Esempio: pausa e ripresa

await CapacitorDownloader.pause({ id: 'offline-pack' });
await CapacitorDownloader.resume({ id: 'offline-pack' });

Esempio: ispeziona il file completato

import { Capacitor } from '@capacitor/core';
import { Directory, Filesystem } from '@capacitor/filesystem';

const relativePath = 'downloads/offline-pack.zip';
const path =
  Capacitor.getPlatform() === 'ios'
    ? (await Filesystem.getUri({ directory: Directory.Documents, path: relativePath })).uri
    : relativePath;

const info = await CapacitorDownloader.getFileInfo({ path });

Errori comuni

• Destinazione di archiviazione: scegli un destination la tua app può leggere su ogni piattaforma.
• Background: i download avvengono in background su iOS e Android. Su Web, download() non è implementato; usa invece il flusso di download del browser.
• Stato: usa checkStatus finché il processo dell'app è attivo. Su iOS, i task ID non vengono ripristinati dopo il riavvio.

Panoramica API

download

Avvia un nuovo task di download.

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

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

pause

Metti in pausa un download attivo. Il download può essere ripreso in seguito dallo stesso punto.

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

await CapacitorDownloader.pause({ id: 'id-123' });

resume

Riprendi un download in pausa. Continua da dove era stato messo in pausa.

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

await CapacitorDownloader.resume({ id: 'id-123' });

stop

Ferma e annulla un download definitivamente. I dati scaricati verranno eliminati.

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

await CapacitorDownloader.stop({ id: 'id-123' });

checkStatus

Controlla lo stato attuale di un download.

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

const result = await CapacitorDownloader.checkStatus({ id: 'id-123' });
console.log(result);

getFileInfo

Ottieni informazioni su un file scaricato.

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

const result = await CapacitorDownloader.getFileInfo({ path: 'path/to/file' });
console.log(result);

Riferimento ai tipi

DownloadOptions

Opzioni di configurazione per avviare un 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 un 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 src/definitions.ts. Riesegui la sync quando il API pubblico cambia upstream.

Continua da Getting Started

Se stai usando Per iniziare per pianificare le operazioni della dashboard e di API, collegalo a Utilizzo di @capgo/capacitor-downloader per la funzionalità nativa in Utilizzo di @capgo/capacitor-downloader, Panoramica API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli di implementazione in Introduzione, Chiavi API per i dettagli di implementazione in Chiavi API, e Dispositivi per i dettagli di implementazione in Dispositivi.