기능과 설정

설치 단계와 이 플러그인의 전체 마크다운 가이드를 포함한 설치 지시를 복사할 준비

업데이터 플러그인 설정

See the Github README 더 많은 정보를 원하시면.

CapacitorUpdater는 다음 옵션으로 구성할 수 있습니다:

속성	형식	설명	기본값	시작
`appReadyTimeout`	`number`	Android, iOS, Electron에서 사용할 수 있는 native 플러그인 업데이트가 실패한 것으로 간주하기 전에 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 \| ‘off’ \| ‘atBackground’ \| ‘atInstall’ \| ‘onLaunch’ \| ‘always’ \| ‘onlyDownload’`	Configure how the plugin should use Auto Update via an update server. true is the same as “atBackground”; false is the same as “off”. - off: Disable Auto Update - atBackground: Check and download automatically, then apply when the app moves to the background - atInstall: Apply immediately only after a fresh install or native app update, otherwise use atBackground - onLaunch: Apply immediately on launch, otherwise use atBackground after the launch check - always: Apply immediately whenever Auto Update runs - onlyDownload: Check and download automatically, emit updateAvailable, and never set the next bundle automatically. Instant apply modes (“atInstall”, “onLaunch”, “always”) should be uploaded with —delta so the update does not slow the user experience. On Android and iOS those modes require autoSplashscreen: true and @capacitor/splash-screen with launchAutoHide: false. Available on Android, iOS, and Electron.	`“atBackground” // true is still accepted`
`resetWhenUpdate`	`boolean`	{"text":"자동 업데이트를 비활성화합니다.","context":"/ko/docs/plugins/updater/api/"}	`true`
`updateUrl`	`string`	{"text":"백그라운드에서 자동으로 다운로드하고, 앱이 백그라운드에 이동하면 적용합니다.","context":"/ko/docs/plugins/updater/api/"}	`https://plugin.capgo.app/updates`
`channelUrl`	`string`	{"text":"새로운 설치 또는 네이티브 앱 업데이트가 발생할 때 즉시 적용합니다. 그 외의 경우 백그라운드에서 자동으로 다운로드합니다.","context":"/ko/docs/plugins/updater/api/"}	`https://plugin.capgo.app/channel_self`
`statsUrl`	`string`	{"text":"앱이 시작할 때 즉시 적용합니다. 그 외의 경우 백그라운드에서 자동으로 다운로드합니다.","context":"/ko/docs/plugins/updater/api/"}	`https://plugin.capgo.app/stats`
`publicKey`	`string`	버전 2에서 끝에서 끝으로 실시간 업데이트 암호화에 사용할 공개 키를 구성하십시오. 안드로이드, iOS, Electron에서 사용할 수 있습니다.	`undefined`	6.2.0
`version`	`string`	현재 앱 버전을 구성하십시오. 첫 번째 업데이트ー 요청에 사용됩니다. 설정하지 않으면 플러그인은 native code에서 버전을 가져옵니다. 안드로이드, iOS, Electron에서 사용할 수 있습니다.	`undefined`	4.17.48
`directUpdate`	`boolean \| ‘always’ \| ‘atInstall’ \| ‘onLaunch’`	deprecated. autoUpdate string modes 대신 사용하십시오: “atInstall”, “onLaunch”, 또는 “always”. 이 옵션은 기존 앱에 대해 지원됩니다. instant apply는 —delta 옵션과 함께 업로드되어 사용자 경험을 느리게 하지 않도록 하십시오. 안드로이드 및 iOS에서 이 모드는 autoSplashscreen: true 및 @capacitor/splash-screen에서 launchAutoHide: false를 필요로 합니다. - false: 직접 업데이트를 수행하지 않습니다. - atInstall: autoUpdate: “atInstall”와 동일합니다. - onLaunch: autoUpdate: “onLaunch”와 동일합니다. - always: autoUpdate: “always”와 동일합니다. - true: “always”와 동일합니다. backward compatibility를 위해. 안드로이드, iOS, Electron에서 사용할 수 있습니다.	`false`	5.1.0
`autoSplashscreen`	`boolean`	instant apply 모드 (“atInstall”, “onLaunch”, 또는 “always”) 및 deprecated directUpdate 값의 경우 필수입니다. @capacitor/splash-screen은 launchAutoHide: false로 구성되어 있어야 하며, 활성화 시 플러그인은 업데이트가 적용되거나 업데이트가 필요하지 않을 때 스플래시 스크린을 숨깁니다. 이로 인해 appReady 이벤트를 수신하고 SplashScreen.hide()를 호출하는 수동적인 작업을 생략할 수 있습니다. 안드로이드 및 iOS에서 사용할 수 있습니다.	`false`	7.6.0
`periodCheckDelay`	`number`	Configure the delay period for period update check. the unit is in seconds. Available on Android, iOS, and Electron. Cannot be less than 600 seconds (10 minutes).	`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, stats URL 및 channel 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로 설정하면 플러그인은 자바스크립트 콘솔에 로그를 기록하지 않습니다. native 로그만 수행됩니다.	`false`	7.3.0
`shakeMenu`	`boolean`	디버깅/테스트 목적으로 업데이트 메뉴를 표시하기 위해 shake 제스처를 활성화합니다.	`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을 사용하는 URL입니다.

Since: 5.4.0

setStatsUrl(…)

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

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

Param	Type	statistics를 보내는 URL을 포함합니다.
`options`	`StatsUrl`	Since:

setChannelUrl(…) 5.4.0

copy to clipboard

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

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

파라미터	타입	설명
`options`	`ChannelUrl`	channel을 설정하는 URL을 포함합니다.

Since: 5.4.0

다운로드(…)

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

지정된 URL에서 새로운 패키지를 다운로드합니다. 이 패키지는 zip 파일이어야 하며, 내부에 파일이 포함되어야 하거나, 유니크한 id를 가진 패키지여야 합니다.

속성	타입	설명
`options`	`DownloadOptions`	새로운 배포본 zip을 다운로드하는 데 사용되는 {@link} 다운로드 옵션} for downloading a new bundle 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} {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} Bundle ID를 설정하는 새로운 {BundleId} 객체.} object containing the ID of a bundle to delete (note, this is the bundle id, NOT the version name)

list(…)

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

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

Param	Type	설명
`options`	`ListOptions`	리스트 옵션 {@link ListOptions}을 위한 리턴:리스트 옵션 {@link ListOptions}을 위한

list(…) Promise<BundleListResult>

reset(…)

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

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

Type	설명	Containing {@link
`options`	`ResetOptions`	ResetOptions.toLastSuccessful builtin 번들을 사용하여 초기화하고 마지막으로 성공적으로 로드된 번들로 초기화됩니다.}, `true` Copy to clipboard `false` Reset the app to the

현재()

current() => Promise<CurrentBundleResult>

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

반환값: Promise<CurrentBundleResult>

재로드()

reload() => Promise<void>

뷰를 재로드합니다.

setMultiDelay(…)

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

업데이트 플러그인에 대한 {@link} DelayCondition배경화면 또는 앱을 종료한 후 업데이트가 설치될 수 있도록 업데이트 프로세스를 다시 시작합니다. date kind background kind nativeVersion kind kill kind

kind	이 옵션은 불일치한 동작을 보입니다. kill 옵션은 앱을 종료한 후 업데이트가 설치되지만, 배경화면을 종료한 후 업데이트가 설치되지 않습니다. 이 문제는 미래의 주요 릴리스에서 해결될 예정입니다.	Param
`options`	`MultiDelayConditions`	Type MultiDelayConditions업데이트를 설정하기 위한 조건의 배열

Since: 4.3.0

cancelDelay()

cancelDelay() => Promise<void>

업데이트를 즉시 처리하기 위해 {@link DelayCondition}을 취소합니다. Since:getLatest(…)

getLatest(…)를 취소하는 섹션 4.0.0

__CAPGO_KEEP_0__

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 백엔드와 채널을 검증한 후 장치에 선택된 채널을 저장합니다. 백엔드의 Device Override를 생성하거나 업데이트하지 않으므로 장치가 __CAPGO_KEEP_0__ 대시보드에서 오버라이드된 것으로 표시되지 않습니다. 대시보드 또는 Public __CAPGO_KEEP_1__에서만 생성된 assignment만 Device Override UI에서 표시됩니다.

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() to discover which channels are available and whether they allow self-assignment.

Param	Type	설명
`options`	`SetChannelOptions`	링크된 {@link SetChannelOptions} 채널을 설정합니다.

반환값: Promise<ChannelRes>

Since: 4.7.0

unsetChannel(…)

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

이 장치에 저장된 플러그인 관리 채널을 해제합니다. 이 메소드는 로컬 저장소에 저장된 채널만 삭제하고, Dashboard 또는 Public __CAPGO_KEEP_0__ Device Override 기록은 삭제하지 않습니다. 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에서 설정된 빌트인 버전을 가져옵니다

Returns: Promise<BuiltinVersion>

Since: 5.2.0

getDeviceId()

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>

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>

Since: 2.0.11

addListener(‘noNeedUpdate’, …)

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

업데이트가 필요하지 않은 이벤트를 듣기, 앱이 시작될 때마다 매번 업데이트 확인을 원할 때 유용합니다.

Param	형식
`eventName`	`‘noNeedUpdate’`
`listenerFunc`	`(state: NoNeedEvent) => void`

반환: Promise<PluginListenerHandle>

Since: 4.0.0

addListener(‘updateAvailable’, …)

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

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

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

반환: Promise<PluginListenerHandle>

버전: 4.0.0

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

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

파라미터

업데이트가 사용 가능한 이벤트를 듣기, 앱이 시작될 때마다 매번 체크하고 싶을 때 유용합니다.	형식
`eventName`	`‘downloadComplete’`
`listenerFunc`	`(state: DownloadCompleteEvent) => void`

반환: Promise<PluginListenerHandle>

Since: 4.0.0

addListener(‘majorAvailable’, …)

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

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

Param	형식
`eventName`	`‘majorAvailable’`
`listenerFunc`	`(state: MajorAvailableEvent) => void`

반환: 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

Section titled “다운로드 실패 이벤트 추가(‘downloadFailed’, …)””

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

Param

Param	형식
`eventName`	`‘downloadFailed’`
`listenerFunc`	`(state: DownloadFailedEvent) => void`

반환: Promise<PluginListenerHandle>

Since: 4.0.0

addListener(‘appReloaded’, …)

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

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

Param	형식
`eventName`	`‘appReloaded’`
`listenerFunc`	`() => void`

반환: 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>

Since: 5.1.0

자동 업데이트 여부를 확인합니다.

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 메뉴를 활성화하거나 비활성화할 수 있습니다.

Since: 7.5.0

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

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

반환: Promise<ShakeMenuEnabled>

Since: 7.5.0

인터페이스

AppReadyResult

속성	타입
`bundle`	`BundleInfo`

배포 정보

타입	업데이트 URL
`id`	`string`
`version`	`string`
`downloaded`	`string`
`checksum`	`string`
`status`	`BundleStatus`

속성

통계 URL	업데이트 URL
`url`	`string`

속성

속성	형식
`url`	`string`

ChannelUrl 제목

형식	다운로드 옵션 제목
`url`	`string`

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

This URL and versions are used to download the bundle from the server, If you use backend all information will be given by the method getLatest. If you don’t use backend, you need to provide the URL and version of the bundle. SessionKey are required if you encrypted the bundle with the CLI command encrypt, you should receive them as result of the command.

다운로드 옵션	속성	설명	기본값	시작
`url`	`string`	다운로드할 배포본 zip 파일의 URL (예: dist.zip)입니다. (이것은 어떤 URL이든 될 수 있습니다. 예를 들어 Amazon S3, GitHub 태그, 배포본을 호스팅한 다른 곳 등)
`version`	`string`	The version code/name of this bundle/version
`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`

__CAPGO_KEEP_0__

BundleId	BundleId
`id`	`string`

__CAPGO_KEEP_1__

BundleListResult	BundleListResult
`bundles`	`BundleInfo[]`

ListOptions

ListOptions	ListOptions	설명	기본값	Since
`raw`	`boolean`	수정된 버전을 반환할지 여부. true로 설정하면 내부 데이터베이스를 읽으려는 대신 디스크에 있는 파일을 읽으려고 시도합니다.	`false`	6.14.0

ResetOptions

속성	타입
`toLastSuccessful`	`boolean`

현재 버전 결과

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

MultiDelayConditions

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

DelayCondition

속성	타입	설명
`kind`	`DelayUntilNext`	setMultiDelay에서 지연 조건 설정
`value`	`string`

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

속성	타입	설명	기본값	버전
`channel`	`string`	최신 버전을 얻기 위한 채널	`undefined`	6.8.0

ChannelRes

속성	타입	설명	시작
`status`	`string`	설정된 채널의 현재 상태	4.7.0
`error`	`string`
`message`	`string`

SetChannelOptions

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

채널 옵션을 취소합니다

속성	형식
`triggerAutoUpdate`	`boolean`

채널 가져오기 결과

형식	설명	버전	채널 가져오기 현재 상태
`channel`	`string`	채널 목록 결과	4.8.0
`error`	`string`
`message`	`string`
`status`	`string`
`allowSet`	`boolean`

ListChannelsResult

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

ChannelInfo

타입	설명	버전	protectedTokens
`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

SetCustomIdOptions nameSetCustomIdOptions id.

속성

속성	형식
`customId`	`string`

__CAPGO_KEEP_0__

__CAPGO_KEEP_2__	__CAPGO_KEEP_3__
`version`	`string`

__CAPGO_KEEP_4__

__CAPGO_KEEP_6__	__CAPGO_KEEP_7__
`deviceId`	`string`

__CAPGO_KEEP_8__

__CAPGO_KEEP_10__	__CAPGO_KEEP_11__
`version`	`string`

자동 업데이트 활성화

속성	타입
`enabled`	`boolean`

플러그인 리스너 핸들

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

다운로드 이벤트

타입	다운로드 이벤트	설명	시작
`percent`	`number`	다운로드 진행률, 0에서 100까지.	4.0.0
`bundle`	`BundleInfo`

NoNeedEvent

속성	타입	설명	시작
`bundle`	`BundleInfo`	다운로드 진행률, 0에서 100까지.	4.0.0

업데이트 가능 이벤트

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

다운로드 완료 이벤트

속성	타입	설명	버전
`bundle`	`BundleInfo`	새 업데이트가 사용 가능한 경우 발생합니다.	4.0.0

메이저 버전 업데이트가 가능합니다.

속성	타입	설명	버전
`version`	`string`	새로운 메이저 버전이 업데이트되면 발송됩니다.	4.0.0

업데이트 실패 이벤트

타입	설명	업데이트 실패	Since
`bundle`	`BundleInfo`	설치 실패 시 발생하는 이벤트입니다.	4.0.0

DownloadFailedEvent

Prop	Type	설명	Since
`version`	`string`	다운로드 실패 시 발생하는 이벤트입니다.	4.0.0

AppReadyEvent

Prop	형식	설명	Since
`bundle`	`BundleInfo`	앱이 사용할 준비가 되었을 때 발생합니다.	5.2.0
`status`	`string`

자동 업데이트 가능

속성	형식
`available`	`boolean`

진동 메뉴 옵션 설정

형식	진동 메뉴 옵션 설정
`enabled`	`boolean`

ShakeMenuEnabled

속성	타입
`enabled`	`boolean`

타입 별명

BundleStatus

대기 중: 다음 번들로 설정될 준비가 된 번들이 있습니다. 다운로드 중: 번들이 다운로드 중입니다. 성공: 번들이 다운로드되었습니다. 다음 번들로 설정할 준비가 되었습니다. SET SET SET 다음 번들로 계속 진행. 오류: 번들이 다운로드에 실패했습니다.

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

DelayUntilNext

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

기능과 설정에서 계속 진행

Functions and settings을 사용하여 대시보드와 __CAPGO_KEEP_0__ 작업을 계획하고 있다면, __CAPGO_KEEP_0__-updater와 연결하세요. Using @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-updater Using @API/__CAPGO_KEEP_1__-updater를 사용하여 API 기능을 사용할 수 있습니다. Using @capgo/capacitor-updater for the native capability in Using @capgo/capacitor-updater, API Overview for the implementation detail in API Overview, 소개 소개에 대한 구현 세부 정보를 위해 API 키 API 키에 대한 구현 세부 정보를 위해, 그리고 장치 장치에 대한 구현 세부 정보를 위해