Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrer KI-Tool mithilfe der folgenden Befehl hinzu:

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

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

Importieren

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

Eine Basis64-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 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.

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

Die Speicherorte für Android-Dateien sind downloads, pictures, movies, music, und documents. Bei Android 10 und neuer schreibt der Plugin über MediaStore. Bei Android 9 und darunter verwenden öffentliche Speicherungen die Manifest WRITE_EXTERNAL_STORAGE Erlaubnis mit maxSdkVersion=28.

Mit einer Datei teilen

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

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

Typenreferenz

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 noch path wurde nicht bereitgestellt.
• ERR_PARAM_DATA_INVALID – Die Basis64-Eingabe konnte nicht dekodiert werden.
• ERR_LOCAL_FILE_NOT_FOUND – Der bereitgestellte lokale Pfad oder die 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üliste wurde ohne Abschluss abgelehnt.

Quelle der Wahrheit

Diese Seite verfolgt die Plugin-Einstellungen src/definitions.tsRe-run die Synchronisierung, wenn die öffentliche API sich im Hintergrund ändert.

Fortsetzen Sie mit Getting Started

Wenn Sie Capgo verwenden planen, verbinden Sie es mit um Speicherplatz und Dateihandling zu planen, verbinden Sie es mit Verwendung von @capgo/capacitor-Dateisharer für die native Fähigkeit in Verwendung von @capgo/capacitor-Dateiteiler. @capgo/capacitor-Daten-Speicherung-SQLite für die Implementierungsdetails in @capgo/capacitor-data-storage-sqlite, Mit @capgo/capacitor-data-storage-sqlite für die native Fähigkeit in Mit @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-Datei für die Implementierungsdetails in @capgo/capacitor-file und Mit @capgo/capacitor-file für die native Fähigkeit in Mit @capgo/capacitor-file.