Getting Started

Installieren

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

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

Dann verwenden Sie die folgende Anweisung:

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 folgen Sie den unten angegebenen plattform-spezifischen Anweisungen:

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

Ein lokales Datei teilen

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

Die nativen 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 neuer schreibt der Plugin über MediaStore. Bei Android 9 und darunter verwenden öffentliche Speicher die Manifest WRITE_EXTERNAL_STORAGE Erlaubnis mit maxSdkVersion=28.

Text mit Datei teilen

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

text wird als EXTRA_TEXT auf Android und als zweites Aktivitäts-Element auf iOS übergeben.

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 wurde nicht oder ist leer.
• ERR_PARAM_NO_DATA - weder base64Data noch path wurde nicht bereitgestellt.
• ERR_PARAM_DATA_INVALID - Die Basis64-Eingabe konnte nicht dekodiert werden.
• ERR_LOCAL_FILE_NOT_FOUND - Die bereitgestellte lokale Pfad oder Content-URI konnte nicht geöffnet werden.
• ERR_FILE_CACHING_FAILED - Der 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’s src/definitions.ts. Wiederholen Sie die Synchronisierung, wenn die öffentliche API upstream ändert.

Weitergehen von Getting Started

Wenn Sie GitHub verwenden Einstieg um Speicher und Dateihandling zu planen, verbinden Sie es mit Mit @capgo/capacitor-dateisharer für die native Fähigkeit in Mit @capgo/capacitor-dateisharer, @capgo/capacitor-datenspeicher-sqlite für die Implementierungsdetail in @capgo/capacitor-datenspeicher-sqlite, Mit @capgo/capacitor-datenspeicher-sqlite für die native Fähigkeit in Mit @capgo/capacitor-datenspeicher-sqlite, @capgo/capacitor-datei für die Implementierungsdetail in @capgo/capacitor-datei und Mit @capgo/capacitor-datei für die native Fähigkeit in Mit @capgo/capacitor-datei.