Getting Started

Instalasi

Anda dapat menggunakan Pengaturan Bantu AI kami untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI Anda menggunakan perintah berikut:

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

Lalu gunakan prompt berikut:

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

Jika Anda lebih suka Pengaturan Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:

bun add @capgo/capacitor-file-sharer
bunx cap sync

Impor

import { FileSharer } from '@capgo/capacitor-file-sharer';

Bagikan File Base64

import { FileSharer } from '@capgo/capacitor-file-sharer';

await FileSharer.share({
  filename: 'report.pdf',
  contentType: 'application/pdf',
  base64Data: reportBase64,
  title: 'Quarterly report',
  text: 'Attached report',
});

base64Data dapat berupa string base64 mentah atau URL data seperti data:application/pdf;base64,....

Bagikan File Lokal

await FileSharer.share({
  filename: 'export.zip',
  contentType: 'application/zip',
  path: fileUri,
});

Implementasi asli menerima jalur lokal, file:// URLs, Android content:// URI, dan Capacitor _capacitor_file_ URLs.

Simpan File

const result = await FileSharer.save({
  filename: 'backup.zip',
  contentType: 'application/zip',
  base64Data: zipBase64,
  android: {
    saveDirectory: 'downloads',
    relativePath: 'Download/My App',
  },
});

console.log(result.uri);

Direktori penyimpanan Android adalah downloads, pictures, movies, music, dan documents. Pada Android 10 dan lebih baru, plugin menulis melalui MediaStore. Pada Android 9 dan di bawah, penyimpanan publik menggunakan izin manifest dengan WRITE_EXTERNAL_STORAGE Bagikan Teks Dengan File maxSdkVersion=28.

dan

await FileSharer.share({
  filename: 'photo.jpg',
  contentType: 'image/jpeg',
  path: photoUri,
  title: 'Site photo',
  subject: 'Photo export',
  text: 'Captured during inspection.',
});

text dipasang sebagai EXTRA_TEXT pada Android dan sebagai item kegiatan kedua pada iOS.

Referensi Tipe

ShareFileOptions

export interface ShareFileOptions {
  filename: string;
  base64Data?: string;
  path?: string;
  contentType?: string;
  text?: string;
  title?: string;
  subject?: string;
  android?: AndroidFileSharerOptions;
}

AndroidFileSharerOptions

export interface AndroidFileSharerOptions {
  chooserTitle?: string;
  saveDirectory?: 'downloads' | 'pictures' | 'movies' | 'music' | 'documents';
  relativePath?: string;
}

SaveFileResult

export interface SaveFileResult {
  uri?: string;
}

Kode Kesalahan

• ERR_PARAM_NO_FILENAME - filename tidak ada atau kosong.
• ERR_PARAM_NO_DATA - tidak base64Data atau path tidak disediakan.
• ERR_PARAM_DATA_INVALID - input base64 tidak dapat diurai.
• ERR_LOCAL_FILE_NOT_FOUND - jalur lokal atau URI konten yang disediakan tidak dapat dibuka.
• ERR_FILE_CACHING_FAILED - file sementara native tidak dapat ditulis.
• ERR_FILE_SAVE_FAILED - Android tidak dapat menyimpan file ke penyimpanan publik.
• ERR_ACTIVITY_NOT_FOUND - Android tidak dapat membuka target berbagi.
• USER_CANCELLED - lembaran berbagi iOS ditutup tanpa diselesaikan.

Sumber Kebenaran

Halaman ini mengikuti plugin’s src/definitions.ts. Jalankan ulang sinkronisasi ketika API publik berubah di atas

Teruskan dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan penyimpanan dan pengelolaan file, hubungkannya dengan Menggunakan @capgo/capacitor-file-sharer untuk kemampuan asli di Menggunakan @capgo/capacitor-file-sharer, @capgo/capacitor-data-storage-sqlite untuk detail implementasi di @capgo/capacitor-data-storage-sqlite, Menggunakan @capgo/capacitor-data-storage-sqlite untuk kemampuan asli di Menggunakan @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-file untuk detail implementasi di @capgo/capacitor-file, dan Menggunakan @capgo/capacitor-file untuk kemampuan asli di Menggunakan @capgo/capacitor-file.