함수 및 설정

설치 단계와 이 플러그인에 대한 전체 마크다운 가이드를 포함한 설정 프롬프트를 복사하세요.

업데이터 플러그인 설정

더 많은 정보를 보려면 Github를 참조하세요. README CapacitorUpdater를 더 자세히 알아보세요.

설정 옵션

타입	설명	CapacitorUpdater는 다음 옵션으로 구성할 수 있습니다.	Default	__CAPGO_KEEP_0__
`appReadyTimeout`	`number`	Android, iOS, Electron에서 native 플러그인 업데이트가 실패한 것으로 간주하기 전에 대기하는 밀리초 수를 설정합니다.	`10000 // (10 seconds)`
`responseTimeout`	`number`	Android, iOS, Electron에서 native 플러그인 업데이트가 API으로 간주하기 전에 대기하는 밀리초 수를 설정합니다.	`20000 // (20 seconds)`
`autoDeleteFailed`	`boolean`	Android, iOS, Electron에서 플러그인이 실패한 패키지를 자동으로 삭제할지 여부를 설정합니다.	`true`
`autoDeletePrevious`	`boolean`	Android, iOS, Electron에서 플러그인이 이전 패키지를 성공적인 업데이트 후 자동으로 삭제할지 여부를 설정합니다.	`true`
`autoUpdate`	`boolean`	Android, iOS, Electron에서 플러그인이 업데이트 서버를 통해 자동 업데이트를 사용할지 여부를 설정합니다.	`true`
`resetWhenUpdate`	`boolean`	Android, iOS, Electron에서 기기에 설치된 최신 네이티브 앱 패키지로 이전 다운로드된 패키지를 자동으로 삭제합니다.	`true`
`updateUrl`	`string`	Android, iOS, Electron에서 업데이트를 위한 URL/엔드포인트를 설정합니다.	`https://plugin.capgo.app/updates`
`channelUrl`	`string`	Android, iOS, Electron에서 채널 연산을 위한 URL/엔드포인트를 설정합니다.	`https://plugin.capgo.app/channel_self`
`statsUrl`	`string`	Android, iOS, Electron에서 업데이트 통계를 위한 URL/엔드포인트를 설정합니다. 통계 보고를 비활성화하려면 ""을 설정합니다.	`https://plugin.capgo.app/stats`
`publicKey`	`string`	Android, iOS, Electron에서 종료를 종료하는 라이브 업데이트 암호화 버전 2를 위한 공개 키를 설정합니다.	`undefined`	6.2.0
`version`	`string`	현재 앱 버전을 설정합니다. 첫 업데이트 요청에 사용됩니다. 설정하지 않으면 플러그인은 네이티브 code에서 버전을 가져옵니다. 안드로이드, iOS, 및 Electron에서 사용할 수 있습니다.	`undefined`	4.17.48
`directUpdate`	`boolean \| ‘always’ \| ‘atInstall’ \| ‘onLaunch’`	플러그인이 자동 업데이트 모드에서 직접 설치 업데이트를 언제 지시할지 설정합니다. 10MB 미만의 앱 및 —delta 플래그로 업로드된 앱에 적합합니다. Zip 또는 10MB 이상의 앱은 사용자가 업데이트하는 데 상대적으로 느립니다. - false: 직접 업데이트를 nunca 수행 (기본 동작: 시작 시 다운로드, 배경에서 설정) - atInstall: 앱이 설치되거나 스토어에서 업데이트된 경우에만 직접 업데이트를 수행, 그렇지 않으면 directUpdate = false로 동작 - onLaunch: 앱이 설치되거나 스토어에서 업데이트된 경우 또는 앱이 종료된 경우에만 직접 업데이트를 수행, 그렇지 않으면 directUpdate = false로 동작 - always: 이전 모든 경우에 직접 업데이트를 수행 (앱이 설치되거나 스토어에서 업데이트된 경우 또는 앱이 종료된 경우 또는 앱이 다시 시작된 경우), directUpdate = false로 동작하지 않습니다. - true: (deprecated) always와 동일한 동작을 제공합니다. 이전 호환성을 위해 사용됩니다. 안드로이드, iOS, 및 Electron에서 사용할 수 있습니다.	`false`	5.1.0
`autoSplashscreen`	`boolean`	자동으로 스플래시 화면을 숨기는 것을 처리합니다. 사용자가 직접 업데이트 할 때 활성화 시키면, 플러그인은 업데이트가 적용되거나 업데이트가 필요하지 않으면 스플래시 화면을 자동으로 숨깁니다. 이로 인해 앱이 준비되면 스플래시 화면을 숨기는 것을 수동으로 듣고 호출하는 필요성이 제거됩니다. directUpdate가 “atInstall”, “always”, 또는 true로 설정된 경우에만 작동합니다. @capacitor/splash-screen 플러그인이 설치되어 launchAutoHide: false로 구성되어야 하며, autoUpdate 및 directUpdate가 활성화되어야 합니다. 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을 사용하여 로컬 __CAPGO_KEEP_1__를 테스트하기 위한 서버를 구성합니다.	`undefined`	4.17.48
`localApi`	`string`	CLI을 사용하여 로컬 파일 api를 테스트하기 위한 서버를 구성합니다.	`undefined`	6.3.3
`localApiFiles`	`string`	Configure the CLI to use a local file api for testing.	`undefined`	6.3.3
`allowModifyUrl`	`boolean`	설정에서 앱의 기본 채널을 설정합니다. 대소문자 구분합니다. 이 설정은 클라우드에서 설정한 기본 채널을 덮어씁니다. 하지만 클라우드에서 설정한 채널을 우선합니다.	`false`	5.4.0
`defaultChannel`	`string`	__CAPGO_KEEP_0__을 사용하여 로컬 서버를 테스트하기 위한 서버를 구성합니다.	`undefined`	5.5.0
`appId`	`string`	__CAPGO_KEEP_0__ ID를 앱 설정에서 구성합니다.	`undefined`	6.0.0
`keepUrlPathAfterReload`	`boolean`	__CAPGO_KEEP_0__ 플러그인을 재로드 후 URL 경로를 유지하도록 구성합니다. 경고: 재로드가 트리거되면 ‘window.history’가 비워집니다.	`false`	6.8.0
`disableJSLogging`	`boolean`	__CAPGO_KEEP_0__ 플러그인의 자바스크립트 로깅을 비활성화합니다. true로 설정하면 플러그인은 자바스크립트 콘솔에 로그를 출력하지 않으며 네이티브 로그만 수행합니다.	`false`	7.3.0
`shakeMenu`	`boolean`	__CAPGO_KEEP_0__ 플러그인을 사용하여 업데이트 메뉴를 표시하는 흔들기 동작을 활성화합니다. 디버깅/테스트 목적으로만 사용하세요.	`false`	7.5.0

예시

InSection capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000 // (1 second),
      "responseTimeout": 10 // (10 second),
      "autoDeleteFailed": false,
      "autoDeletePrevious": false,
      "autoUpdate": false,
      "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
    }
  }
}

InSection 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: false,
      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 업데이터에게 알림을 보내고 rollback이 발생할 경우를 대비하여 앱 런치 시마다 이 메서드를 호출해야 함. 기본적으로 앱 런치 후 10초 내에 호출해야 함. 그렇지 않으면 rollback이 발생합니다. 이 동작을 변경하려면 {@link appReadyTimeout}을 참조하세요.

반환값 Promise<AppReadyResult>

setUpdateUrl(…)

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

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

파라미터	Type	설명
`options`	`UpdateUrl`	__CAPGO_KEEP_0__

Since: 5.4.0

setStatsUrl(…)

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

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

Param	Type	설명
`options`	`StatsUrl`	__CAPGO_KEEP_0__

Since: 5.4.0

setChannelUrl(…)

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

앱에 channelUrl을 설정합니다. 이 값은 채널 설정에 사용됩니다.

Param	Type	설명
`options`	`ChannelUrl`	채널 설정을 위한 URL을 포함합니다.

Since: 5.4.0

download(…)

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

다운로드할 새로운 배포본을 제공된 URL에서 받으세요. 이 배포본은 zip 파일이어야 하며, 내부에 파일이 있거나, 유니크한 id를 가진 파일이 있으면 됩니다.

Param	Type	설명
`options`	`DownloadOptions`	다운로드할 새로운 배포본 zip을 위한 {@link DownloadOptions}입니다.

반환: Promise<BundleInfo>

next(…)

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

앱이 다시 로드 될 때 사용할 다음 번들을 설정하세요.

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

반환: Promise<BundleInfo>

set(…)

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

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

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

delete(…)

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

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

Param	타입	설명
`options`	`BundleId`	A {@link {@link BundleId} object containing the ID of a bundle to delete (note, this is the bundle id, NOT the version name)list(…)

Section titled “list(…)

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

Param

Type	Description	The {@link
`options`	`ListOptions`	ListOptions ListOptions} for listing bundles

Returns: Promise<BundleListResult>

reset(…)

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

앱을 builtin bundle (애플 앱 스토어 / 구글 플레이 스토어로 전송된 것 또는 마지막으로 성공적으로 로드된 것 ) 또는 마지막으로 성공적으로 로드된 것.

Param	Type	설명
`options`	`ResetOptions`	Containing {@link ResetOptions.toLastSuccessful}, `true` __CAPGO_KEEP_0__을 기본 빌드에 다시 설정하고 `false` __CAPGO_KEEP_0__은 마지막으로 성공적으로 로드된 빌드를 다시 설정합니다.

current()

current() => Promise<CurrentBundleResult>

현재 빌드를 가져옵니다. 빌드가 설정되지 않은 경우 기본값을 반환합니다. builtin. currentNative는 기기에서 설치된 원래 빌드입니다.

Returns: Promise<CurrentBundleResult>

reload()

reload() => Promise<void>

뷰를 다시 로드합니다.

setMultiDelay(…)

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

Plugin이 업데이트 처리를 지연시키기 위해 사용하는 {@link DelayCondition} 배열을 설정합니다. 모든 조건이 충족된 후, 업데이트 프로세스는 다시 정상적으로 시작되어, 백그라운드 또는 앱을 종료한 후에도 업데이트 설치가 진행됩니다. "kind"의 경우 ISO 8601 형식의 날짜 문자열이어야 합니다. "kind"의 경우 밀리초 단위의 숫자이어야 합니다. "kind"의 경우 버전 번호이어야 합니다. "kind"의 경우 사용되지 않습니다. 이 함수의 동작은 옵션 kill이 첫 번째 종료 후에 업데이트 처리를 트리거하는 것과 다음 백그라운드 처리 후에 업데이트 처리를 트리거하는 것과 다르게 동작합니다. 이 문제는 향후 주요 릴리스에서 해결될 예정입니다. ParamType date DelayCondition background 배열 nativeVersion DelayCondition kill 배열

DelayCondition	배열	설명
`options`	`MultiDelayConditions`	{@link를 포함하여} {@link __CAPGO_KEEP_0__} 배열의 조건을 설정합니다. MultiDelayConditionsSince:

cancelDelay() 4.3.0

cancelDelay() 제목

cancelDelay() => Promise<void>

Since: cancelDelay()Section titled “cancelDelay()”

Copy to clipboard 4.0.0

getLatest(…)

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

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

매개 변수	타입
`options`	`GetLatestOptions`

반환: Promise<LatestVersion>

시작: 4.0.0

setChannel(…)

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

이 장치의 채널을 설정합니다. 채널은 반드시 allow_device_self_set 이 기능이 작동하려면 __CAPGO_KEEP_0__이 활성화되어야 합니다.

중요한 주의 사항:

이 방법을 사용하여 부트 시 채널을 설정하지 마십시오. __CAPGO_KEEP_0__ 설정에 대신 사용하십시오. defaultChannel in your Capacitor config instead.
공개 채널은 자체 할당이 불가능합니다.
채널이 로 표시되면 public호출 시 에러가 반환됩니다. 공개 채널을 사용하려면 대신 setChannel() 호출하십시오 - 장치가 자동으로 일치하는 공개 채널로 전환됩니다. unsetChannel() 를 사용하여 사용 가능한 채널을 발견하고 자체 할당이 허용되는지 여부를 확인하십시오.
enabled for this to work. listChannels() Important notes:

파라미터	타입	설명
`options`	`SetChannelOptions`	{@link를 참조하십시오. SetChannelOptions를 설정하는 채널입니다.반환값:

Since: Promise<ChannelRes>

unsetChannel(…)를 클립보드에 복사 4.7.0

이 장치에 대한 채널 오버라이드 설정을 취소합니다. 이 메서드를 호출한 후 장치에서는 자동으로 업데이트를 수신합니다.

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

unsetChannel(…)를 클립보드에 복사 공개 채널 해당 조건 (플랫폼, 장치 유형, 빌드 유형)과 일치하는 채널을 찾습니다.

This is useful when:

장치가 기본 업데이트 트랙으로 돌아가기를 원할 때
공개 채널을 사용하고 싶을 때 (공개 채널은 자체 할당이 불가능하기 때문입니다.) setChannel())

Param	Type
`options`	`UnsetChannelOptions`

Since: 4.7.0

getChannel()

getChannel() => Promise<GetChannelRes>

이 장치의 채널을 가져옵니다.

Returns: Promise<GetChannelRes>

Since: 4.8.0

listChannels()

listChannels() => Promise<ListChannelsResult>

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

결과에 포함된 각 채널에는:

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

Since: Promise<ListChannelsResult>

setCustomId(…) 7.5.0

제목이 ‘setCustomId(…)’인 섹션

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

Param

protectedTokens	타입	설명
`options`	`SetCustomIdOptions`	{@link SetCustomIdOptions }를 설정하는 커스텀 ID입니다

Since: 4.9.0

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

설정된 구성 파일에 builtin 버전이 있는 경우 native 앱 버전 또는 builtin 버전을 반환합니다

Returns: Promise<BuiltinVersion>

Since: 5.2.0

getDeviceId()

getDeviceId() => Promise<DeviceId>

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

반환: Promise<DeviceId>

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

반환: Promise<PluginVersion>

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

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

반환: Promise<AutoUpdateEnabled>

removeAllListeners()

removeAllListeners() => Promise<void>

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

Since: 1.0.0

다운로드 이벤트를 듣습니다. (…)

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

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

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

반환: Promise<PluginListenerHandle>

시작: 2.0.11

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

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

앱이 시작될 때마다 매번 강제로 체크하고 싶을 때 유용합니다.

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

반환: Promise<PluginListenerHandle>

시작: 4.0.0

addListener(‘updateAvailable’, …)

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

업데이트가 필요한 경우 항상 앱이 시작될 때마다 체크하고 싶을 때 유용한 업데이트가 사용 가능한 이벤트를 듣기

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

반환값: Promise<PluginListenerHandle>

Since: 4.0.0

addListener(‘downloadComplete’, …)

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

다운로드 완료 이벤트를 듣기

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

반환: Promise<PluginListenerHandle>

Since: 4.0.0

majorAvailable 이벤트를 추가하여 …

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

앱에서 메이저 업데이트를 감지하여 메이저 업데이트가 자동 업데이트가 차단되는 경우 알림을 받을 수 있습니다.

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

반환: Promise<PluginListenerHandle>

Since: 2.3.0

addListener(‘updateFailed’, …)

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

앱에서 업데이트 실패 이벤트를 듣고, 다음 앱 시작 시 업데이트 설치가 실패한 경우 알림

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

반환값: Promise<PluginListenerHandle>

버전: 2.3.0

addListener(‘downloadFailed’, …)

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

앱에서 다운로드 실패 이벤트를 듣고, 패키지 다운로드가 실패한 경우 알림

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

반환: Promise<PluginListenerHandle>

시작: 4.0.0

appReloaded 이벤트를 추가하여 앱 리로드 이벤트를 감지합니다.

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

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

파라미터	타입
`eventName`	`’appReloaded’`
`listenerFunc`	`() => void`

반환: Promise<PluginListenerHandle>

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

서버 URL로 인해 자동 업데이트가 비활성화되지 않은 경우 자동 업데이트가 가능합니다.

반환값: Promise<AutoUpdateAvailable>

__CAPGO_KEEP_0__

getNextBundle() => Promise<BundleInfo | null>

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

반환값: Promise<BundleInfo | null>

Since: 6.8.0

setShakeMenu(…) 함수

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

디버깅/테스트 목적으로 흔들림 메뉴를 활성화/비활성화합니다

Param	타입	설명
`options`	`SetShakeMenuOptions`	__CAPGO_KEEP_0__을 사용하여 shake 메뉴를 활성화하거나 비활성화할 수 있습니다.

Since: 7.5.0

__CAPGO_KEEP_0__( )

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

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

반환: Promise<ShakeMenuEnabled>

Since: 7.5.0

인터페이스

AppReadyResult

속성	타입
`bundle`	`BundleInfo`

BundleInfo

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

UpdateUrl

속성	타입
`url`	`string`

StatsUrl

Prop	Type
`url`	`string`

ChannelUrl

Prop	Type
`url`	`string`

DownloadOptions

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

Prop	Type	설명	기본값	Since
`url`	`string`	업데이트를 다운로드할 수 있는 배포본 zip 파일의 URL (예: dist.zip)입니다. (이것은 어떤 URL이든 될 수 있습니다. 예를 들어 Amazon S3, GitHub 태그, 업데이트를 호스팅한 다른 곳 등)
`version`	`string`	버전 code/이름
`sessionKey`	`string`	업데이트의 세션 키, 업데이트가 암호화된 경우	`undefined`	4.0.0
`checksum`	`string`	업데이트의 체크섬, 업데이트가 암호화된 경우에는 개인 키로 암호화해야 함	`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`	raw bundle 목록 또는 manifest를 반환할지 여부를 지정합니다. true로 설정하면 내부 데이터베이스를 읽으려는 대신 디스크에 있는 파일을 읽습니다.	`false`	6.14.0

ResetOptions

Prop	타입
`toLastSuccessful`	`boolean`

CurrentBundleResult

Prop	타입
`bundle`	`BundleInfo`
`native`	`string`

__CAPGO_KEEP_0__

속성	타입
`delayConditions`	`DelayCondition[]`

딜레이 조건

타입	설명	멀티 딜레이 조건을 설정하는 방법
`kind`	`DelayUntilNext`	최신 버전
`value`	`string`

Capacitor

속성	형식	설명	시작
`version`	`string`	최신 버전 가져오기 메소드의 결과	4.0.0
`checksum`	`string`		6
`major`	`boolean`
`message`	`string`
`sessionKey`	`string`
`error`	`string`
`old`	`string`
`url`	`string`
`manifest`	`ManifestEntry[]`		6.1

속성	형식	설명	기본값	최근 버전을 얻기 위한 채널
`channel`	`string`	이 기능이 작동하려면 채널은 'self_assign'을 허용해야 합니다.	`undefined`	6.8.0

ChannelRes

Prop	Type	설명	현재 상태
`status`	`string`	SetChannelOptions	4.7.0
`error`	`string`
`message`	`string`

설정 채널 옵션

설명	타입
`channel`	`string`
`triggerAutoUpdate`	`boolean`

__CAPGO_KEEP_0__

속성	타입
`triggerAutoUpdate`	`boolean`

채널 정보 가져오기

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

채널 목록 결과

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

채널 정보

타입	설명	Since	Since
`id`	`string`	The channel ID	7.5.0
`name`	`string`	The channel name	7.5.0
`public`	`boolean`	기본/대체 채널이면 true입니다. 기기들은 공개 채널에 할당할 수 없습니다. 대신, 기기는 채널 오버라이드 제거("")를 사용하여 자동으로 업데이트를 받을 수 있는 매칭되는 공개 채널에서 업데이트를 받습니다. `unsetChannel()`기기들이 이 채널에 명시적으로 할당할 수 있도록 하려면 true를 설정합니다. 일반적으로 베타 테스트, A/B 테스트, 또는 옵트인 업데이트 트랙에 사용됩니다.	7.5.0
`allow_self_set`	`boolean`	SetCustomIdOptions `setChannel()`설정: SetCustomIdOptions	7.5.0

Prop

BuiltinVersion	__CAPGO_KEEP_0__
`customId`	`string`

__CAPGO_KEEP_1__

속성	형식
`version`	`string`

기기 ID

속성	형식
`deviceId`	`string`

플러그인 버전

형식	자동 업데이트 가능
`version`	`string`

속성

속성	형식
`enabled`	`boolean`

__CAPGO_KEEP_0__

형식	__CAPGO_KEEP_0__
`remove`	`() => Promise<void>`

속성

__CAPGO_KEEP_0__	설명	설명	현재
`percent`	`number`	다운로드 진행률, 0에서 100까지.	4.0.0
`bundle`	`BundleInfo`

NoNeedEvent

Prop	Type	설명	현재
`bundle`	`BundleInfo`	다운로드 진행률, 0에서 100까지.	4.0.0

UpdateAvailableEvent

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

__CAPGO_KEEP_0__ 다운로드 완료 이벤트

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

__CAPGO_KEEP_0__

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

업데이트 실패 이벤트

형식	설명	버전	업데이트 시도 시 실패
`bundle`	`BundleInfo`	업데이트 설치가 실패했을 때 발생합니다.	4.0.0

DownloadFailedEvent

속성	타입	설명	버전
`version`	`string`	다운로드가 실패했을 때 발생합니다.	4.0.0

AppReadyEvent

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

자동 업데이트 가능

속성	형식
`available`	`boolean`

셰이크 메뉴 옵션 설정

속성	형식
`enabled`	`boolean`

셰이크 메뉴 활성화

속성	형식
`enabled`	`boolean`

형식 별명

BundleStatus

대기 중: 배포본이 다운로드 준비 중입니다. SET 다운로드 중: 배포본이 다운로드 중입니다. SET 다운로드 완료: 배포본이 다운로드 완료되어 다음 배포본으로 설정됩니다. 오류: 배포본 다운로드에 실패했습니다.

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

__CAPGO_KEEP_0__

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

함수 및 설정

업데이터 플러그인 설정

예시

메서드

notifyAppReady()

setUpdateUrl(…)

setStatsUrl(…)

setChannelUrl(…)

download(…)

next(…)

set(…)

delete(…)

Section titled “list(…)

reset(…)

current()

reload()

setMultiDelay(…)

cancelDelay() 제목

getLatest(…)

setChannel(…)

이 장치에 대한 채널 오버라이드 설정을 취소합니다. 이 메서드를 호출한 후 장치에서는 자동으로 업데이트를 수신합니다.

getChannel()

listChannels()

제목이 ‘setCustomId(…)’인 섹션

getBuiltinVersion()

getDeviceId()

getPluginVersion()

isAutoUpdateEnabled()

removeAllListeners()

다운로드 이벤트를 듣습니다. (…)

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

addListener(‘updateAvailable’, …)

addListener(‘downloadComplete’, …)

majorAvailable 이벤트를 추가하여 …

addListener(‘updateFailed’, …)

addListener(‘downloadFailed’, …)

appReloaded 이벤트를 추가하여 앱 리로드 이벤트를 감지합니다.

addListener(‘appReady’, …)

isAutoUpdateAvailable()

__CAPGO_KEEP_0__

setShakeMenu(…) 함수

__CAPGO_KEEP_0__( )

인터페이스

AppReadyResult

BundleInfo

UpdateUrl

StatsUrl

ChannelUrl

DownloadOptions

매니페스트 항목

BundleId

BundleListResult

ListOptions

ResetOptions

CurrentBundleResult

__CAPGO_KEEP_0__

딜레이 조건

Capacitor

최신 버전 가져오기 옵션

ChannelRes

설정 채널 옵션

__CAPGO_KEEP_0__

채널 정보 가져오기

채널 목록 결과

채널 정보

Prop

__CAPGO_KEEP_1__

기기 ID

플러그인 버전

속성

__CAPGO_KEEP_0__

속성

NoNeedEvent

UpdateAvailableEvent

__CAPGO_KEEP_0__ 다운로드 완료 이벤트

__CAPGO_KEEP_0__

업데이트 실패 이벤트

DownloadFailedEvent

AppReadyEvent

자동 업데이트 가능