메뉴로 바로가기

@capgo/capacitor-업데이터

capacitor 앱을 위한 실시간 업데이트.

실시간으로 capacitor 앱을 업데이트합니다.

기본 기능

기본 기능
  • notifyAppReady - 자바스크립트가 성공적으로 초기화되었음을 네이티브层에 알립니다.
  • setUpdateUrl - 앱의 업데이트 URL을 런타임에 동적으로 설정합니다.
  • setStatsUrl - 앱의 통계 URL을 런타임에 동적으로 설정합니다.
  • setChannelUrl - 앱의 채널 URL을 런타임에 동적으로 설정합니다.
메서드설명
notifyAppReady자바스크립트가 성공적으로 초기화되었음을 네이티브層에 알립니다.
setUpdateUrl동적으로 앱 런타임에서 업데이트 URL을 설정하세요.
setStatsUrl동적으로 앱 런타임에서 통계 URL을 설정하세요.
setChannelUrl동적으로 앱 런타임에서 채널 URL을 설정하세요.
download앱 설치를 위해 나중에 다운로드할 새로운 번들을 제공된 URL에서 다운로드하세요.
next앱 배경화면 또는 재시작 시 다음으로 활성화될 번들을 설정하세요.
set현재 번들을 설정하고 앱을 즉시 다시 로드하세요.
delete로컬 스토리지에서 번들을 삭제하여 디스크 공간을 확보하세요.
setBundleError수동 업데이트 모드에서 번들을 실패/오류로 표시하세요.
list앱에 저장된 로컬로 다운로드한 모든 번들을 가져오세요.
reset앱을 알려진 좋은 번들로 초기화하세요.
current현재 활성화된 번들의 정보를 가져오세요.
reload수동으로 앱을 다시 로드하여 대기 중인 업데이트 적용하세요.
setMultiDelay업데이트가 적용되기 전에 충족해야 하는 조건을 설정합니다.
cancelDelay지연 업데이트를 취소하고 즉시 업데이트를 적용합니다.
getLatest최신 버전의 배포 버전을 확인하기 위해 업데이트서버를 확인합니다.
setChannel이 장치에 대한 특정 업데이트 채널 assignment을 런타임에 할당합니다.
unsetChannel장치의 채널 assignment을 제거하고 기본 채널로 돌아갑니다.
getChannel이 장치에 할당된 현재 채널을 가져옵니다.
listChannels이 장치가 자체 assignment을 위해 사용할 수 있는 모든 채널 목록을 가져옵니다.
setCustomId이 장치에 대한 커스텀 식별자를 설정합니다.
getBuiltinVersion빌트인 배포 버전 (원래 버전 shipped with native 앱)을 가져옵니다.
getDeviceId이 장치의 고유한, 개인 정보 보호를 위한 식별자를 가져옵니다.
getPluginVersionCapacitor Updater 플러그인 버전을 가져옵니다.
isAutoUpdateEnabled자동 업데이트가 현재 활성화되어 있는지 확인합니다.
removeAllListeners이 플러그인에 등록된 모든 이벤트 리스너를 제거합니다.
addListener앱에서 번들 다운로드 이벤트를 듣습니다. 다운로드가 시작되면, 다운로드 중에, 다운로드가 완료되면 발생합니다. 다운로드 중에 다운로드 퍼센트를 반환합니다.
addListener업데이트가 필요하지 않은 이벤트를 듣습니다. 앱이 시작될 때마다 강제로 체크하고 싶을 때 유용합니다.
addListener앱이 시작될 때마다 강제로 체크하고 싶을 때 유용한 업데이트가 필요한 이벤트를 듣습니다.
addListener다운로드 완료 이벤트를 듣습니다.
addListener백엔드에서 현재 앱과 호환되지 않는 업데이트로 표시된 경우 브레이킹 업데이트 이벤트를 듣습니다. 레거시 majorAvailable 리스너와 동일한 페이로드를 내뱉습니다.
addListener앱에서 메이저 업데이트가 차단된 경우 메이저 업데이트 이벤트를 듣습니다.
addListener앱에서 업데이트가 실패한 경우 업데이트가 실패한 이벤트를 듣습니다. 앱이 다음으로 시작될 때 설치가 실패한 업데이트를 알려줍니다.
addListener앱에서 번들이 성공적으로 적용된 경우 이벤트를 듣습니다. 이 이벤트는 자바스크립트가 소비되기 전까지 원래대로 유지되므로 앱이 다시 로드되기 전에 리스너가 연결되지 않은 경우 마지막으로 대기 중인 set 이벤트가 리스너가 연결된 후에 전달됩니다.
addListener앱에서 번들이 다음으로 설치될 번들을 큐로 설정된 경우 이벤트를 듣습니다.
addListener__CAPGO_KEEP_0__ 이벤트를 App에서 감지하여, 다운로드 실패 시 알려줍니다.
addListener__CAPGO_KEEP_0__ 이벤트를 App에서 감지하여, 리로드가 발생했을 때 알려줍니다.
addListenerApp이 사용할 준비가 되었을 때 App에서 __CAPGO_KEEP_0__ 이벤트를 감지하여 알려줍니다. 이 이벤트는 자바스크립트가 소비하기 전까지 네이티브로 보존되므로, 리로드 후에도 리스너가 앱 시작 시에 나중에 첨부되어도 이벤트를 전달할 수 있습니다.
addListener__CAPGO_KEEP_0__ 이벤트를 감지하여, 채널 설정 시 기기 자체 할당이 허용되지 않는 채널 시 알려줍니다.
addListener__CAPGO_KEEP_0__ 이벤트를 감지하여, Android에서 유연한 업데이트 상태 변경을 알려줍니다.
isAutoUpdateAvailable자동 업데이트 기능이 사용 가능할지 여부를 확인합니다 (사용자 지정 서버 구성으로 비활성화되지 않았는지).
getNextBundle다음 리로드 시 활성화될 예정인 배포본에 대한 정보를 가져옵니다.
getFailedUpdate최근에 로드 실패한 배포본에 대한 정보를 가져옵니다.
setShakeMenu디버깅 및 테스트를 위해 shake 제스처 메뉴를 활성화/비활성화합니다.
isShakeMenuEnabledshake 제스처 디버그 메뉴가 현재 활성화되어 있는지 여부를 확인합니다.
setShakeChannelSelector런타임에 shake 채널 선택기를 활성화/비활성화합니다.
isShakeChannelSelectorEnabledshake 채널 선택기가 현재 활성화되어 있는지 여부를 확인합니다.
getAppId업데이트 서버 통신을 위한 현재 구성된 앱 ID를 가져옵니다.
setAppId업데이트 서버 통신을 위한 앱 ID를 동적으로 변경합니다.
getAppUpdateInfo앱 스토어 또는 플레이 스토어에서 앱의 가용성을 가져옵니다.
openAppStore앱의 페이지를 앱 스토어 또는 플레이 스토어에서 열어줍니다.
performImmediateUpdate안드로이드에서 즉시 앱 업데이트를 수행합니다.
startFlexibleUpdate안드로이드에서 유연한 앱 업데이트를 시작합니다.
completeFlexibleUpdate안드로이드에서 유연한 앱 업데이트를 완료합니다.

Source Of Truth

Source Of Truth

이 참조는 src/definitions.ts 에서 capacitor-업데이터.