Getting Started

Installa

Puoi utilizzare la nostra configurazione assistita dall'IA per installare il plugin. Aggiungi le Capgo competenze al tuo strumento di AI utilizzando il seguente comando:

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

Poi utilizza 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 l'installazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche per la piattaforma riportate di seguito:

bun add @capgo/capacitor-downloader
bunx cap sync

Importa

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

API Panoramica

download

Inizia una nuova attività 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

Ferma un download in corso. Il download può essere ripreso in seguito dalla stessa posizione.

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

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

resume

Riavvia un download sospeso. Continua dalla posizione in cui era stato sospeso.

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

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

stop

Ferma e cancella un download permanentemente. I dati scaricati verranno eliminati.

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

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

checkStatus

Verifica lo stato corrente di un download.

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

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

getFileInfo

Ottieni informazioni sul file scaricato.

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

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

Riferimento di tipo

DownloadOptions

Opzioni di configurazione per avviare il 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 corrente 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. Re-run the sync when the public API changes upstream.

Continua da qui: Iniziare

Se stai utilizzando Getting Started per pianificare dashboard e API operazioni, connettilo con Utilizzando @capgo/capacitor-downloader per la capacità nativa in Utilizzando @capgo/capacitor-downloader, API Overview per i dettagli di implementazione in API Overview, 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 nei dispositivi.