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.

설치

AI 도움을 받아 플러그인을 설치할 수 있습니다. AI 도구에 Capgo 스킬을 추가하려면 다음 명령어를 사용하세요:

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

__CAPGO_KEEP_1__

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-file-sharer` plugin in my project.

__CAPGO_KEEP_2__

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

__CAPGO_KEEP_3__

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 __CAPGO_KEEP_0__은 base64로 인코딩된 문자열 또는 데이터 URL 형식인 data:application/pdf;base64,....

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

자체 구현은 지역 경로, 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 이하에서는 public saves는 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 is passed as EXTRA_TEXT on Android와 iOS에서 두 번째 액티비티 아이템으로 전달됩니다.

Type Reference

`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 입력이 누락되거나 빈 값입니다.
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 - 안드로이드가 공공 저장소에 파일을 저장할 수 없습니다.
ERR_ACTIVITY_NOT_FOUND - 안드로이드가 공유 목표를 열 수 없습니다.
USER_CANCELLED - iOS 공유 시트가 완료되지 않고 닫혔습니다.

진실의 근원

이 페이지는 플러그인의 src/definitions.ts Re-run the sync when the public API changes upstream.

Getting Started에서 계속하기

이미 사용 중이라면 Getting Started __CAPGO_KEEP_0__과 __CAPGO_KEEP_1__을 연결하여 저장 및 파일 처리를 계획하세요. Using @capgo/capacitor-file-sharer capgo/capacitor-file-sharer의 원시 기능을 위해 @capgo/capacitor-data-storage-sqlite capgo/capacitor-data-storage-sqlite의 구현 세부 사항을 위해 Using @capgo/capacitor-data-storage-sqlite capgo/capacitor-data-storage-sqlite의 원시 기능을 위해 @capgo/capacitor-file capgo/capacitor-file의 구현 세부 사항을 위해, Using @capgo/capacitor-file capgo/capacitor-file의 원시 기능을 위해.

Getting Started

설치

__CAPGO_KEEP_3__

__CAPGO_KEEP_0__

지역 파일 공유

파일 저장

Share Text With A File