Anfahrt

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten Ihrem AI-Tool hinzu, indem Sie die folgende Befehlszeile verwenden:

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

Verwenden Sie dann die folgende Anfrage:

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

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

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

Importieren

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

Eine Base64-Datei teilen

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 es kann sich um eine Rohbase64-Zeichenfolge oder eine Daten-URL wie data:application/pdf;base64,....

Eine lokale Datei teilen

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

Die native Implementierungen akzeptieren lokale Pfade, file:// URLs, Android content:// URIs, und Capacitor _capacitor_file_ URLs.

Ein Datei speichern

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

console.log(result.uri);

Android-Speicherorte sind downloads, pictures, movies, music, und documents. Bei Android 10 und neueren Versionen schreibt der Plugin über MediaStore. Bei Android 9 und älteren Versionen verwenden öffentliche Speicherungen die Manifest WRITE_EXTERNAL_STORAGE Erlaubnis mit maxSdkVersion=28.

Ein Text teilen mit einer Datei

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

text als Parameter an Android und als zweites Aktivitäts-Element bei iOS übergeben. EXTRA_TEXT Erlaubnis mit

Typenverweis

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

Fehlercodes

• ERR_PARAM_NO_FILENAME - filename fehlt oder ist leer.
• ERR_PARAM_NO_DATA - weder base64Data oder path was bereitgestellt wurde.
• ERR_PARAM_DATA_INVALID - Die Basis64-Eingabe konnte nicht dekodiert werden.
• ERR_LOCAL_FILE_NOT_FOUND - Der bereitgestellte lokale Pfad oder die Inhalts-URI konnte nicht geöffnet werden.
• ERR_FILE_CACHING_FAILED - Die native temporäre Datei konnte nicht geschrieben werden.
• ERR_FILE_SAVE_FAILED - Android konnte das Datei in der öffentlichen Speicherung nicht speichern.
• ERR_ACTIVITY_NOT_FOUND - Android konnte ein Teilenziel nicht öffnen.
• USER_CANCELLED - Die iOS-Teilmenü wurde ohne Abschluss abgelehnt.

Quelle der Wahrheit

Diese Seite verfolgt die Plugin-Einstellungen src/definitions.tsRe-run the sync when the public API changes upstream.

Fortsetzung aus Getting Started

Wenn Sie Getting Started zum Planen von Speicher und Dateihandling verwenden, verbinden Sie es mit Mit @capgo/capacitor-file-sharer zur nativen Fähigkeit in Mit @capgo/capacitor-file-sharer, @capgo/capacitor-data-storage-sqlite zur Implementierungsdetails in @capgo/capacitor-data-storage-sqlite, Mit @capgo/capacitor-data-storage-sqlite zur nativen Fähigkeit in Mit @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-file für die Implementierungsdetails in @capgo/capacitor-Datei und Mit @capgo/capacitor-Datei für die native Fähigkeit in Mit @capgo/capacitor-Datei.