Getting Started

インストール

CapgoのAIアシスタントセットアップを使用してプラグインをインストールできます。AIツールにCapgoスキルを追加するには、以下のコマンドを実行してください。

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

次に、以下のプロンプトを使用してください。

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

Manualセットアップを使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください。

bun add @capgo/capacitor-downloader
bunx cap sync

インポート

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

APIの概要

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

ダウンロードを一時停止します。 ダウンロードは同じ位置から再開できます。

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

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

resume

再開する

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

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

stop

停止してダウンロードを永久にキャンセルする。 ダウンロードしたデータは削除されます。

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

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

checkStatus

ダウンロードの現在の状況を確認する。

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

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

getFileInfo

ダウンロードしたファイルの情報を取得する。

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

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

型の参照

DownloadOptions

ダウンロードを開始するための設定オプション

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

ダウンロードタスクの現在の状態と進行状況を表します。

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

ソースオブトゥルス

パブリック__CAPGO_KEEP_0__がアップストリームで変更されたときに再度同期を実行してください。 src/definitions.ts. Re-run the sync when the public API changes upstream.

ソースオブトゥルス

あなたが「{0}」を使用している場合 Getting Started to plan dashboard and API operations, connect it with Using @capgo/capacitor-downloader for the native capability in Using @capgo/capacitor-downloader, API Overview for the implementation detail in API Overview, 導入 導入 API Keys for the implementation detail in API Keys, and デバイス デバイスの実装詳細について