개요
“개요” 섹션파일과 디렉터리를 읽고, 쓰고, 관리하는 모든 기능을 갖춘 파일 시스템 플러그인
다음으로 시작하세요 requestFileSystem() 그리고 아래에 나열된 다른 핵심 메서드도 살펴보세요.
플랫폼 지원
“플랫폼 지원” 섹션| 플랫폼 | 지원 | 참고 사항 |
|---|---|---|
| iOS | 지원 | 네이티브 |
| Android | 지원 | 네이티브 |
| 웹 | 지원 | 브라우저 스토리지 API |
핵심 기능
“핵심 기능” 섹션requestFileSystem- 파일 시스템 요청resolveLocalFileSystemURL- 파일 URL을 엔트리로 변환getFile- 파일 엔트리 가져오기getDirectory- 디렉터리 엔트리를 가져옵니다.
공개 API
“Public API” 섹션| 메서드 | 설명 |
|---|---|
requestFileSystem | 파일 시스템 요청 |
resolveLocalFileSystemURL | 파일 URL을 엔트리로 해석 |
getFile | 파일 엔트리 가져오기 |
getDirectory | 디렉토리 엔트리 가져오기 |
readFile | 파일을 텍스트 또는 base64로 읽기 |
readAsDataURL | 파일을 data URL(MIME 타입 접두사가 포함된 base64)로 읽기 |
writeFile | 파일에 데이터 쓰기 |
appendFile | 파일에 데이터를 추가합니다. |
deleteFile | 파일을 삭제합니다. |
mkdir | 디렉토리를 생성합니다. |
rmdir | 디렉토리를 삭제합니다. |
readdir | 디렉토리 내용을 읽습니다. |
stat | 파일 또는 디렉토리의 메타데이터를 가져옵니다. |
getMetadata | 파일 또는 디렉토리의 메타데이터를 가져옵니다. stat()의 별칭입니다. |
rename | 파일 또는 디렉토리의 이름을 변경하거나 이동합니다. |
move | 파일 또는 디렉토리를 이동합니다. rename()의 별칭입니다. |
copy | 파일 또는 디렉토리를 복사합니다. |
exists | 파일 또는 디렉토리가 존재하는지 확인합니다. |
getUri | 파일의 URI를 가져옵니다. |
truncate | 파일을 지정된 크기로 자릅니다. |
getDirectories | 알려진 모든 파일 시스템 디렉토리를 가져옵니다. |
getFreeDiskSpace | 사용 가능한 디스크 공간을 바이트 단위로 가져옵니다. |
addListener | 읽기 진행 상태 이벤트를 수신합니다. |
addListener | 쓰기 진행 상태 이벤트를 수신합니다. |
removeAllListeners | 모든 이벤트 리스너를 제거합니다. |
getPluginVersion | 플러그인 버전을 가져옵니다. |
checkPermissions | 파일 작업에 대한 현재 권한 상태를 확인합니다. Android에서는 외부 저장소 권한을 확인하며, iOS 및 웹에서는 별도의 권한이 필요하지 않으므로 항상 ‘granted’를 반환합니다. |
requestPermissions | 파일 작업 권한을 요청합니다. Android에서는 앱의 프라이빗 디렉토리 외부 파일에 접근하기 위한 외부 저장소 권한을 요청합니다. iOS 및 웹에서는 별도의 권한이 필요하지 않으므로 항상 ‘granted’를 반환합니다. |
참조 값
“참조 값” 섹션저장 위치를 선택하거나, 인코딩된 텍스트를 쓰거나, 파일 에러를 처리할 때 이 값들을 사용하세요.
디렉토리
“디렉토리” 섹션| 값 | 사용자는 다음을 확인할 수 있습니다: |
|---|---|
DOCUMENTS | 사용자에게 표시되는 영구 문서입니다. Android에서는 앱 파일 디렉토리에 매핑됩니다. |
DATA | 앱 전용 영구 데이터입니다. |
LIBRARY | 사용자에게 보이지 않는 영구 앱 데이터입니다. Android에서는 앱 파일 디렉토리에 매핑됩니다. |
CACHE | OS가 삭제할 수 있는 임시 캐시 데이터입니다. |
EXTERNAL | SD 카드나 공유 외부 저장소와 같은 Android 외부 저장소 루트입니다. |
EXTERNAL_STORAGE | Android 외부 저장소 데이터 디렉토리입니다. |
APPLICATION | 읽기 전용 애플리케이션 번들 또는 에셋 디렉토리입니다. |
인코딩
“인코딩” 섹션| 값 | 사용 |
|---|---|
utf8 | UTF-8 텍스트. |
ascii | ASCII 텍스트. |
utf16 | UTF-16 텍스트. |
파일 에러 코드
“파일 에러 코드” 섹션| 값 | Code | 의미 |
|---|---|---|
NOT_FOUND_ERR | 1 | 파일 또는 디렉토리를 찾을 수 없습니다. |
SECURITY_ERR | 2 | 보안 규칙 또는 권한 문제로 작업이 차단되었습니다. |
ABORT_ERR | 3 | 작업이 중단되었습니다. |
NOT_READABLE_ERR | 4 | 파일 또는 디렉토리를 읽을 수 없습니다. |
ENCODING_ERR | 5 | 인코딩이 유효하지 않거나 지원되지 않습니다. |
NO_MODIFICATION_ALLOWED_ERR | 6 | 대상을 수정할 수 없습니다. |
INVALID_STATE_ERR | 7 | 현재 상태에서는 해당 작업을 수행할 수 없습니다. |
SYNTAX_ERR | 8 | 경로 또는 입력 구문이 유효하지 않습니다. |
INVALID_MODIFICATION_ERR | 9 | 대상에 적용할 수 없는 변경 사항입니다. |
QUOTA_EXCEEDED_ERR | 10 | 저장 용량을 초과했습니다. |
TYPE_MISMATCH_ERR | 11 | 값 타입이 예상 타입과 일치하지 않습니다. |
PATH_EXISTS_ERR | 12 | 대상 경로가 이미 존재합니다. |
Source of Truth
“Source Of Truth” 섹션이 레퍼런스는 다음에서 동기화됩니다. src/definitions.ts 에서 capacitor-file.
@capgo/capacitor-file에서 계속하기
“@capgo/capacitor-file에서 계속하기” 섹션사용 중이라면 @capgo/capacitor-file 저장 공간과 파일 처리를 계획하려면, 다음 항목과 연결하세요 @capgo/capacitor-file 사용하기 @capgo/capacitor-file 사용 시 네이티브 기능은 @capgo/capacitor-data-storage-sqlite @capgo/capacitor-data-storage-sqlite의 구현 세부 사항은, @capgo/capacitor-data-storage-sqlite 사용하기 @capgo/capacitor-data-storage-sqlite 사용 시 네이티브 기능을 위해, @capgo/capacitor-uploader @capgo/capacitor-uploader의 구현 세부 사항은, 그리고 @capgo/capacitor-uploader 사용하기 @capgo/capacitor-uploader. 사용 시 네이티브 기능은
