기능 및 설정

__CAPGO_KEEP_11__

Github을 참조하십시오. README 더 많은 정보를 참조하십시오.

CapacitorUpdater는 다음 옵션으로 구성될 수 있습니다.

속성	형식	설명	기본값	Since
appReadyTimeout	number	Android, iOS, 및 Electron에서 native 플러그인이 업데이트를 ‘실패’로 간주하기 전에 기다리는 밀리초 수를 구성합니다.	10000 // (10 seconds)
responseTimeout	number	Android, iOS, 및 Electron에서 native 플러그인이 API 시간 초과를 간주하기 전에 기다리는 밀리초 수를 구성합니다.	20000 // (20 seconds)
autoDeleteFailed	boolean	__CAPGO_KEEP_0__ 자동 삭제를 사용할지 여부를 설정합니다. Android, iOS, Electron에서 사용 가능합니다.	true
autoDeletePrevious	boolean	__CAPGO_KEEP_0__ 자동 삭제를 사용할지 여부를 설정합니다. Android, iOS, Electron에서 사용 가능합니다.	true
autoUpdate	boolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’	__CAPGO_KEEP_0__ 자동 업데이트를 사용할지 여부를 설정합니다. true는 'atBackground'과 동일하며, false는 'off'과 동일합니다. - off: 자동 업데이트를 비활성화합니다. - atBackground: 앱이 배경으로 이동할 때 자동으로 다운로드하고 적용합니다. - atInstall: 새로운 설치 또는 네이티브 앱 업데이트가 발생할 때 즉시 적용하고, 그렇지 않으면 atBackground을 사용합니다. - onLaunch: 앱이 시작될 때 즉시 적용하고, 그렇지 않으면 atBackground을 사용합니다. - always: 자동 업데이트가 실행될 때마다 즉시 적용합니다. - onlyDownload: 자동으로 다운로드하고, updateAvailable 이벤트를.emit하고, 다음 번들 자동으로 설정하지 않습니다. Android, iOS, Electron에서 사용 가능합니다.	”atBackground” // true is still accepted
resetWhenUpdate	boolean	__CAPGO_KEEP_0__ 기존 다운로드된 번들을 자동으로 삭제할지 여부를 설정합니다. Android, iOS, Electron에서 사용 가능합니다.	true
updateUrl	string	__CAPGO_KEEP_0__ 자동 업데이트를 사용할지 여부를 설정합니다. Android, iOS, Electron에서 사용 가능합니다.	https://plugin.capgo.app/updates
channelUrl	string	__CAPGO_KEEP_0__ 업데이트를 체크할 URL/엔드포인트를 설정합니다. Android, iOS, Electron에서 사용 가능합니다.	https://plugin.capgo.app/channel_self
statsUrl	string	__CAPGO_KEEP_0__ 채널 연산을 위한 URL/엔드포인트를 설정합니다. Android, iOS, Electron에서 사용 가능합니다.	https://plugin.capgo.app/stats
publicKey	string	__CAPGO_KEEP_0__을 사용하여 끝에서 끝으로 실시간 업데이트 암호화에 대한 공개 키를 구성합니다. 버전 2. 안드로이드, iOS, 그리고 Electron에서 사용할 수 있습니다.	undefined	6.2.0
version	string	code의 현재 버전을 구성합니다. 첫 번째 업데이트 요청을 위해 사용됩니다. 설정하지 않으면 플러그인은 네이티브 code에서 버전을 가져옵니다. 안드로이드, iOS, 그리고 Electron에서 사용할 수 있습니다.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	deprecated. “atInstall”, “onLaunch”, 또는 “always” 대신 autoUpdate 문자열 모드를 사용하십시오. 이 옵션은 기존 앱을 위해 지원되며 유지됩니다. - false: 직접 업데이트를 수행하지 않습니다. - atInstall: autoUpdate: “atInstall”와 동일합니다. - onLaunch: autoUpdate: “onLaunch”와 동일합니다. - always: autoUpdate: “always”와 동일합니다. - true: “always”와 동일합니다. backward compatibility를 위해 유지됩니다. 안드로이드, iOS, 그리고 Electron에서 사용할 수 있습니다.	false	5.1.0
autoSplashscreen	boolean	자동으로 스플래시 화면을 숨기는 것을 처리할 수 있습니다. instant apply 모드 사용 시 활성화하면 업데이트가 적용되거나 업데이트가 필요하지 않으면 플러그인은 자동으로 스플래시 화면을 숨깁니다. 이로 인해 appReady 이벤트를 수신하고 SplashScreen.hide()를 호출하는 것을 수동으로 처리할 필요가 없습니다. autoUpdate가 “atInstall”, “onLaunch”, 또는 “always”로 설정된 경우에만 작동합니다. legacy directUpdate 값은 backward compatibility를 위해 유지됩니다. @capacitor/splash-screen 플러그인이 설치되고 launchAutoHide: false로 구성된 경우에만 작동합니다. Auto Update가 활성화된 경우에만 작동합니다. 안드로이드와 iOS에서 사용할 수 있습니다.	false	7.6.0
periodCheckDelay	number	__CAPGO_KEEP_0__를 사용하여 기간 업데이트를 확인하는 지연 시간을 구성합니다. 단위는 초입니다. 600 초 (10분)보다 작을 수 없습니다. 안드로이드, iOS, 그리고 Electron에서 사용할 수 있습니다.	600 // (10 minutes)
localS3	boolean	CLI을 사용하여 로컬 서버를 테스트하거나 자체 호스팅된 업데이트 서버를 구성하십시오.	undefined	4.17.48
localHost	string	CLI을 사용하여 로컬 서버를 테스트하거나 자체 호스팅된 업데이트 서버를 구성하십시오.	undefined	4.17.48
localWebHost	string	CLI을 사용하여 로컬 서버를 테스트하거나 자체 호스팅된 업데이트 서버를 구성하십시오.	undefined	4.17.48
localSupa	string	CLI을 사용하여 로컬 서버를 테스트하거나 자체 호스팅된 업데이트 서버를 구성하십시오.	undefined	4.17.48
localSupaAnon	string	CLI을 사용하여 로컬 서버를 테스트하십시오.	undefined	4.17.48
localApi	string	CLI을 사용하여 로컬 api를 테스트하십시오.	undefined	6.3.3
localApiFiles	string	CLI을 사용하여 로컬 파일 api를 테스트하십시오.	undefined	6.3.3
allowModifyUrl	boolean	플러그인을 사용하여 JavaScript에서 동적으로 업데이트 URL, 통계 URL 및 채널 URL을 수정할 수 있도록 허용하십시오.	false	5.4.0
defaultChannel	string	앱의 기본 채널을 config에서 설정하십시오. 대/소문자 구분합니다. 이 설정은 클라우드에서 설정한 기본 채널을 덮어씁니다. 그러나 클라우드에서 설정한 채널을 존중합니다.	undefined	5.5.0
appId	string	앱의 ID를 config에서 설정하십시오.	undefined	6.0.0
keepUrlPathAfterReload	boolean	플러그인을 사용하여 URL 경로를 다시 로드 후 유지하십시오. 경고: 다시 로드가 트리거되면 ‘window.history’가 지워집니다.	false	6.8.0
disableJSLogging	boolean	플러그인 JavaScript 로깅을 비활성화하십시오. true로 설정하면 플러그인은 JavaScript 콘솔에 로그를 출력하지 않습니다. Native 로그만 수행됩니다.	false	7.3.0
shakeMenu	boolean	업데이트 메뉴를 디버깅/테스트 목적으로 보여주기 위해 흔들기 동작을 활성화하세요.	false	7.5.0

예시

내 capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000 // (1 second),
      "responseTimeout": 10 // (10 second),
      "autoDeleteFailed": false,
      "autoDeletePrevious": false,
      "autoUpdate": "onlyDownload",
      "resetWhenUpdate": false,
      "updateUrl": https://example.com/api/auto_update,
      "channelUrl": https://example.com/api/channel,
      "statsUrl": https://example.com/api/stats,
      "publicKey": undefined,
      "version": undefined,
      "directUpdate": undefined,
      "autoSplashscreen": undefined,
      "periodCheckDelay": undefined,
      "localS3": undefined,
      "localHost": undefined,
      "localWebHost": undefined,
      "localSupa": undefined,
      "localSupaAnon": undefined,
      "localApi": undefined,
      "localApiFiles": undefined,
      "allowModifyUrl": undefined,
      "defaultChannel": undefined,
      "appId": undefined,
      "keepUrlPathAfterReload": undefined,
      "disableJSLogging": undefined,
      "shakeMenu": undefined
    }
  }
}

내 capacitor.config.ts:

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      appReadyTimeout: 1000 // (1 second),
      responseTimeout: 10 // (10 second),
      autoDeleteFailed: false,
      autoDeletePrevious: false,
      autoUpdate: 'onlyDownload',
      resetWhenUpdate: false,
      updateUrl: https://example.com/api/auto_update,
      channelUrl: https://example.com/api/channel,
      statsUrl: https://example.com/api/stats,
      publicKey: undefined,
      version: undefined,
      directUpdate: undefined,
      autoSplashscreen: undefined,
      periodCheckDelay: undefined,
      localS3: undefined,
      localHost: undefined,
      localWebHost: undefined,
      localSupa: undefined,
      localSupaAnon: undefined,
      localApi: undefined,
      localApiFiles: undefined,
      allowModifyUrl: undefined,
      defaultChannel: undefined,
      appId: undefined,
      keepUrlPathAfterReload: undefined,
      disableJSLogging: undefined,
      shakeMenu: undefined,
    },
  },
};

export default config;

• notifyAppReady()
• setUpdateUrl(...)
• setStatsUrl(...)
• setChannelUrl(...)
• download(...)
• next(...)
• set(...)
• delete(...)
• list(...)
• reset(...)
• current()
• reload()
• setMultiDelay(...)
• cancelDelay()
• getLatest(...)
• setChannel(...)
• unsetChannel(...)
• getChannel()
• listChannels()
• setCustomId(...)
• getBuiltinVersion()
• getDeviceId()
• getPluginVersion()
• isAutoUpdateEnabled()
• removeAllListeners()
• addListener('download', ...)
• addListener('noNeedUpdate', ...)
• addListener('updateAvailable', ...)
• addListener('downloadComplete', ...)
• addListener('majorAvailable', ...)
• addListener('updateFailed', ...)
• addListener('downloadFailed', ...)
• addListener('appReloaded', ...)
• addListener('appReady', ...)
• isAutoUpdateAvailable()
• getNextBundle()
• setShakeMenu(...)
• isShakeMenuEnabled()
• 인터페이스
• 타입 별칭

메소드

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

현재 번들을 실행중인 Capacitor 업데이터에게 알림을 보냅니다. (이 메서드가 앱 런치에 호출되지 않으면 롤백이 발생합니다.) 기본적으로 이 메서드는 앱 런치 후 10초 안에 호출되어야 합니다. 그렇지 않으면 롤백이 발생합니다. 이 동작을 변경하려면 {@link appReadyTimeout}을 참조하세요.

반환: Promise<AppReadyResult>

---

setUpdateUrl(…)

setUpdateUrl(options: UpdateUrl) => Promise<void>

앱의 업데이트 URL을 설정합니다. 이 URL은 업데이트 확인을 위해 사용됩니다.

파라미터	타입	설명
options	UpdateUrl	업데이트 확인을 위해 사용할 URL을 포함합니다.

Since: __CAPGO_KEEP_0__ 5.4.0

---

setStatsUrl(…)

setStatsUrl(options: StatsUrl) => Promise<void>

앱에 statsUrl을 설정합니다. statistics 수집을 비활성화하려면 빈 문자열을 전달합니다.

Param	Type	설명
options	StatsUrl	statistics를 전송하기 위한 URL을 포함합니다.

Since: __CAPGO_KEEP_0__ 5.4.0

---

setChannelUrl(…)를 위한 섹션

setChannelUrl(options: ChannelUrl) => Promise<void>

__CAPGO_KEEP_1__

__CAPGO_KEEP_2__	__CAPGO_KEEP_3__	__CAPGO_KEEP_4__
options	ChannelUrl	__CAPGO_KEEP_5__

__CAPGO_KEEP_6__ 5.4.0

---

__CAPGO_KEEP_7__

download(options: DownloadOptions) => Promise<BundleInfo>

__CAPGO_KEEP_10__

__CAPGO_KEEP_11__	타입	설명
options	DownloadOptions	The {@link 다운로드 옵션}으로 새로운 배ंडल zip을 다운로드합니다.

반환값: Promise<BundleInfo>

---

next(…)

next(options: BundleId) => Promise<BundleInfo>

앱이 다시 로드될 때 사용할 다음 배ंडल을 설정합니다.

파라미터	타입	설명
options	BundleId	다음 앱 실행 시 설정할 다음 Bundle의 ID를 포함합니다. {@link BundleInfo.id}

반환값 Promise<BundleInfo>

---

set(…)

set(options: BundleId) => Promise<void>

현재 Bundle을 설정하고 즉시 앱을 다시 로드합니다.

매개 변수	타입	설명
options	BundleId	A {@link BundleId{targetLanguage} object containing the new bundle id to set as current.

---

delete(…)

delete(options: BundleId) => Promise<void>

Bundle ID를 native 앱 저장소에서 삭제합니다. {@link list}를 사용하여 저장된 Bundle ID 목록을 가져올 수 있습니다.

Param	Type	설명
options	BundleId	Bundle ID를 삭제할 때 사용하는 {@link BundleId} object BundleId{targetLanguage} object containing the ID of a bundle to delete (note, this is the bundle id, NOT the version name)

---

목록(…)

list(options?: ListOptions | undefined) => Promise<BundleListResult>

앱 내에서 다운로드 한 모든 패키지를 가져옵니다

파라미터	타입	설명
options	ListOptions	패키지 목록을 나열하기 위한 {@link ListOptions} 반환:reset(…)

리스트 옵션 Promise<BundleListResult>

---

리스트 옵션

reset(options?: ResetOptions | undefined) => Promise<void>

앱을 builtin 배포본 (애플 앱 스토어 / 구글 플레이 스토어로 보내진 것) 또는 마지막으로 성공적으로 로드된 배포본으로 초기화합니다.

Param	Type	설명
options	ResetOptions	Containing {@link ResetOptions.toLastSuccessful}, true builtin 배포본으로 초기화하고 false 마지막으로 성공적으로 로드된 배포본으로 초기화합니다.

---

current()

current() => Promise<CurrentBundleResult>

현재 설정된 번들을 반환합니다. 설정된 번들이 없으면 builtin. currentNative는 기기에서 설치된 원래 번들을 의미합니다.

반환값: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

setMultiDelay(…)

---

복사

setMultiDelay(options: MultiDelayConditions) => Promise<void>

Sets a {@link DelayCondition} array containing conditions that the Plugin will use to delay the update. After all conditions are met, the update process will run start again as usual, so update will be installed after a backgrounding or killing the app. For the date kind, the value should be an iso8601 date string. For the background kind, the value should be a number in milliseconds. For the nativeVersion kind, the value should be the version number. For the kill kind, the value is not used. The function has inconsistent behavior the option kill do trigger the update after the first kill and not after the next background like other options. This will be fixed in a future major release.

Param	Type	Description
options	MultiDelayConditions	Containing the {@link MultiDelayConditions}array of conditions을 설정하는 조건을 배열로

Since: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

업데이트를 즉시 처리하기 위해 {@link DelayCondition}를 취소합니다.

Since: 4.0.0

---

getLatest(…)

getLatest(options?: GetLatestOptions | undefined) => Promise<LatestVersion>

__CAPGO_KEEP_0__ 최신 버전을 업데이트 URL에서 가져옵니다.

__CAPGO_KEEP_1__	__CAPGO_KEEP_2__
options	GetLatestOptions

__CAPGO_KEEP_3__ Promise<LatestVersion>

__CAPGO_KEEP_4__ 4.0.0

---

__CAPGO_KEEP_5__(…)

setChannel(options: SetChannelOptions) => Promise<ChannelRes>

__CAPGO_KEEP_7__를 복사합니다. allow_device_self_set __CAPGO_KEEP_8__를 위한 이 장치에 대한 채널을 설정합니다. 이 채널은

__CAPGO_KEEP_9__가 활성화되어야만 작동합니다.

• __CAPGO_KEEP_10__를 참고하세요:__CAPGO_KEEP_11__ 사용하지 마십시오. 부팅 시 이 메서드를 사용하여 채널을 설정하지 마십시오. __CAPGO_KEEP_12__를 사용하십시오. defaultChannel Capacitor 설정에서 대신합니다.
• 앱이 준비되었고 사용자가 상호작용 (예: 베타 프로그램에 가입) 한 후에 이 메서드를 사용하는 것을 목표로 합니다.
• 공개 채널은 자체 할당이 불가능합니다. 채널이 표시되면 public, 호출하면 오류가 반환됩니다. 공개 채널을 사용하려면 setChannel() 대신 호출하세요 - 장치가 자동으로 일치하는 공개 채널로 전환됩니다. unsetChannel() 를 사용하여 사용 가능한 채널을 발견하고 자체 할당을 허용하는지 여부를 확인하세요.
• Param listChannels() Type

설명	__CAPGO_KEEP_0__	__CAPGO_KEEP_0__
options	SetChannelOptions	는 {@link 설정 채널 옵션반환:

시작: Promise<ChannelRes>

unsetChannel(…) 4.7.0

---

제목 “unsetChannel(…)

unsetChannel(options: UnsetChannelOptions) => Promise<void>

공용 채널 이것은 다음 경우에 유용합니다: __CAPGO_KEEP_0__

__CAPGO_KEEP_1__

• __CAPGO_KEEP_0__을 기본 업데이트 트랙으로 되돌리려면
• __CAPGO_KEEP_0__을 공용 채널을 사용하려면 (공용 채널은 자체 할당이 불가능 하므로 setChannel())

Param	Type
options	UnsetChannelOptions

__CAPGO_KEEP_0__ 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

__CAPGO_KEEP_2__

__CAPGO_KEEP_0__ 이 기기의 채널을 가져옵니다 Promise<GetChannelRes>

Returns: 4.8.0

---

__CAPGO_KEEP_0__

listChannels() => Promise<ListChannelsResult>

이 장치에 사용 가능한 모든 채널 목록을 반환합니다. 장치의 현재 환경(플랫폼, 에뮬레이터/실제 장치, 개발/운영 빌드)에 호환되는 채널만 반환합니다. 또한 이 채널은 공개 채널이거나 자체 할당을 허용하는 채널입니다.

결과에 포함된 각 채널은 다음과 같습니다:

• public만약 true, 이 채널은 기본 채널입니다.자체 할당을 사용하여 setChannel()이 채널에 할당할 수 없습니다. 대신, 이 공개 채널에서 업데이트를 자동으로 받도록 장치가 할당을 제거하면 unsetChannel()만약
• allow_self_set, 이 채널은 true, this is a 자체 할당 채널. 이 채널에 장치를 명시적으로 할당할 수 있습니다. setChannel().

반환: Promise<ListChannelsResult>

Since: 7.5.0

---

setCustomId(…)

setCustomId(options: SetCustomIdOptions) => Promise<void>

이 장치에 사용자 지정 ID를 설정

Param	Type	설명
options	SetCustomIdOptions	는 {@link} __CAPGO_KEEP_0____CAPGO_KEEP_1__

__CAPGO_KEEP_2__ 4.9.0

---

__CAPGO_KEEP_3__

getBuiltinVersion() => Promise<BuiltinVersion>

__CAPGO_KEEP_6__

__CAPGO_KEEP_7__ Promise<BuiltinVersion>

__CAPGO_KEEP_8__ 5.2.0

---

__CAPGO_KEEP_9__

getDeviceId() => Promise<DeviceId>

기기 식별을 위해 사용되는 고유 ID를 가져옵니다 (자동 업데이트 서버로 전송)

반환: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Get the native Capacitor Updater plugin version (sent to auto update server)

반환: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

자동 업데이트 설정의 상태를 가져옵니다.

반환: Promise<AutoUpdateEnabled>

---

__CAPGO_KEEP_0__()

removeAllListeners() => Promise<void>

이 플러그인에 등록된 모든 리스너를 제거합니다.

버전: 1.0.0

---

__CAPGO_KEEP_3__(‘다운로드’, …)

addListener(eventName: 'download', listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>

__CAPGO_KEEP_4__

__CAPGO_KEEP_5__	__CAPGO_KEEP_6__
eventName	’download’
listenerFunc	(state: DownloadEvent) => void

__CAPGO_KEEP_7__ Promise<PluginListenerHandle>

Since: 2.0.11

---

addListener(‘noNeedUpdate’, …)

addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>

앱이 실행될 때마다 매번 업데이트 확인을 원할 때 유용한 no need to update 이벤트를 듣기

Param	Type
eventName	’noNeedUpdate’
listenerFunc	(state: NoNeedEvent) => void

Returns: Promise<PluginListenerHandle>

Since: 4.0.0

---

addListener(‘updateAvailable’, …)

addListener(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>

업데이트가 사용 가능한 이벤트를 듣기, 앱이 실행될 때마다 매번 체크하고 싶을 때 유용합니다.

Param	Type
eventName	’updateAvailable’
listenerFunc	(state: UpdateAvailableEvent) => void

Returns: Promise<PluginListenerHandle>

Since: 4.0.0

---

addListener(‘downloadComplete’, …)

addListener(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>

업로드 완료 이벤트를 듣기.

Param	Type
eventName	’downloadComplete’
listenerFunc	(state: DownloadCompleteEvent) => void

Returns: Promise<PluginListenerHandle>

Since: 4.0.0

---

addListener(‘majorAvailable’, …)

addListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>

앱에서 메이저 업데이트를 감지하고, disableAutoUpdateBreaking을 설정하여 업데이트가 중단되었을 때 알림을 받을 수 있습니다.

Param	Type
eventName	’majorAvailable’
listenerFunc	(state: MajorAvailableEvent) => void

Returns: Promise<PluginListenerHandle>

Since: 2.3.0

---

addListener(‘updateFailed’, …)

addListener(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>

업데이트 실패 이벤트를 앱에서 듣기, 다음 앱 시작 시 업데이트가 설치되지 않은 경우 알림을 받습니다.

Param	Type
eventName	’updateFailed’
listenerFunc	(state: UpdateFailedEvent) => void

Returns: Promise<PluginListenerHandle>

Since: 2.3.0

---

addListener('downloadFailed', ...)

addListener(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>

다운로드 실패 이벤트를 앱에서 듣기, 배포 다운로드가 실패한 경우 알림을 받습니다.

Param	Type
eventName	’downloadFailed’
listenerFunc	(state: DownloadFailedEvent) => void

Returns: Promise<PluginListenerHandle>

Since: 4.0.0

---

addListener(‘appReloaded’, …)

addListener(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>

앱이 리로드되면 알림을 받을 수 있습니다.

Param	Type
eventName	’appReloaded’
listenerFunc	() => void

Returns: Promise<PluginListenerHandle>

Since: 4.3.0

---

addListener(‘appReady’, …)

addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>

앱이 준비되면 앱이 사용할 준비가 되었는지 알려주는 이벤트를 듣습니다.

Param	Type
eventName	’appReady’
listenerFunc	(state: AppReadyEvent) => void

Returns: Promise<PluginListenerHandle>

Since: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

자동 업데이트가 사용할 수 있는지 여부를 확인합니다. (서버 URL로 인해 비활성화되지 않았습니다).

Returns: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

앱이 다시 로드 될 때 사용할 다음 번들을 가져옵니다. 다음 번들이 설정되지 않은 경우 null을 반환합니다.

반환: Promise<BundleInfo | null>

Since: 6.8.0

---

setShakeMenu(…)

setShakeMenu(options: SetShakeMenuOptions) => Promise<void>

개발/테스트 목적으로 shake 메뉴를 활성화/비활성화할 수 있습니다.

Param	Type	설명
options	SetShakeMenuOptions	활성화/비활성화 여부를 포함합니다.

Since: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

움직임 메뉴의 현재 상태를 가져옵니다.

반환: Promise<ShakeMenuEnabled>

Since: 7.5.0

---

인터페이스

AppReadyResult

속성	타입
bundle	BundleInfo

번들 정보

속성	타입
id	string
version	string
downloaded	string
checksum	string
status	BundleStatus

업데이트 URL

속성	타입
url	string

통계 URL

속성	타입
url	string

__CAPGO_KEEP_0__

속성	타입
url	string

다운로드 옵션

서버에서 패키지를 다운로드하기 위해 사용하는 URL 및 버전입니다. 백엔드 사용 시, 모든 정보는 getLatest 메서드를 통해 제공됩니다. 백엔드 사용하지 않는 경우, 패키지의 URL 및 버전을 제공해야 합니다. CLI 명령어 encrypt로 패키지를 암호화한 경우, SessionKey는 결과로 받은 값이어야 합니다.

속성	타입	설명	기본값	Since
url	string	The URL of the bundle zip file (e.g: dist.zip) to be downloaded. (This can be any URL. E.g: Amazon S3, a GitHub tag, any other place you’ve hosted your bundle.)
version	string	이 버전의 code/name
sessionKey	string	업데이트를 위한 세션 키	undefined	4.0.0
checksum	string	업데이트의 체크섬, sha256 형식이며 private key로 암호화되어야 함	undefined	4.0.0
manifest	ManifestEntry[]	델타 (manifest) 멀티 파일 다운로드의 매니페스트	undefined	6.1.0

매니페스트 항목

속성	타입
file_name	string | null
file_hash	string | null
download_url	string | null

BundleId

속성	형식
id	string

BundleListResult

속성	형식
bundles	BundleInfo[]

ListOptions

속성	형식	설명	기본값	Since
raw	boolean	파일 목록을 원본으로 반환할지 또는 매니페스트로 반환할지 여부입니다. true로 설정하면 내부 데이터베이스를 읽어오려는 시도를 하며 디스크에 저장된 파일을 읽습니다.	false	6.14.0

ResetOptions

Prop	Type
toLastSuccessful	boolean

CurrentBundleResult

Prop	Type
bundle	BundleInfo
native	string

MultiDelayConditions

속성	형식
delayConditions	DelayCondition[]

__CAPGO_KEEP_0__

속성	형식	__CAPGO_KEEP_0__
kind	DelayUntilNext	지연 조건을 설정하는 방법
value	string

최신 버전

속성	형식	설명	__CAPGO_KEEP_0__
version	string	getLatest 메소드의 결과	4.0.0
checksum	string		6
major	boolean
message	string
sessionKey	string
error	string
old	string
url	string
manifest	ManifestEntry[]		6.1

GetLatestOptions

속성	타입	설명	기본값	__CAPGO_KEEP_0__
channel	string	__CAPGO_KEEP_0__를 위한 최신 버전을 가져올 채널 The 채널은 'self_assign' 허용해야 함	undefined	6.8.0

ChannelRes

Prop	Type	설명	Since
status	string	채널 설정 현황	4.7.0
error	string
message	string

SetChannelOptions 섹션

Type	채널 설정 취소
channel	string
triggerAutoUpdate	boolean

SetChannelOptions 섹션

채널 정보	타입
triggerAutoUpdate	boolean

GetChannelRes

채널 정보	타입	설명	버전
channel	string	현재 채널 정보	4.8.0
error	string
message	string
status	string
allowSet	boolean

ListChannelsResult

속성	채널 타입	채널 설명	지원 시작
channels	ChannelInfo[]	사용 가능한 채널 목록	7.5.0

채널 정보

속성	타입	설명	지원 시작
id	number	채널 ID	7.5.0
name	string	채널 이름	7.5.0
public	boolean	true이면 기본/대체 채널입니다. 기기들은 공공 채널에 할당할 수 없습니다. 대신 기기는 채널 override를 제거할 때 (using unsetChannel()) 자동으로 업데이트를 받을 수 있는 매칭되는 공공 채널을 받습니다.	7.5.0
allow_self_set	boolean	true이면 기기는 이 채널에 explicit하게 할당할 수 있습니다. 사용자 테스트, A/B 테스트, 또는 옵트인 업데이트 트랙과 같은 경우에 일반적으로 사용됩니다. setChannel()채널 명령은 채널	7.5.0

, 숫자 nameSetCustomIdOptions id.

설정된 ID 옵션

Type	BuiltinVersion
customId	string

설정된 버전

속성	형식
version	string

기기ID

속성	형식
deviceId	string

플러그인 버전

속성	형식
version	string

자동 업데이트 가능성

속성	형식
enabled	boolean

플러그인 리스너 처리

속성	형식
remove	() => Promise<void>

다운로드 이벤트

설명	버전	시작	since
percent	number	다운로드 진행 상태, 0에서 100 사이.	4.0.0
bundle	BundleInfo

NoNeedEvent

Prop	Type	설명	Since
bundle	BundleInfo	다운로드 진행 상태, 0에서 100 사이.	4.0.0

UpdateAvailableEvent

Prop	Type	설명	__CAPGO_KEEP_0__
bundle	BundleInfo	다운로드 진행 상황, 0과 100 사이.	4.0.0

다운로드 완료 이벤트

속성	타입	설명	__CAPGO_KEEP_0__
bundle	BundleInfo	새로운 업데이트가 있는 경우 발송.	4.0.0

주요 업데이트가 있는 경우 이벤트

속성	형식	설명	Since
version	string	__CAPGO_KEEP_0__	4.0.0

UpdateFailedEvent

속성	형식	설명	Since
bundle	BundleInfo	__CAPGO_KEEP_0__	4.0.0

다운로드 실패 이벤트

속성	타입	설명	버전
version	string	다운로드 실패 시 발생합니다.	4.0.0

앱 준비 이벤트

속성	타입	설명	Since
bundle	BundleInfo	__CAPGO_KEEP_0__	5.2.0
status	string

업데이트가 준비되었습니다.

Prop	Type
available	boolean

Shake 메뉴 설정

Prop	Type
enabled	boolean

Shake 메뉴 활성화

속성	타입
enabled	boolean

타입 별칭

BundleStatus

pending: 배포가 준비 중입니다. SET 다음 배포로 준비된 상태입니다. downloading: 배포가 다운로드 중입니다. success: 배포가 다운로드되었습니다. 다음 배포로 준비되었습니다. error: 배포 다운로드에 실패했습니다. SET 다음 배포로 준비된 상태입니다. error: 배포 다운로드에 실패했습니다.

‘success’ | ‘error’ | ‘pending’ | ‘downloading’

다음 배포까지 지연

‘background’ | ‘kill’ | ‘nativeVersion’ | ‘date’

기능과 설정에서 계속

Capacitor을 사용 중이라면 기능과 설정 대시보드와 API 작업을 계획하기 위해, API와 연결하세요. native capability을 위해 @capgo/capacitor-updater를 사용하세요. native capability을 위해 @capgo/capacitor-updater를 사용하는 경우, capgo Overview API Overview API Overview __CAPGO_KEEP_0__ Overview implementation detail을 위해 __CAPGO_KEEP_0__ Overview API 키 API 키의 구현 세부 정보를 위한 키 장치 장치의 구현 세부 정보를 위한 키