Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie den Capgo-Fähigkeiten Ihrer AI-Werkzeugleiste hinzu, indem Sie den folgenden Befehl ausführen:

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

Verwenden Sie dann den folgenden Vorschlag:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-file` 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
bunx cap sync

Importieren

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

API-Übersicht

requestFileSystem

Einen Dateisystemantrag stellen.

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

await CapacitorFile.requestFileSystem({} as RequestFileSystemOptions);

resolveLocalFileSystemURL

Eine Datei-URL auf einen Eintrag auflösen.

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

await CapacitorFile.resolveLocalFileSystemURL({} as ResolveURLOptions);

getFile

Einen Dateieintrag erhalten.

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

await CapacitorFile.getFile({} as GetFileOptions);

getDirectory

Einen Verzeichniseintrag erhalten.

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

await CapacitorFile.getDirectory({} as GetDirectoryOptions);

readFile

Ein Datei als Text oder Base64 lesen.

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

await CapacitorFile.readFile({} as ReadFileOptions);

readAsDataURL

Eine Datei als Daten-URL (Base64 mit MIME-Typ-Präfix) lesen.

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

await CapacitorFile.readAsDataURL({} as ReadFileOptions);

writeFile

Daten in eine Datei schreiben.

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

await CapacitorFile.writeFile({} as WriteFileOptions);

appendFile

Daten einer Datei anhängen.

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

await CapacitorFile.appendFile({} as WriteFileOptions);

deleteFile

Ein Datei löschen.

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

await CapacitorFile.deleteFile({} as DeleteFileOptions);

mkdir

Eine Verzeichnis erstellen.

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

await CapacitorFile.mkdir({} as MkdirOptions);

rmdir

Ein Verzeichnis löschen.

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

await CapacitorFile.rmdir({} as DeleteDirectoryOptions);

readdir

Inhalte des Verzeichnisses lesen.

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

await CapacitorFile.readdir({} as ReaddirOptions);

stat

Ermitteln Sie Informationen über ein Datei- oder Verzeichnissystem.

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

await CapacitorFile.stat({} as StatOptions);

getMetadata

Ermitteln Sie Informationen über ein Datei- oder Verzeichnissystem. Alias für stat().

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

await CapacitorFile.getMetadata({} as StatOptions);

rename

Umbenennen oder verschieben Sie eine Datei oder ein Verzeichnis.

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

await CapacitorFile.rename({} as RenameOptions);

move

Verschieben Sie eine Datei oder ein Verzeichnis. Alias für rename().

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

await CapacitorFile.move({} as RenameOptions);

copy

Einen Datei- oder Verzeichniscopy durchführen.

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

await CapacitorFile.copy({} as CopyOptions);

exists

Überprüfen, ob eine Datei oder ein Verzeichnis existiert.

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

await CapacitorFile.exists({} as ExistsOptions);

getUri

Ermitteln Sie die URI für eine Datei.

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

await CapacitorFile.getUri({} as GetUriOptions);

truncate

Eine Datei auf eine bestimmte Größe trancieren.

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

await CapacitorFile.truncate({} as TruncateOptions);

getDirectories

Alle bekannten Dateisystemverzeichnisse abrufen.

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

await CapacitorFile.getDirectories();

getFreeDiskSpace

Die verfügbare Festplattenplatzgröße in Bytes abrufen.

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

await CapacitorFile.getFreeDiskSpace();

checkPermissions

Überprüfen Sie den aktuellen Berechtigungsstatus für Dateibearbeitungen. Bei Android-Systemen überprüft dies die externen Speicherberechtigungen. Bei iOS- und Web-Systemen wird immer ‘erlaubt’ zurückgegeben, da keine besonderen Berechtigungen erforderlich sind.

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

await CapacitorFile.checkPermissions();

requestPermissions

Berechtigungen für Dateibearbeitungen anfordern. Bei Android-Systemen werden die externen Speicherberechtigungen erforderlich, um Daten außerhalb der privaten Verzeichnisse des Apps zugreifen zu können. Bei iOS- und Web-Systemen wird immer ‘erlaubt’ zurückgegeben, da keine besonderen Berechtigungen erforderlich sind.

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

await CapacitorFile.requestPermissions();

Typenreferenz

RequestFileSystemOptions

Optionen für die Anforderung eines Dateisystems.

export interface RequestFileSystemOptions {
  /** The type of file system to request */
  type: FileSystemType;
  /** Requested size in bytes (may not be enforced on all platforms) */
  size?: number;
}

FileSystem

Darstellt ein Dateisystem.

export interface FileSystem {
  /** The name of the file system */
  name: string;
  /** The root directory of the file system */
  root: DirectoryEntry;
}

ResolveURLOptions

Optionen für die Auflösung einer URL zu einem Eintrag.

export interface ResolveURLOptions {
  /** The URL to resolve (file:// or cdvfile://) */
  url: string;
}

Entry

Stellt einen Datei- oder Verzeichnis-Eintrag dar.

export interface Entry {
  /** True if this is a file */
  isFile: boolean;
  /** True if this is a directory */
  isDirectory: boolean;
  /** The name of the file or directory */
  name: string;
  /** The full path relative to the filesystem root */
  fullPath: string;
  /** The native file:// URI */
  nativeURL: string;
}

GetFileOptions

Optionen zum Abrufen einer Datei.

export interface GetFileOptions {
  /** Path to the file */
  path: string;
  /** Base directory */
  directory?: Directory;
  /** Options for creating the file */
  options?: GetOptions;
}

FileEntry

Stellt einen Datei-Eintrag dar.

export interface FileEntry extends Entry {
  isFile: true;
  isDirectory: false;
}

GetDirectoryOptions

Optionen zum Abrufen eines Verzeichnisses.

export interface GetDirectoryOptions {
  /** Path to the directory */
  path: string;
  /** Base directory */
  directory?: Directory;
  /** Options for creating the directory */
  options?: GetOptions;
}

DirectoryEntry

Stellt einen Verzeichniseintrag dar.

export interface DirectoryEntry extends Entry {
  isFile: false;
  isDirectory: true;
}

ReadFileOptions

Optionen für das Lesen eines Dateisystems.

export interface ReadFileOptions {
  /** Path to the file */
  path: string;
  /** Base directory */
  directory?: Directory;
  /** Encoding for text files (omit for binary/base64) */
  encoding?: Encoding;
  /** Byte offset to start reading from (default: 0) */
  offset?: number;
  /** Number of bytes to read (default: read to end of file) */
  length?: number;
}

ReadFileResult

Erfolg des Lesens eines Dateisystems.

export interface ReadFileResult {
  /** File contents as string (text) or base64 (binary) */
  data: string;
}

WriteFileOptions

Optionen für das Schreiben eines Dateisystems.

export interface WriteFileOptions {
  /** Path to the file */
  path: string;
  /** Base directory */
  directory?: Directory;
  /** Data to write (string for text, base64 for binary) */
  data: string;
  /** Encoding for text files */
  encoding?: Encoding;
  /** If true, append to existing file instead of overwriting */
  append?: boolean;
  /** Create intermediate directories if they don't exist */
  recursive?: boolean;
  /** Byte position to start writing at (for random access writes). If not specified, writes from beginning or appends based on 'append' flag */
  position?: number;
}

WriteFileResult

Ergebnis der Dateischreibaufgabe

export interface WriteFileResult {
  /** The URI of the written file */
  uri: string;
}

Hauptquelle

Diese Seite wird aus dem Plugin generiert. Wenn sich die öffentliche __CAPGO_KEEP_0__ im Hintergrund ändert, führen Sie die Synchronisation erneut durch. src/definitions.ts. Re-run the sync when the public API changes upstream.

Abschnitt mit dem Titel “Fortsetzung von Getting Started”

Getting Started planen, verbinden Sie es mit Getting Started Mit @capgo/capacitor-Datei für die native Fähigkeit in Mit @capgo/capacitor-Datei @capgo/capacitor-Daten-Speicher-SQLite für die Implementierungsdetails in @capgo/capacitor-Daten-Speicher-SQLite Mit @capgo/capacitor-Daten-Speicher-SQLite für die native Fähigkeit in Mit @capgo/capacitor-Daten-Speicher-SQLite @capgo/capacitor-Datei für die Implementierungsdetails in @capgo/capacitor-Datei und @capgo/capacitor-Uploader für die Implementierungsdetails in @capgo/capacitor-Uploader.