기능과 설정

설치 단계와 이 플러그인의 전체 마크다운 가이드를 포함한 설치提示 복사

업데이터 플러그인 설정

Github를 참조하십시오. README __CAPGO_KEEP_0__

CapacitorUpdater를 설정할 수 있는 옵션입니다.

속성	타입	설명	기본값	시작 버전
`appReadyTimeout`	`number`	Android, iOS 및 Electron에서 native 플러그인을 업데이트하기 전에 기다리는 밀리초 수를 설정합니다.	`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’`	Android, iOS 및 Electron에서 Auto Update를 사용할지 여부를 설정합니다. true는 ‘atBackground’과 동일하며, false는 ‘off’과 동일합니다. - off: Auto Update를 비활성화합니다. - atBackground: 앱이 배경으로 이동할 때 자동으로 다운로드하고 적용합니다. - atInstall: 새로운 설치 또는 네이티브 앱 업데이트가 발생한 경우 즉시 적용하고, 그렇지 않은 경우 atBackground을 사용합니다. - onLaunch: 앱이 시작될 때 즉시 적용하고, 그렇지 않은 경우 atBackground을 사용합니다. - always: Auto Update가 실행될 때마다 즉시 적용합니다. - onlyDownload: 자동으로 다운로드하고, updateAvailable 이벤트를.emit하고, 다음 패키지를 자동으로 설정하지 않습니다.	`”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’`	deprecated. 사용하는 옵션을 변경하세요: “atInstall”, “onLaunch”, 또는 “always”. 이 옵션은 기존 앱에 대해 지원됩니다. - false: 직접 업데이트를 수행하지 않습니다. - atInstall: autoUpdate: “atInstall”와 동일합니다. - onLaunch: autoUpdate: “onLaunch”와 동일합니다. - always: autoUpdate: “always”와 동일합니다. - true: “always”와 동일합니다. Android, iOS, Electron에서 사용 가능합니다.	`false`	5.1.0
`autoSplashscreen`	`boolean`	자동으로 스플래시 화면을 숨기는 모드를 사용할 때 스플래시 화면을 숨기는 기능을 자동으로 처리합니다. 활성화 시, 업데이트 적용이 완료되거나 업데이트가 필요하지 않은 경우 스플래시 화면을 자동으로 숨깁니다. 이 기능은 앱이 준비되면 자동으로 스플래시 화면을 숨기는 이벤트를 수동으로 듣고 스플래시 화면을 숨기는 함수를 호출하는 필요성을 제거합니다. 이 기능은 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을 자바스크립트에서 동적으로 수정할 수 있도록 플러그인을 허용합니다.	`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>

Notify Capacitor Updater that the current bundle is working (a rollback will occur if this method is not called on every app launch) By default this method should be called in the first 10 sec after app launch, otherwise a rollback will occur. Change this behaviour with {@link appReadyTimeout}

현재 버전이 작동 중인지 __CAPGO_KEEP_0__ Updater에 알립니다. (이 메서드가 앱 런치 시마다 호출되지 않으면 롤백이 발생합니다.) 기본적으로 이 메서드는 앱 런치 후 10초 이내에 호출되어야 합니다. 그렇지 않으면 롤백이 발생합니다. 이 동작을 변경하려면 {@link appReadyTimeout}을 참조하세요. Promise<AppReadyResult>

Returns:

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

Copy to clipboard

속성	타입	설명
`options`	`UpdateUrl`	업데이트를 확인하기 위한 URL을 포함합니다.

Since: 5.4.0

setStatsUrl(…)

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

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

속성	타입	설명
`options`	`StatsUrl`	statistic을 전송하기 위한 URL을 포함합니다.

Since: 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>

지정된 URL에서 새로운 번들을 다운로드합니다. 이 번들은 zip 파일이어야 하며, 내부에 파일이 들어가거나, 유니크한 id를 가진 파일이 들어가야 합니다.

Param	Type	설명
`options`	`DownloadOptions`	다운로드 옵션 {@link} 다운로드Options}을 사용하여 새로운 번들을 다운로드하는 zip 파일을 다운로드합니다.

반환: Promise<BundleInfo>

다음(…) 섹션

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

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

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

반환값: Promise<BundleInfo>

set(…)

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

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

속성	타입	설명
`options`	`BundleId`	새로 설정할 현재 버전의 {@link} BundleId} 객체입니다.

delete(…)

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

삭제

삭제	삭제	설명
`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	설명	The {@link}
`options`	`ListOptions`	The {@link 리스트 옵션}으로 번들 목록

반환: Promise<BundleListResult>

reset(…)

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

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

타입	설명	{@link
`options`	`ResetOptions`	https://capgo.io/docs/plugins/updater/api/} 포함 ResetOptions.toLastSuccessful}, `true` resets to the builtin bundle and `false` will reset to the last successfully loaded bundle.

current()

current() => Promise<CurrentBundleResult>

Get the current bundle, if none are set it returns builtin. currentNative is the original bundle installed on the device

Returns: Promise<CurrentBundleResult>

reload()

reload() => Promise<void>

뷰를 다시 로드하세요.

setMultiDelay(…)

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

업데이트를 위한 {@link DelayCondition} 배열을 설정합니다. DelayConditionDelayCondition date 업데이트를 위한 조건이 모두 충족되면, 업데이트 프로세스는 다시 시작되어 일반적으로 업데이트가 설치됩니다. 배경화면 또는 앱을 종료한 후 업데이트가 설치됩니다. background kind의 경우 iso8601 날짜 문자열이어야 합니다. nativeVersion kind의 경우 밀리초 단위의 숫자이어야 합니다. kill kind의 경우 버전 번호이어야 합니다.

kind의 경우 사용되지 않습니다. 이 옵션은 kill 옵션과 다른 동작을 하며, 이 문제는 미래의 주요 릴리스에서 수정될 예정입니다.	형식	설명
`options`	`MultiDelayConditions`	{@link을 포함하여 MultiDelayConditions} 업데이트 처리를 즉시 시작하기 위해 설정하는 조건의 배열입니다.

Since: 4.3.0

cancelDelay()

cancelDelay() => Promise<void>

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

Since: 4.0.0

getLatest(…)

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

최신 업데이트로 부터 사용 가능한 배포본을 가져옵니다.

파라미터	타입
`options`	`GetLatestOptions`

반환: Promise<LatestVersion>

Since: 4.0.0

setChannel(…)

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

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

setChannel() 채널을 백엔드와 검증한 후, 선택한 채널을 장치에 저장합니다. 이 메소드는 백엔드의 Device Override를 생성하거나 업데이트하지 않으므로, 장치가 Capgo 대시보드에서 오버라이드된 것으로 표시되지 않습니다. 대시보드나 Public API에서만 생성된 assignment만 Device Override UI에서 표시됩니다.

중요한 주의사항:

이 메소드를 부팅 시 채널을 설정하지 마십시오. 대신 __CAPGO_KEEP_0__ config에 defaultChannel in your Capacitor config instead.
이 메소드는 앱이 준비되었을 때 사용자가 상호작용(예: 베타 프로그램에 가입) 한 후에 사용됩니다.
공개 채널은 자체 assign할 수 없습니다. 채널이 public으로 표시된 경우, setChannel() 을 호출하면 오류가 반환됩니다. 공개 채널을 사용하려면 대신 unsetChannel() 을 호출하십시오 - 장치는 자동으로 일치하는 공개 채널로 전환됩니다.
사용 listChannels() 을 사용하여

파라미터	타입	설명
`options`	`SetChannelOptions`	링크된 {@link SetChannelOptions} channel을 설정하는

반환: Promise<ChannelRes>

since: 4.7.0

unsetChannel(…)

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

이 장치에 저장된 플러그인 관리 채널을 취소합니다. 이 메소드는 로컬로 저장된 채널만 삭제하고, setChannel(); it does not delete Dashboard or Public API Device Override records.

After calling this method, normal channel precedence applies: an existing Dashboard or Public API Device Override still wins; otherwise the device can fall back to the matching public/default channel for its conditions (platform, device type, build type).

또는

기기 오버라이드 레코드가 우선합니다. 그렇지 않으면, 기기는 플랫폼, 기기 종류, 빌드 종류에 따라 일치하는 공용/기본 채널로 돌아갑니다.
이것은 유용합니다. setChannel())

기기 업데이트 트랙을 기본으로 되돌리려면	공용 채널을 사용하려면(공용 채널은
`options`	`UnsetChannelOptions`

Param 4.7.0

Type

getChannel() => Promise<GetChannelRes>

이 기기의 채널을 가져오기

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

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

Param	Type	설명
`options`	`SetCustomIdOptions`	is the {@link} SetCustomIdOptions} 사용자 정의 ID를 설정합니다.

Since: 4.9.0

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

설정된 구성에서 빌트인 버전이 있는 경우 native 앱 버전 또는 빌트인 버전을 가져옵니다.

반환값: 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() => Promise<AutoUpdateEnabled>

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

반환값: Promise<AutoUpdateEnabled>

모든 리스너를 제거합니다.

removeAllListeners() => Promise<void>

사용 가능한 시점:

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

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

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

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

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

반환: Promise<PluginListenerHandle>

Since: 2.0.11

addListener(‘noNeedUpdate’, …)

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

앱이 시작될 때마다 매번 업데이트 확인을 강제하고 싶을 때 유용합니다.

파라미터	타입
`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>

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>

Since: 4.0.0

addListener(‘majorAvailable’, …)

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

Param

Type	protectedTokens
`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>

Since: 2.3.0

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

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

앱에서 다운로드 실패 이벤트를 듣고, 다운로드가 실패했을 때 알려줍니다.

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

반환: Promise<PluginListenerHandle>

Since: 4.0.0

addListener('appReloaded', …) - 앱이 다시 로드되었습니다.

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

파라미터

타입	__CAPGO_KEEP_0__
`eventName`	`’appReloaded’`
`listenerFunc`	`() => void`

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

반환값: 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 메뉴를 활성화/비활성화할 수 있습니다

Param	Type	설명
`options`	`SetShakeMenuOptions`	활성화/비활성화 여부를 포함하는 boolean

Since: 7.5.0

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

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

반환: Promise<ShakeMenuEnabled>

Since: 7.5.0

인터페이스

앱준비 결과

속성	타입
`bundle`	`BundleInfo`

배포 정보

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

업데이트 URL

속성	형식
`url`	`string`

StatsUrl

속성	형식
`url`	`string`

채널 URL

속성	형식
`url`	`string`

다운로드 옵션

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

속성	형식	설명	기본값	버전
`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`

BundleId

속성	타입
`id`	`string`

BundleListResult

타입	ListOptions
`bundles`	`BundleInfo[]`

__CAPGO_KEEP_0__

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

ResetOptions

타입	CurrentBundleResult
`toLastSuccessful`	`boolean`

protectedTokens

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

멀티 지연 조건

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

지연 조건

속성	형식	설명
`kind`	`DelayUntilNext`	설정 지연 조건을 설정합니다.
`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

getLatest 옵션

속성	타입	설명	기본값	Since
`channel`	`string`	최신 버전을 가져올 채널을 지정합니다. 채널은 'self_assign' 권한이 있어야 합니다.	`undefined`	6.8.0

ChannelRes

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

SetChannelOptions

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

SetChannelOptions를 해제

타입	GetChannelRes
`triggerAutoUpdate`	`boolean`

속성

설명	설명	설명	Since
`channel`	`string`	채널 정보 가져오기 현재 상태	4.8.0
`error`	`string`
`message`	`string`
`status`	`string`
`allowSet`	`boolean`

ListChannelsResult

Prop	Type	설명	Since
`channels`	`ChannelInfo[]`	사용 가능한 채널 목록	7.5.0

ChannelInfo

Prop	형식	설명	버전
`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 name, not this numeric id.

SetCustomIdOptions

속성	타입
`customId`	`string`

내장 버전

속성	타입
`version`	`string`

기기 ID

속성	타입
`deviceId`	`string`

플러그인 버전

속성	타입
`version`	`string`

자동 업데이트 가능

속성	타입
`enabled`	`boolean`

플러그인 리스너 핸들

타입	다운로드 이벤트
`remove`	`() => Promise<void>`

속성

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

필요없음 이벤트

타입	설명	버전	__CAPGO_KEEP_0__
`bundle`	`BundleInfo`	다운로드 진행 상태, 0과 100 사이.	4.0.0

업데이트 가능 이벤트

속성	타입	설명	시작
`bundle`	`BundleInfo`	다운로드 진행 상태, 0과 100 사이.	4.0.0

다운로드 완료 이벤트

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

MajorAvailableEvent

속성	타입	설명	Since
`version`	`string`	새 주요 버전이 있는 경우 발생합니다.	4.0.0

UpdateFailedEvent

속성	타입	설명	Since
`bundle`	`BundleInfo`	다운로드 실패 이벤트	4.0.0

다운로드 실패 이벤트 섹션

타입	설명	Since	다운로드 실패 이벤트
`version`	`string`	다운로드 실패 이벤트 발생 시	4.0.0

앱 준비 이벤트

속성	타입	설명	시작
`bundle`	`BundleInfo`	앱이 사용할 준비가 되었을 때 방출됩니다.	5.2.0
`status`	`string`

자동 업데이트 가능

타입	셰이크 메뉴 옵션 설정
`available`	`boolean`

AutoUpdateAvailable

속성	타입
`enabled`	`boolean`

ShakeMenuEnabled

타입	타입 별칭
`enabled`	`boolean`

BundleStatus

대기 중: 배포가 준비 중입니다.

대기 중: 배포가 준비 중입니다. SET 다음 버전으로 설정합니다. 다운로드 중입니다. 버전이 다운로드 중입니다. 다운로드 성공

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

다운로드 성공. 다운로드가 완료되었습니다.

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

다운로드 실패

DelayUntilNext DelayUntilNext to plan dashboard and API operations, connect it with Using @capgo/capacitor-updater Capgo의 내장 기능을 사용하는 @capgo/capacitor-업데이터터에 대해 API 개요 for the implementation detail in API Overview, 소개 Capgo의 구현 세부 정보에 대해 API 키 for the implementation detail in API Keys, and 장치 페이지 편집

기능과 설정

업데이터 플러그인 설정

예시

메서드

notifyAppReady()

Returns:

setStatsUrl(…)

setChannelUrl(…)

download(…)

다음(…) 섹션

set(…)

delete(…)

Section titled “list(…)”

reset(…)

current()

reload()

setMultiDelay(…)

cancelDelay()

getLatest(…)

setChannel(…)

unsetChannel(…)

Type

listChannels()

setCustomId(…)에 대한 섹션

getBuiltinVersion()

getDeviceId()

getPluginVersion()

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

모든 리스너를 제거합니다.

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

addListener(‘noNeedUpdate’, …)

addListener(‘updateAvailable’, …)

addListener(‘downloadComplete’, …)

addListener(‘majorAvailable’, …)

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

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

addListener('appReloaded', …) - 앱이 다시 로드되었습니다.

addListener('appReady', …) 함수를 호출합니다.

isAutoUpdateAvailable() 함수를 호출합니다.

getNextBundle()

setShakeMenu(…)

isShakeMenuEnabled()

인터페이스

앱준비 결과

배포 정보

업데이트 URL

StatsUrl

채널 URL

다운로드 옵션

매니페스트 항목

BundleId

BundleListResult

__CAPGO_KEEP_0__

ResetOptions

protectedTokens

멀티 지연 조건

지연 조건

최신 버전

getLatest 옵션

ChannelRes

SetChannelOptions

SetChannelOptions를 해제

속성

ListChannelsResult

ChannelInfo

SetCustomIdOptions

내장 버전

기기 ID

플러그인 버전

자동 업데이트 가능

플러그인 리스너 핸들

속성

필요없음 이벤트

업데이트 가능 이벤트

다운로드 완료 이벤트

MajorAvailableEvent

UpdateFailedEvent

다운로드 실패 이벤트 섹션

앱 준비 이벤트

자동 업데이트 가능