기능 및 설정

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

업데이터 플러그인 설정

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

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

속성	타입	설명	기본값	버전
`appReadyTimeout`	`number`	native 플러그인이 업데이트를 '실패'로 간주하기 전에 기다리는 밀리초 수를 설정할 수 있습니다. Android, iOS, Electron에서 사용 가능합니다.	`10000 // (10 seconds)`
`responseTimeout`	`number`	API 밀리초 동안 native 플러그인 기다리기. Android, iOS, Electron에서 사용 가능.	`20000 // (20 seconds)`
`autoDeleteFailed`	`boolean`	플러그인이 자동으로 실패한 번들을 삭제할지 여부를 설정합니다. Android, iOS, Electron에서 사용 가능.	`true`
`autoDeletePrevious`	`boolean`	플러그인이 성공적인 업데이트 후 이전 번들을 자동으로 삭제할지 여부를 설정합니다. Android, iOS, Electron에서 사용 가능.	`true`
`autoUpdate`	`boolean \| ‘off’ \| ‘atBackground’ \| ‘atInstall’ \| ‘onLaunch’ \| ‘always’ \| ‘onlyDownload’`	업데이트 서버를 통해 Auto Update를 사용하는 방법을 설정합니다. true는 'atBackground'과 동일하며 false는 'off'과 동일합니다. - off: Auto Update를 비활성화합니다. - atBackground: 앱이 배경으로 이동할 때 자동으로 다운로드하고 적용합니다. - atInstall: 새로운 설치 또는 네이티브 앱 업데이트가 발생할 때 즉시 적용하고, 그렇지 않으면 atBackground를 사용합니다. - onLaunch: 앱이 시작될 때 즉시 적용하고, 그렇지 않으면 atBackground를 사용합니다. - always: Auto Update가 실행될 때마다 즉시 적용합니다. - onlyDownload: 자동으로 다운로드하고 updateAvailable 이벤트를.emit하고, 다음 번들을 자동으로 설정하지 않습니다. Android, iOS, Electron에서 사용 가능.	`”atBackground” // true is still accepted`
`resetWhenUpdate`	`boolean`	기기에서 새로운 네이티브 앱 번들을 설치할 때 이전 다운로드한 번들을 자동으로 삭제합니다. Android, iOS, Electron에서 사용 가능.	`true`
`updateUrl`	`string`	업데이트 체크가 전송되는 URL/엔드포인트를 설정합니다. Android, iOS, Electron에서 사용 가능.	`https://plugin.capgo.app/updates`
`channelUrl`	`string`	채널 연산에 사용되는 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. Android, iOS, Electron에서 사용 가능합니다.	`undefined`	6.2.0
`version`	`string`	현재 앱 버전을 구성합니다. 첫 번째 업데이트 요청에 사용됩니다. 설정하지 않으면 플러그인은 네이티브 code에서 버전을 가져옵니다. Android, iOS, Electron에서 사용 가능합니다.	`undefined`	4.17.48
`directUpdate`	`boolean \| ‘always’ \| ‘atInstall’ \| ‘onLaunch’`	사용되지 않음. “atInstall”, “onLaunch”, 또는 “always” 대신 autoUpdate 문자열 모드를 사용하십시오. 이 옵션은 기존 앱에 대해 지원됩니다. - false: 직접 업데이트 수행하지 않음 - atInstall: autoUpdate: “atInstall”와 동일 - onLaunch: autoUpdate: “onLaunch”와 동일 - always: autoUpdate: “always”와 동일 - true: “always”와 동일한 backward compatibility를 위해. Android, iOS, Electron에서 사용 가능합니다.	`false`	5.1.0
`autoSplashscreen`	`boolean`	인스턴트 적용 모드 사용 시 스플래시 스크린 숨김을 자동으로 처리합니다. 활성화 시, 플러그인은 업데이트가 적용되거나 업데이트가 필요하지 않은 경우 스플래시 스크린을 자동으로 숨깁니다. 이로 인해 appReady 이벤트를 수신하고 SplashScreen.hide()를 호출하는 수동적인 수동이 필요하지 않습니다. autoUpdate가 “atInstall”, “onLaunch”, 또는 “always”로 설정된 경우에만 작동합니다. Legacy directUpdate 값은 backward compatibility를 위해 여전히 지원됩니다. @capacitor/splash-screen 플러그인이 설치되고 launchAutoHide: false로 구성된 경우에만 작동합니다. Auto Update가 활성화된 경우에만 작동합니다. Android, iOS에서 사용 가능합니다.	`false`	7.6.0
`periodCheckDelay`	`number`	__CAPGO_KEEP_0__를 설정하여 업데이트 확인 주기 지연 시간을 구성합니다. 단위는 초입니다. Android, iOS, Electron에서 사용할 수 있습니다. 10분(600초)보다 적을 수 없습니다.	`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`	앱의 기본 채널을 설정합니다. 대/소문자 구분합니다. 클라우드에서 기본 채널을 설정한 것을 덮어씁니다. 하지만 클라우드에서 설정한 것을 존중합니다.	`undefined`	5.5.0
`appId`	`string`	앱의 ID를 설정합니다.	`undefined`	6.0.0
`keepUrlPathAfterReload`	`boolean`	플러그인을 사용하여 URL 경로를 재로드 후 유지합니다. 경고: 재로드가 트리거되면 'window.history'가 초기화됩니다.	`false`	6.8.0
`disableJSLogging`	`boolean`	JavaScript 플러그인 로깅을 비활성화합니다. true로 설정하면 플러그인은 자바스크립트 콘솔에 로그를 출력하지 않습니다. 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>

앱 업데이트를 위한 updateUrl을 설정합니다. 이 URL을 사용하여 업데이트를 확인할 수 있습니다.

매개변수	타입	설명
`options`	`UpdateUrl`	__CAPGO_KEEP_0__을 사용하여 업데이트 확인을 위한 URL을 입력하세요.

__CAPGO_KEEP_1__ 5.4.0

setStatsUrl(…)

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

앱에 대한 statistics를 전송하기 위한 statsUrl을 설정합니다. statistics 수집을 비활성화하려면 빈 문자열을 전달하세요.

Param	Type	설명
`options`	`StatsUrl`	__CAPGO_KEEP_0__을 사용하여 statistics를 전송하기 위한 URL을 입력하세요.

__CAPGO_KEEP_1__ 5.4.0

setChannelUrl(…)

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

앱에 channelUrl을 설정합니다. 이 설정은 channel을 설정하는 데 사용됩니다.

Param	Type	설명
`options`	`ChannelUrl`	channel을 설정하는 URL을 포함합니다.

Since: 5.4.0

download(…)를 다운로드합니다.

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

download(…)를 다운로드합니다.

파라미터	타입	설명
`options`	`DownloadOptions`	링크된 {@link 다운로드 옵션}을 사용하여 새로운 배ंडल zip을 다운로드합니다.

반환: Promise<BundleInfo>

다음(…)

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 {@link BundleId} object containing the new bundle id to set as current.delete(…)

Section titled “delete(…)”

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

Param

Type	Description	A {@link
`options`	`BundleId`	BundleId }해당 버블의 ID를 삭제합니다 (버전 이름이 아닌 버블 ID입니다).

리스트(…)

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

앱 내에서 다운로드 한 모든 버블을 가져옵니다

파라미터	타입	설명
`options`	`ListOptions`	리스트 버블에 대한 옵션입니다. 리스트 버블을 반환합니다.The {@link

리스트 버블에 대한 옵션입니다. Promise<BundleListResult>

reset(…)

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

애플 앱 스토어 / 구글 플레이 스토어 에서 받은 배포본 (bundle) 또는 마지막으로 성공적으로 로드된 배포본으로 앱을 초기화합니다. builtin Param

Type	설명	Containing {@link
`options`	`ResetOptions`	마지막 성공적으로 로드된 배포본으로 초기화합니다. builtin 배포본으로 초기화하고 마지막 성공적으로 로드된 배포본으로 초기화합니다.}, `true` resets to the builtin bundle and will reset to the last successfully loaded bundle. `false` reset to the last successfully loaded bundle.

현재()

current() => Promise<CurrentBundleResult>

현재 번들을 가져옵니다. 만약 설정된 번들이 없으면 기본 번들을 반환합니다. builtin. currentNative는 기기에 설치된 원래 번들입니다.

반환값: Promise<CurrentBundleResult>

reload()

reload() => Promise<void>

뷰를 다시 로드합니다.

setMultiDelay(…)

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

업데이트를 지연시키기 위한 Plugin이 사용하는 조건을 포함하는 배열을 설정합니다. 모든 조건이 충족되면 업데이트 프로세스는 다시 시작되어 정상적으로 작동하므로, 앱을 백그라운드나 종료한 후에도 업데이트가 설치됩니다. "kind"의 경우 iso8601 날짜 문자열이어야 합니다. "kind"의 경우 밀리초 단위의 숫자이어야 합니다. "kind"의 경우 버전 번호이어야 합니다. "kind"의 경우 사용되지 않습니다. 이 함수의 동작은 옵션 kill이 첫 번째 종료 후 업데이트를 트리거하고 다음 백그라운드에서 업데이트를 트리거하지 않는 불일치한 동작을 보입니다. 이 문제는 미래의 주요 릴리스에서 해결될 것입니다. ParamType date 설명 background Containing the {@link nativeVersion __CAPGO_KEEP_0__ kill __CAPGO_KEEP_0__

__CAPGO_KEEP_0__	__CAPGO_KEEP_0__	__CAPGO_KEEP_0__
`options`	`MultiDelayConditions`	__CAPGO_KEEP_0__ MultiDelayConditions__CAPGO_KEEP_0__

__CAPGO_KEEP_1__ 4.3.0

cancelDelay()

cancelDelay() => Promise<void>

__CAPGO_KEEP_4__ __CAPGO_KEEP_5__cancelDelay()

__CAPGO_KEEP_6__ 4.0.0

getLatest(…)

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

최신 버전의 배포본을 가져오기 위해 업데이트 URL에서 가져옵니다.

Param	Type
`options`	`GetLatestOptions`

반환: Promise<LatestVersion>

Since: 4.0.0

setChannel(…)

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

이 장치에 대한 플러그인 관리 로컬 채널을 설정합니다. 채널은 allow_device_self_set 이 작업을 위해 활성화되어야 합니다.

setChannel() validates the channel with the backend, then stores the selected channel locally on the device. It does not create or update a backend Device Override, so the device will not appear as overridden in the Capgo dashboard. Only assignments created from the dashboard or the Public API are shown in the Device Override UI.

중요한 주의 사항:

__CAPGO_KEEP_0__에서 사용하지 마십시오. 부팅 시 채널을 설정하는 데 사용하지 마십시오. defaultChannel in your Capacitor config instead.
공개 채널은 자체 할당이 불가능합니다.
채널이 로 표시된 경우 public를 호출하면 오류가 반환됩니다. 공개 채널을 사용하려면 setChannel() 를 호출하십시오 - 장치가 자동으로 일치하는 공개 채널로 전환됩니다. unsetChannel() 를 사용하여 사용 가능한 채널을 발견하고 자체 할당이 허용되는지 여부를 확인하십시오.
Param listChannels() __CAPGO_KEEP_0__

__CAPGO_KEEP_0__	타입	설명
`options`	`SetChannelOptions`	링크된 {@link를 참조하세요. 설정 채널 옵션} 채널을 설정합니다.

반환: Promise<ChannelRes>

Since: 4.7.0

unsetChannel(…)

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

장치에 저장된 플러그인 관리 채널을 삭제합니다. 이 작업은 로컬 저장소에 저장된 채널만 삭제하고, 대시보드 또는 공용 __CAPGO_KEEP_0__ 장치 오버라이드 기록은 삭제하지 않습니다. setChannel(); it does not delete Dashboard or Public API Device Override records.

이 메소드를 호출한 후 일반 채널 우선순위가 적용됩니다: 기존의 대시보드 또는 공용 API 기기 우선순위가 존재하면 기기 우선순위가 우선하고, 그렇지 않으면 기기의 조건(플랫폼, 기기 종류, 빌드 종류)에 맞는 공용/기본 채널로 되돌아갑니다.

이것은 유용합니다:

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

Param	Type
`options`	`UnsetChannelOptions`

Since: 4.7.0

getChannel()

getChannel() => Promise<GetChannelRes>

이 기기의 채널을 가져옵니다

반환: Promise<GetChannelRes>

Since: 4.8.0

listChannels()

listChannels() => Promise<ListChannelsResult>

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

결과에 있는 각 채널에는:

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

반환: Promise<ListChannelsResult>

시작: 7.5.0

setCustomId(…)

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

이 장치에 사용자 지정 ID를 설정합니다.

매개 변수	타입	설명
`options`	`SetCustomIdOptions`	{@link SetCustomIdOptions 설정된 customId

Since: 4.9.0

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

설정된 config에 builtin 버전이 있으면 native app 버전을 반환합니다.

Returns: Promise<BuiltinVersion>

Since: 5.2.0

getDeviceId()

getDeviceId() => Promise<DeviceId>

기기 식별 ID를 가져옵니다. (자동 업데이트 서버로 전송됨)

반환: Promise<DeviceId>

__CAPGO_KEEP_0__ 플러그인 버전을 가져옵니다.

getPluginVersion() => Promise<PluginVersion>

기기에서 Capacitor Updater 플러그인 버전을 가져옵니다. (자동 업데이트 서버로 전송됨)

반환: Promise<PluginVersion>

자동 업데이트 기능이 활성화되어 있는지 여부를 확인합니다.

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

자동 업데이트 설정 상태 가져오기.

반환: Promise<AutoUpdateEnabled>

removeAllListeners()

removeAllListeners() => Promise<void>

이 플러그인을 위한 모든 리스너를 제거합니다.

Since: 1.0.0

다운로드 이벤트를 듣기 위해 addListener('download', ...)를 사용합니다.

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

앱에서 패키지 다운로드 이벤트를 듣습니다. 다운로드가 시작되면, 다운로드 중인 동안, 다운로드가 완료되면 한 번씩 발생합니다. 다운로드 중인 퍼센트를 반환합니다.

Param:	타입
`eventName`	`’download’`
`listenerFunc`	`(state: DownloadEvent) => void`

반환값: Promise<PluginListenerHandle>

시작: 2.0.11

addListener('noNeedUpdate', ...)

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

앱이 시작될 때마다 매번 강제로 체크하고 싶을 때 유용한 no need to update 이벤트를 듣기

파라미터	타입
`eventName`	`’noNeedUpdate’`
`listenerFunc`	`(state: NoNeedEvent) => void`

반환값: Promise<PluginListenerHandle>

시작: 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`

반환값: Promise<PluginListenerHandle>

시작일: 4.0.0

addListener('majorAvailable', ...)를 호출합니다.

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

앱에서 주요 업데이트 이벤트를 듣고, 주요 업데이트가 자동 업데이트가 중단되는 것을 방지할 때 알려줍니다.

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

반환값: Promise<PluginListenerHandle>

시작일: 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>

앱이 준비되면 앱에서 알림을 받을 수 있습니다.

파라미터	타입
`eventName`	`’appReady’`
`listenerFunc`	`(state: AppReadyEvent) => void`

반환: Promise<PluginListenerHandle>

버전: 5.1.0

isAutoUpdateAvailable() 섹션 제목

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

반환:

__CAPGO_KEEP_0__ 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`	shake 메뉴를 활성화/비활성화할 수 있는 boolean 값을 포함합니다.

Since: 7.5.0

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

shake 메뉴의 현재 상태를 가져옵니다.

Returns: Promise<ShakeMenuEnabled>

Since: 7.5.0

인터페이스

AppReadyResult

Prop	Type
`bundle`	`BundleInfo`

BundleInfo

Prop	Type
`id`	`string`
`version`	`string`
`downloaded`	`string`
`checksum`	`string`
`status`	`BundleStatus`

업데이트 URL

Prop	Type
`url`	`string`

STATS URL

속성	형식
`url`	`string`

채널 URL

속성	형식
`url`	`string`

다운로드 옵션

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

속성	형식	설명	기본	Since
`url`	`string`	GitHub 배포 zip 파일의 URL (예: dist.zip)입니다. (이것은 어떤 URL이든 될 수 있습니다. 예를 들어: Amazon S3, GitHub 태그, 당신이 배포한 파일을 어디서든 호스팅한 경우)
`version`	`string`	code/이름의 이 버전
`sessionKey`	`string`	업데이트 시에 암호화된 배포의 세션 키	`undefined`	4.0.0
`checksum`	`string`	업데이트의 체크섬, sha256으로 암호화된 개인 키가 필요합니다. (배포가 암호화된 경우)	`undefined`	4.0.0
`manifest`	`ManifestEntry[]`	델타 (manifest) 멀티 파일 다운로드의 매니페스트	`undefined`	6.1.0

매니페스트 항목

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

BundleId

Prop	Type
`id`	`string`

BundleListResult

Prop	Type
`bundles`	`BundleInfo[]`

ListOptions

Prop	Type	설명	기본	Since
`raw`	`boolean`	__CAPGO_KEEP_0__을 true로 설정하면 내부 데이터베이스를 읽기 위해 디스크에 있는 파일 대신 목록이 시도됩니다.	`false`	6.14.0

ResetOptions

속성	타입
`toLastSuccessful`	`boolean`

현재 번들 결과

속성	타입
`bundle`	`BundleInfo`
`native`	`string`

MultiDelayConditions

Prop	Type
`delayConditions`	`DelayCondition[]`

딜레이 조건

Prop	Type	설명
`kind`	`DelayUntilNext`	멀티 딜레이 조건을 설정하는 setMultiDelay
`value`	`string`

속성	타입	설명	Since
`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

속성	타입	설명	기본값	Since
`channel`	`string`	최신 버전을 받을 수 있는 채널	`undefined`	6.8.0

이 기능이 작동하려면 채널은 'self_assign'을 허용해야 합니다.

채널Res	설명	설명	설명
`status`	`string`	설명	4.7.0
`error`	`string`
`message`	`string`

설명

설명	설명
`channel`	`string`
`triggerAutoUpdate`	`boolean`

설정되지 않은 채널 옵션

속성	타입
`triggerAutoUpdate`	`boolean`

채널 가져오기

속성	타입	설명	버전
`channel`	`string`	채널 가져오기 현재 상태	4.8.0
`error`	`string`
`message`	`string`
`status`	`string`
`allowSet`	`boolean`

채널 목록 결과

속성	타입	설명	버전
`channels`	`ChannelInfo[]`	사용 가능한 채널 목록	7.5.0

ChannelInfo 섹션

타입	설명	버전	__CAPGO_KEEP_0__
`id`	`number`	숫자 채널 ID	7.5.0
`name`	`string`	채널 이름	7.5.0
`public`	`boolean`	true이면, 이 채널이 기본 채널입니다. 장치가 공공 채널에 할당할 수 없습니다. 대신, 장치가 채널 오버라이드 제거("")를 사용하여, 자동으로 업데이트를 받을 수 있는 매칭되는 공공 채널을 받습니다. `unsetChannel()`true이면, 장치가 이 채널에 명시적으로 할당할 수 있습니다. 이 채널은 일반적으로 베타 테스트, A/B 테스트 또는 옵트인 업데이트 트랙에 사용됩니다.	7.5.0
`allow_self_set`	`boolean`	채널 명령은 채널 `setChannel()`, 숫자	7.5.0

이 숫자 nameSetCustomIdOptions id.

SetCustomIdOptions

타입	__CAPGO_KEEP_0__
`customId`	`string`

__CAPGO_KEEP_0__

__CAPGO_KEEP_1__	__CAPGO_KEEP_2__
`version`	`string`

__CAPGO_KEEP_0__

__CAPGO_KEEP_3__	__CAPGO_KEEP_4__
`deviceId`	`string`

__CAPGO_KEEP_0__

__CAPGO_KEEP_3__	__CAPGO_KEEP_4__
`version`	`string`

자동 업데이트 활성화

속성	타입
`enabled`	`boolean`

플러그인 리스너 처리

속성	타입
`remove`	`() => Promise<void>`

다운로드 이벤트

속성	타입	설명	이제
`percent`	`number`	다운로드의 현재 상태, 0과 100 사이.	4.0.0
`bundle`	`BundleInfo`

NoNeedEvent

속성	형식	설명	이제
`bundle`	`BundleInfo`	다운로드의 현재 상태, 0과 100 사이.	4.0.0

업데이트가 필요한 이벤트

속성	타입	설명	Since
`bundle`	`BundleInfo`	다운로드 진행률, 0에서 100 사이.	4.0.0

다운로드 완료 이벤트

속성	타입	설명	Since
`bundle`	`BundleInfo`	새로운 업데이트가 있는 경우 방출.	4.0.0

주요 사용 가능한 이벤트

속성	타입	설명	버전
`version`	`string`	새로운 주요 버전 패키지가 사용 가능할 때 발생합니다.	4.0.0

업데이트 실패 이벤트

속성	타입	설명	이제
`bundle`	`BundleInfo`	__CAPGO_KEEP_0__	4.0.0

다운로드 실패 이벤트

속성	형식	설명	이제
`version`	`string`	다운로드 실패	4.0.0

앱 준비 이벤트

속성	타입	설명	Since
`bundle`	`BundleInfo`	앱이 사용할 준비가 되었을 때 발생합니다.	5.2.0
`status`	`string`

자동 업데이트 가능

속성	타입
`available`	`boolean`

SetShakeMenuOptions

속성	타입
`enabled`	`boolean`

ShakeMenuEnabled

Prop	Type
`enabled`	`boolean`

Type Aliases

BundleStatus

대기 중: 배포가 준비 중입니다. downloading: 배포가 다운로드 중입니다. success: 배포가 다운로드되었습니다. 사용할 준비가되었습니다. SET Bundle을 Bundle을 SET합니다. 다음 번들로 계속 진행하세요. 오류: 번들이 다운로드에 실패했습니다.

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

DelayUntilNext

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

기능과 설정에서 계속 진행하세요.

Capacitor를 사용 중이라면 기능과 설정 대시보드와 Capgo API 연산을 계획하고 싶다면 Capacitor를 사용하여 @capgo/capacitor-updater Capacitor를 사용하여 @capgo/capacitor-updater Capgo API 개요 Capgo API 구현 세부 사항 __CAPGO_KEEP_0__ Introduction API Keys API Keys 구현 세부 사항에 대한 Devices