Panduan Memulai

Salin prompt setup yang berisi langkah install dan panduan markdown lengkap untuk plugin ini.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-file-sharer`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/file-sharer/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Instal

Anda bisa menggunakan AI-Assisted Setup kami untuk menginstal plugin ini. Tambahkan skill Capgo ke tool AI Anda dengan command 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 memilih Manual Setup, instal plugin dengan menjalankan perintah berikut dan ikuti petunjuk khusus platform di bawah ini:

npm install @capgo/capacitor-file-sharer
npx cap sync

Impor

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

Mulai cepat

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

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

Contoh: simpan

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

const result = await FileSharer.save({
  filename: 'report.pdf',
  contentType: 'application/pdf',
  base64Data: reportBase64,
});
console.log(result);

Kesalahan umum

Sinkronisasi Native: jalankan npx cap sync setelah upgrade plugin.
Sumber kebenaran tunggal: percayai src/definitions.ts di repo GitHub.

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 bisa berupa string base64 mentah atau data URL seperti data:application/pdf;base64,....

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

Implementasi native menerima path lokal, file:// URL, Android content:// URI, dan Capacitor _capacitor_file_ URL.

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 ke atas, plugin menulis melalui MediaStore. Pada Android 9 ke bawah, penyimpanan publik menggunakan izin manifest WRITE_EXTERNAL_STORAGE izin dengan maxSdkVersion=28.

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

text diteruskan sebagai EXTRA_TEXT di Android dan sebagai activity item kedua di 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 Error

ERR_PARAM_NO_FILENAME - filename hilang atau kosong.
ERR_PARAM_NO_DATA - tidak ada base64Data maupun path yang diberikan.
ERR_PARAM_DATA_INVALID - input base64 gagal didekode.
ERR_LOCAL_FILE_NOT_FOUND - path lokal atau content URI tidak bisa dibuka.
ERR_FILE_CACHING_FAILED - file temporary native gagal ditulis.
ERR_FILE_SAVE_FAILED - Android gagal menyimpan file ke storage publik.
ERR_ACTIVITY_NOT_FOUND - Android gagal membuka target share.
USER_CANCELLED - iOS share sheet ditutup sebelum selesai.

Sumber Kebenaran

Halaman ini melacak plugin src/definitions.ts. Jalankan ulang sync saat API publik berubah di upstream.

Lanjutkan dari Getting Started

Jika Anda menggunakan Panduan Memulai untuk merencanakan penyimpanan dan penanganan file, hubungkan dengan Menggunakan @capgo/capacitor-file-sharer untuk kemampuan native di halaman 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 kapabilitas native di Menggunakan @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-file untuk detail implementasi di @capgo/capacitor-file, dan Menggunakan @capgo/capacitor-file untuk kapabilitas native di Using @capgo/capacitor-file.