__CAPGO_KEEP_0__

설치 단계와 이 플러그인의 전체 마크다운 가이드를 포함한 설정 프롬프트를 복사합니다.

업데이터 플러그인 설정

Github를 보세요. README for more information.

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

속성	형식	설명	기본값	Since
`appReadyTimeout`	`number`	업데이트를 ‘실패’로 간주하기 전에 네이티브 플러그인이 기다리는 밀리초 수를 구성합니다. Android, iOS, Electron에서 사용 가능합니다.	`10000 // (10 seconds)`
`responseTimeout`	`number`	Configure the number of milliseconds the native plugin should wait before considering API timeout. Available on Android, iOS, and Electron.	`20000 // (20 seconds)`
`autoDeleteFailed`	`boolean`	실패한 패키지를 자동으로 삭제하는지 여부를 구성합니다. Android, iOS, Electron에서 사용 가능합니다.	`true`
`autoDeletePrevious`	`boolean`	이전 업데이트 후 성공적으로 업데이트된 후 이전 패키지를 자동으로 삭제하는지 여부를 구성합니다. Android, iOS, Electron에서 사용 가능합니다.	`true`
`autoUpdate`	`boolean \| ‘off’ \| ‘atBackground’ \| ‘atInstall’ \| ‘onLaunch’ \| ‘always’ \| ‘onlyDownload’`	업데이트 서버를 통해 자동 업데이트를 사용하는 방법을 구성합니다. true는 ‘atBackground’와 동일하며, false는 ‘off’와 동일합니다. - off: 자동 업데이트를 비활성화합니다. - atBackground: 앱이 배경으로 이동할 때 자동으로 다운로드하고 적용합니다. - atInstall: 새로운 설치 또는 네이티브 앱 업데이트가 발생한 경우 즉시 적용하고, 그렇지 않으면 atBackground를 사용합니다. - onLaunch: 앱이 시작될 때 즉시 적용하고, 그렇지 않으면 atBackground를 사용합니다. - always: 자동 업데이트가 실행될 때마다 즉시 적용합니다. - onlyDownload: 자동으로 다운로드하고 업데이트가 준비되었음을 알리고, 다음 패키지를 자동으로 설정하지 않습니다. 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`	업데이트 통계를 전송하는 URL / 엔드포인트를 구성합니다. Android, iOS, 및 Electron에서 사용할 수 있습니다. 통계 보고를 비활성화하려면 ""으로 설정하세요.	`https://plugin.capgo.app/stats`
`publicKey`	`string`	버전 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”. 이 옵션은 기존 앱에 대해 지원됩니다. - false: 직접 업데이트를 수행하지 않습니다 - atInstall: autoUpdate: “atInstall”와 동일합니다 - onLaunch: autoUpdate: “onLaunch”와 동일합니다 - always: autoUpdate: “always”와 동일합니다 - true: “always”와 동일합니다. Android, iOS, 및 Electron에서 사용할 수 있습니다.	`false`	5.1.0
`autoSplashscreen`	`boolean`	자동으로 스플래시 화면을 숨기는 모드가 사용될 때 스플래시 화면을 숨기는 기능을 자동으로 처리합니다. 사용 시, 업데이트 적용이 완료되거나 업데이트가 필요하지 않을 때 스플래시 화면을 자동으로 숨깁니다. 이로 인해 앱이 준비되면 스플래시 화면을 숨기는 함수인 SplashScreen.hide()를 호출해야 하는 필요성이 사라집니다. 이 기능은 autoUpdate가 “atInstall”, “onLaunch”, 또는 “always”로 설정된 경우에만 작동합니다. Legacy directUpdate 값은 백워드 호환성을 위해 여전히 지원됩니다. @capacitor/splash-screen 플러그인을 설치하고 launchAutoHide: false로 구성해야 합니다. Auto Update가 활성화되어야 합니다. Android 및 iOS에서만 사용할 수 있습니다.	`false`	7.6.0
`periodCheckDelay`	`number`	업데이트 확인 주기를 설정합니다. 단위는 초입니다. Android, iOS, Electron에서 사용할 수 있습니다. 600초 (10분)보다 작을 수 없습니다.	`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`	업데이트 URL, 통계 URL 및 채널 URL을 동적으로 JavaScript에서 수정할 수 있도록 플러그인을 허용합니다.	`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`	플러그인의 자바스크립트 로깅을 비활성화합니다. true로 설정하면 플러그인은 자바스크립트 콘솔에 로그를 출력하지 않습니다. 단, 네이티브 로그만 수행됩니다.	`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>

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

__CAPGO_KEEP_0__	__CAPGO_KEEP_1__	__CAPGO_KEEP_2__
`options`	`UpdateUrl`	업데이트를 확인하기 위한 URL을 사용하는 URL입니다.

__CAPGO_KEEP_3__ 5.4.0

__CAPGO_KEEP_4__

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

__CAPGO_KEEP_7__

__CAPGO_KEEP_8__	__CAPGO_KEEP_9__	__CAPGO_KEEP_10__
`options`	`StatsUrl`	statistic을 전송하기 위한 URL을 사용하는 데 필요한 URL을 포함합니다.

Since: 5.4.0

setChannelUrl(…)

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

앱에 channelUrl을 설정하세요. 이 channel을 설정하기 위해 사용됩니다.

Param	Type	설명
`options`	`ChannelUrl`	channel을 설정하기 위한 URL을 사용하는 데 필요한 URL을 포함합니다.

Since: 5.4.0

download(…)

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

지정된 URL에서 새로운 배포본을 다운로드합니다. 이 배포본은 zip 파일이어야 하며, 내부에 파일이 포함되어야 하거나, 고유한 id를 포함하여 모든 파일이 포함되어야 합니다.

Param	Type	설명
`options`	`DownloadOptions`	다운로드할 새로운 배포본 zip의 {@link DownloadOptions}입니다. 반환:next(…)

다음(…) Promise<BundleInfo>

next(…)

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

앱이 다시 로드 될 때 사용할 다음 번들을 설정합니다.

Param	Type	설명
`options`	`BundleId`	앱이 다시 시작 될 때 사용할 다음 번들의 ID를 포함합니다. {@link BundleInfo.id}

반환: Promise<BundleInfo>

set(…)

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

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

파라미터	타입	설명
`options`	`BundleId`	A {@link BundleId} 객체는 현재로 설정할 새로운 번들 아이디를 포함합니다.

delete(…)

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

지정된 번들을 네이티브 앱 스토리지에서 삭제합니다. {@link list}를 사용하여 저장된 번들 아이디를 가져올 수 있습니다.

파라미터	타입	설명
`options`	`BundleId`	ID를 포함하는 {@link} 객체를 삭제하는 데 사용되는 번들 ID (주의, 이건 버전 이름이 아닌 번들 ID입니다) list(…)제목: list(…)

클립보드에 복사

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

Type

설명	The {@link}	BundleId
`options`	`ListOptions`	list(…) 리스트 옵션}으로 번들 목록을 표시합니다.

반환: Promise<BundleListResult>

reset(…)

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

애플 앱 스토어 / 구글 플레이 스토어로 전송된 번들 또는 마지막으로 성공적으로 로드된 번들을 초기화합니다. builtin Param

Type	설명	Containing {@link}
`options`	`ResetOptions`	Containing {@link} ResetOptions.toLastSuccessful}, `true` 설정된 번들을 초기화하고 `false` 마지막으로 성공적으로 로드된 번들을 초기화합니다.

current()

current() => Promise<CurrentBundleResult>

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

반환값: Promise<CurrentBundleResult>

reload()

reload() => Promise<void>

뷰를 다시 로드하세요

__CAPGO_KEEP_0__

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

Plugin이 업데이트 프로세스를 지연시키기 위해 사용할 {@link DelayCondition} 배열을 설정합니다. 모든 조건이 충족되면, 업데이트 프로세스는 다시 시작되어 일반적으로 업데이트가 설치됩니다. 배경화면 또는 앱을 종료한 후에도 업데이트가 설치됩니다. kind에 대한 값은 ISO 8601 날짜 문자열이어야 합니다. kind에 대한 값은 밀리초 단위의 숫자이어야 합니다. kind에 대한 값은 버전 번호이어야 합니다. kind에 대한 값은 사용되지 않습니다. 이 함수의 동작은 kill 옵션을 트리거하는 경우 첫 번째 kill 후에 업데이트가 설치되지 않고 다음 배경화면 후에 업데이트가 설치되는 문제가 있습니다. 이 문제는 미래의 메이저 릴리스에서 해결될 예정입니다. ParamReload the view date setMultiDelay(…) background Section titled “setMultiDelay(…) nativeVersion Copy to clipboard kill Sets a {@link DelayCondition} array containing conditions that the Plugin will use to delay the update.

DelayCondition	타입	설명
`options`	`MultiDelayConditions`	{@link 포함하여 MultiDelayConditions } 조건을 설정하기 위한 array

Since: 4.3.0

cancelDelay()

cancelDelay() => Promise<void>

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

Since: __CAPGO_KEEP_0__ 4.0.0

getLatest(…)

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

최신 버전의 배포본을 가져올 수 있는 업데이트 URL

Param	Type
`options`	`GetLatestOptions`

Returns: __CAPGO_KEEP_0__ Promise<LatestVersion>

Since: __CAPGO_KEEP_0__ 4.0.0

setChannel(…)

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

이 장치의 채널을 설정합니다. 채널은 allow_device_self_set 이 작업을 위해 활성화되어야 합니다.

중요한 주의 사항:

이 메서드를 부트 시 채널을 설정하지 마십시오. 대신 defaultChannel in your Capacitor config instead.
이 메서드는 앱이 준비되었으며 사용자가 상호 작용 (예: 베타 프로그램에 가입) 한 후에 사용됩니다.
공개 채널은 자체 할당이 불가능합니다. 채널이 public로 표시되어 있다면 setChannel() 호출하면 오류가 반환됩니다. 공개 채널을 사용하려면 unsetChannel() 호출하세요 - 장치가 자동으로 일치하는 공개 채널로 전환됩니다.
사용 listChannels() 어떤 채널이 사용 가능하고 자체 할당을 허용하는지 알아보세요.

Param	Type	설명
`options`	`SetChannelOptions`	설정할 {@link SetChannelOptions} 채널입니다. 반환:Since:

unsetChannel(…) 제목 섹션 Promise<ChannelRes>

복사 4.7.0

unsetChannel(…) 설명

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

이 장치의 채널_OVERRIDE를 해제합니다. 이 메서드를 호출한 후 장치는 자동으로 자신의 조건 (플랫폼, 장치 유형, 빌드 유형)에 맞는 공공 채널에서 업데이트를 받습니다. 공공 채널 이것은 유용합니다.

장치가 기본 업데이트 트랙으로 돌아가고 싶을 때

공공 채널을 사용하고 싶을 때 (공공 채널은 자체 할당을 통해 사용할 수 없습니다)
Param setChannel())

Type	Since:
`options`	`UnsetChannelOptions`

getChannel() 4.7.0

getChannel()

getChannel() => Promise<GetChannelRes>

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

반환: Promise<GetChannelRes>

시작: 4.8.0

listChannels()

listChannels() => Promise<ListChannelsResult>

이 기기의 모든 채널을 목록화합니다. 기기의 현재 환경(플랫폼, 에뮬레이터/실제 기기, 개발/운영 빌드)과 공용 또는 자체 할당이 허용되는 채널을 반환합니다.

결과에 있는 각 채널에는:

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

Returns: Promise<ListChannelsResult>

Since: 7.5.0

setCustomId(…)

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

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

파라미터	타입	설명
`options`	`SetCustomIdOptions`	{@link SetCustomIdOptions}에 정의된 customId를 설정합니다. Since:getBuiltinVersion()

getBuiltinVersion() 4.9.0

클립보드에 복사

getBuiltinVersion() => Promise<BuiltinVersion>

getBuiltinVersion()함수

getBuiltinVersion()함수 Promise<BuiltinVersion>

Since: 5.2.0

getDeviceId()

getDeviceId() => Promise<DeviceId>

장치 고유 ID를 얻습니다. (자동 업데이트 서버로 전송)

Returns: Promise<DeviceId>

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

Returns: Promise<PluginVersion>

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

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

반환: Promise<AutoUpdateEnabled>

removeAllListeners() 섹션

removeAllListeners() => Promise<void>

Since:

다운로드 이벤트에 리스너를 추가합니다. 1.0.0

addListener('download', ...) 섹션

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

다운로드 배너 이벤트를 듣기

다운로드가 시작되면, 다운로드 중인 동안, 다운로드가 완료되면 한 번만 발생합니다.	다운로드 중인 퍼센트를 모두 반환합니다.
`eventName`	`’download’`
`listenerFunc`	`(state: DownloadEvent) => void`

Param Promise<PluginListenerHandle>

Type 2.0.11

Returns:

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

addListener('noNeedUpdate', ...)를 추가합니다.

다운로드가 필요하지 않음을 듣기	다운로드가 필요하지 않음을 듣기
`eventName`	`’noNeedUpdate’`
`listenerFunc`	`(state: NoNeedEvent) => void`

Param Promise<PluginListenerHandle>

Since: 4.0.0

__CAPGO_KEEP_0__

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

__CAPGO_KEEP_3__

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

Returns: Promise<PluginListenerHandle>

Since: 4.0.0

__CAPGO_KEEP_0__

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>

앱 내에서 메이저 업데이트를 듣고, 메이저 업데이트가 자동 업데이트가 차단되는 경우 알려줍니다.

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로 의해 비활성화되지 않은 경우 자동으로 업데이트 여부가 있는지 확인합니다.

반환: Promise<AutoUpdateAvailable>

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

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

반환: Promise<BundleInfo | null>

Since: 6.8.0

setShakeMenu(…)

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

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

파라미터	타입	설명
`options`	`SetShakeMenuOptions`	shake 메뉴를 활성화하거나 비활성화할 수 있는 boolean 값을 포함합니다.

Since: 7.5.0

__CAPGO_KEEP_0__

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

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

반환: Promise<ShakeMenuEnabled>

Since: 7.5.0

인터페이스

__CAPGO_KEEP_0__

속성	타입
`bundle`	`BundleInfo`

번들 정보 섹션

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

업데이트 URL

속성	타입
`url`	`string`

__CAPGO_KEEP_0__

Prop	타입
`url`	`string`

채널 URL

Prop	타입
`url`	`string`

다운로드 옵션

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

속성	타입	설명	기본값	Since
`url`	`string`	업데이트를 다운로드할 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

속성	형식
`id`	`string`

BundleListResult

속성	형식
`bundles`	`BundleInfo[]`

ListOptions

속성	타입	설명	기본값	Since
`raw`	`boolean`	원본 배포 목록을 반환하거나 매니페스트를 반환할지 여부를 지정합니다. true로 설정하면 내부 데이터베이스를 읽으려는 목록이 디스크에 있는 파일 대신에 파일을 읽으려고 시도합니다.	`false`	6.14.0

ResetOptions

속성	타입
`toLastSuccessful`	`boolean`

현재 배포 결과

속성	형식
`bundle`	`BundleInfo`
`native`	`string`

__CAPGO_KEEP_0__

속성	형식
`delayConditions`	`DelayCondition[]`

__CAPGO_KEEP_0__

속성	형식	설명
`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

속성	타입	설명	기본	Since
`channel`	`string`	The channel to get the latest version for The channel must allow ‘self_assign’ for this to work	`undefined`	6.8.0

ChannelRes

Prop	Type	설명	Since
`status`	`string`	설정된 채널의 현재 상태	4.7.0
`error`	`string`
`message`	`string`

SetChannelOptions

속성	타입
`channel`	`string`
`triggerAutoUpdate`	`boolean`

__CAPGO_KEEP_0__ 채널 옵션을 초기화합니다.

속성	타입
`triggerAutoUpdate`	`boolean`

__CAPGO_KEEP_0__ 채널 결과를 가져옵니다.

속성	타입	__CAPGO_KEEP_0__	설명
`channel`	`string`	채널의 현재 상태	4.8.0
`error`	`string`
`message`	`string`
`status`	`string`
`allowSet`	`boolean`

ListChannelsResult

속성	형식	설명	시작
`channels`	`ChannelInfo[]`	사용 가능한 채널 목록	7.5.0

채널 정보

형식	Section titled “ChannelInfo”	설명	__CAPGO_KEEP_0__
`id`	`string`	채널 ID	7.5.0
`name`	`string`	채널 이름	7.5.0
`public`	`boolean`	__CAPGO_KEEP_0__이면 기본 채널입니다. 기기들은 공공 채널에 할당할 수 없습니다. 대신 기기는 채널 override를 제거할 때 (using __CAPGO_KEEP_1__) 자동으로 업데이트를 받습니다. `unsetChannel()`__CAPGO_KEEP_0__이면 기기는 __CAPGO_KEEP_2__를 사용하여 이 채널에 명시적으로 할당할 수 있습니다. 일반적으로 베타 테스트, A/B 테스트 또는 옵트인 업데이트 트랙에 사용됩니다.	7.5.0
`allow_self_set`	`boolean`	SetCustomIdOptions `setChannel()`SetCustomIdOptions	7.5.0

속성

Since	The channel ID
`customId`	`string`

__CAPGO_KEEP_0__

__CAPGO_KEEP_1__	__CAPGO_KEEP_2__
`version`	`string`

__CAPGO_KEEP_3__

__CAPGO_KEEP_5__	__CAPGO_KEEP_6__
`deviceId`	`string`

__CAPGO_KEEP_7__

__CAPGO_KEEP_9__	__CAPGO_KEEP_10__
`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`	새로운 업데이트가 사용 가능한 경우 emit	4.0.0

주요 사용 가능한 이벤트

속성	형식	설명	버전
`version`	`string`	새로운 주요 번들 사용 가능 시 발생	4.0.0

업데이트 실패 이벤트

속성	형식	설명	Since
`bundle`	`BundleInfo`	__CAPGO_KEEP_0__	4.0.0

다운로드 실패 이벤트

속성	타입	설명	Since
`version`	`string`	__CAPGO_KEEP_0__	4.0.0

앱 준비 이벤트

다운로드 실패	타입	설명	Since
`bundle`	`BundleInfo`	__CAPGO_KEEP_0__	5.2.0
`status`	`string`

자동 업데이트 가능

속성	타입
`available`	`boolean`

셰이크 메뉴 옵션 설정

속성	타입
`enabled`	`boolean`

ShakeMenuEnabled

속성	타입
`enabled`	`boolean`

타입 별명

BundleStatus

pending: 다운로드 준비 중입니다. SET downloading: 다운로드 중입니다. success: 다운로드가 완료되었습니다. 다음 번들로. 오류: 번들이 다운로드를 실패했습니다.

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

__CAPGO_KEEP_0__

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

__CAPGO_KEEP_0__

업데이터 플러그인 설정

예시

메서드

notifyAppReady()

setUpdateUrl(…)

__CAPGO_KEEP_4__

setChannelUrl(…)

download(…)

next(…)

set(…)

delete(…)

클립보드에 복사

reset(…)

current()

reload()

__CAPGO_KEEP_0__

cancelDelay()

getLatest(…)

setChannel(…)

unsetChannel(…) 설명

getChannel()

listChannels()

setCustomId(…)

클립보드에 복사

getDeviceId()

getPluginVersion()

isAutoUpdateEnabled()

removeAllListeners() 섹션

addListener('download', ...) 섹션

Returns:

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__

addListener('majorAvailable', …)

addListener('updateFailed', …)

addListener('downloadFailed', …)

addListener(‘appReloaded’, …)

addListener(‘appReady’, …)

isAutoUpdateAvailable()

getNextBundle()

setShakeMenu(…)

__CAPGO_KEEP_0__

인터페이스

__CAPGO_KEEP_0__

번들 정보 섹션

업데이트 URL

__CAPGO_KEEP_0__

채널 URL

다운로드 옵션

매니페스트 항목

BundleId

BundleListResult

ListOptions

ResetOptions

현재 배포 결과

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__

최신 버전

최신 버전 가져오기 옵션

ChannelRes

SetChannelOptions

__CAPGO_KEEP_0__ 채널 옵션을 초기화합니다.

__CAPGO_KEEP_0__ 채널 결과를 가져옵니다.

ListChannelsResult

채널 정보

속성

__CAPGO_KEEP_0__

__CAPGO_KEEP_3__

__CAPGO_KEEP_7__

자동 업데이트 활성화

플러그인 리스너 핸들

다운로드 이벤트

NoNeedEvent

업데이트가 필요한 이벤트

다운로드 완료 이벤트

주요 사용 가능한 이벤트

업데이트 실패 이벤트

다운로드 실패 이벤트

앱 준비 이벤트

자동 업데이트 가능