시작하기

설치

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

Import

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

Base64 파일 공유

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 Base64 문자열 또는 데이터 URL data:application/pdf;base64,....

지역 파일 공유

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

The native implementations accept local paths, file:// URLs, Android content:// URIs, and Capacitor _capacitor_file_ URLs.

파일을 저장하기

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 save directories are downloads, pictures, movies, music, and documents. Android 10 이상에서는 MediaStore를 통해 데이터를 기록합니다. Android 9 이하에서는 manifest를 사용합니다. WRITE_EXTERNAL_STORAGE 권한이 전달됩니다. maxSdkVersion=28.

파일과 함께 텍스트 공유

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

text __CAPGO_KEEP_0__이 Android에서 및 iOS에서 두 번째 액티비티 아이템으로 전달됩니다. EXTRA_TEXT 타입 참조

타입 참조 제목

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

오류 코드

• ERR_PARAM_NO_FILENAME - filename __CAPGO_KEEP_0__이 누락되거나 비어 있습니다.
• ERR_PARAM_NO_DATA __CAPGO_KEEP_0__이 제공되지 않았습니다. base64Data __CAPGO_KEEP_0__이 제공되지 않았습니다. path __CAPGO_KEEP_0__을 base64 형식으로 변환할 수 없습니다.
• ERR_PARAM_DATA_INVALID __CAPGO_KEEP_0__ 또는 콘텐츠 URI를 열 수 없습니다.
• ERR_LOCAL_FILE_NOT_FOUND __CAPGO_KEEP_0__을 임시 파일로 작성할 수 없습니다.
• ERR_FILE_CACHING_FAILED __CAPGO_KEEP_0__을 공용 저장소에 저장할 수 없습니다.
• ERR_FILE_SAVE_FAILED 도 아니고도 아니야.
• ERR_ACTIVITY_NOT_FOUND - 안드로이드는 공유 목표를 열 수 없습니다.
• USER_CANCELLED - iOS 공유 시트는 완료되지 않고 닫혔습니다.

진실의 근원

이 페이지는 플러그인의 src/definitions.ts. upstream에서 변경된 공개 API을 다시 동기화할 때입니다.