Getting Started

이 플러그인의 설치 단계와 전체 마크다운 가이드가 포함된 설정 프롬프트를 복사하세요.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-file-sharer`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/file-sharer/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

설치

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

수입

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

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

native implementation은 local path, file:// URL, Android content:// URI, 및 Capacitor _capacitor_file_ URL.

파일을 저장하기

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 저장 디렉토리는 downloads, pictures, movies, music, 및 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__으로 전달된다. EXTRA_TEXT __CAPGO_KEEP_0__은 안드로이드에서 및 iOS에서 두 번째 액티비티 아이템으로 전달된다.

타입 참조

`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 - 하나도 base64Data 도 path 는 제공되지 않았습니다.
ERR_PARAM_DATA_INVALID - base64 입력이 디코딩되지 못했습니다.
ERR_LOCAL_FILE_NOT_FOUND - 제공된 로컬 경로 또는 콘텐츠 URI가 열리지 못했습니다.
ERR_FILE_CACHING_FAILED - 네이티브 임시 파일이 작성되지 못했습니다.
ERR_FILE_SAVE_FAILED - Android가 공용 저장소에 파일을 저장하지 못했습니다.
ERR_ACTIVITY_NOT_FOUND - 안드로이드는 공유 목표를 열 수 없습니다.
USER_CANCELLED - iOS 공유 시트는 완료되지 않고 닫혔습니다.

Source Of Truth

이 페이지는 플러그인의 src/definitions.ts. 업스트림에서 pubic API이 변경되었을 때 다시 싱크를 실행하세요.

Getting Started에서 계속하기

Capacitor를 사용하는 경우 Getting Started 저장소와 파일 처리를 계획하고 싶다면 @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-file-sharer와 연결하세요. Using @capgo/capacitor-file-sharer capgo/capacitor-file-sharer의 내장 기능을 위해 capgo/capacitor-data-storage-sqlite capgo/capacitor-data-storage-sqlite의 구현 세부 사항을 위해 capgo/capacitor-data-storage-sqlite capgo/capacitor-data-storage-sqlite의 내장 기능을 위해 capgo/capacitor-file capgo/capacitor-file의 구현 세부 사항을 위해 capgo/capacitor-file capgo/capacitor-file의 내장 기능을 위해

Getting Started

설치

수입

Base64 파일 공유

Base64 파일 공유

파일을 저장하기

파일과 함께 텍스트 공유하기