Getting Started

Installieren

Sie können unser AI-gestütztes Setup verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten Ihrem AI-Tool mit folgendem Befehl hinzu:

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

Verwenden Sie dann folgende Anweisung:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die Plattform-spezifischen Anweisungen unten befolgen:

bun add @capgo/capacitor-downloader
bunx cap sync

Importieren

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

API Übersicht

download

Ein neues Herunterladetask starten.

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

Eine aktive Herunterladung pausieren. Die Herunterladung kann später von derselben Position fortgesetzt werden.

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

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

resume

Eine pausierte Herunterladung wiederaufnehmen. Fortsetzt von dem Punkt, an dem sie pausiert wurde.

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

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

stop

Eine Herunterladung dauerhaft beenden und stornieren. Heruntergeladene Daten werden gelöscht.

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

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

checkStatus

Überprüfen Sie den aktuellen Status eines Downloads.

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

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

getFileInfo

Erfahren Sie mehr über ein heruntergeladenenes Datei.

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

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

Typenverweis

DownloadOptions

Konfigurationsoptionen für den Start eines Downloads.

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

Stellt den aktuellen Zustand und den Fortschritt eines Downloadauftrags dar.

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';
}

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisierung, wenn die öffentliche API upstream geändert wird.

Weitermachen von Getting Started

Wenn Sie " Getting Started für die Planung Ihres Dashboards und API-Operationen verwenden, verbinden Sie es mit Mit @capgo/capacitor-downloader für die native Fähigkeit in Mit @capgo/capacitor-downloader, API Übersicht für die Implementierungsdetails in API Übersicht, Einführung für die Implementierungsdetails in Einführung, API Schlüssel für die Implementierungsdetails in API Schlüssel, und Geräte für die Implementierungsdetails in Geräte.