함수 및 설정

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

Updater Plugin 설정

자세한 내용은 Github Readme를 참조하세요.

CapacitorUpdater는 다음 옵션으로 설정할 수 있습니다:

Prop	유형	설명	기본값	이후
`appReadyTimeout`	`number`	네이티브 플러그인이 업데이트를 '실패'로 간주하기 전까지 대기할 밀리초(ms)를 설정합니다. Android, iOS, Electron에서 사용할 수 있습니다.	`10000 // (10 seconds)`
`responseTimeout`	`number`	네이티브 플러그인이 API가 타임아웃되었다고 간주하기 전까지 대기할 밀리초(ms)를 설정합니다. 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을 발생시키지만, 다음 번들은 자동으로 설정하지 않음. 즉시 적용 모드(“atInstall”, “onLaunch”, “always”)는 업데이트가 사용자 경험을 저해하지 않도록 —delta와 함께 업로드해야 합니다. Android 및 iOS에서 이 모드들을 사용하려면 autoSplashscreen: true와 launchAutoHide: false가 설정된 @capacitor/splash-screen가 필요합니다. Android, iOS, Electron에서 사용할 수 있습니다.	`“atBackground” // true is still accepted`
`resetWhenUpdate`	`boolean`	새로운 Native Build 번들이 기기에 설치될 때 이전 다운로드된 번들을 자동으로 삭제합니다. 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`	Version 2 live update 종단간 암호화를 위한 공개 키를 설정합니다. Android, iOS, Electron에서 사용 가능합니다.	`undefined`	6.2.0
`version`	`string`	앱의 현재 버전을 설정합니다. 이는 첫 번째 업데이트 요청 시 사용됩니다. 설정하지 않으면 플러그인이 네이티브 code에서 버전을 가져옵니다. Android, iOS, Electron에서 사용 가능합니다.	`undefined`	4.17.48
`directUpdate`	`boolean \| ‘always’ \| ‘atInstall’ \| ‘onLaunch’`	사용 중단 예정(Deprecated). 대신 autoUpdate 문자열 모드인 “atInstall”, “onLaunch” 또는 “always”를 사용하세요. 이 옵션은 기존 앱에 대해 계속 지원됩니다. 업데이트가 사용자 경험을 저해하지 않도록 Instant apply는 —delta와 함께 업로드해야 합니다. Android 및 iOS에서 이 모드들을 사용하려면 autoSplashscreen: true 및 launchAutoHide: false가 설정된 @capacitor/splash-screen가 필요합니다. - false: 직접 업데이트를 수행하지 않음 - atInstall: autoUpdate: “atInstall”과 동일 - onLaunch: autoUpdate: “onLaunch”와 동일 - always: autoUpdate: “always”와 동일 - true: 하위 호환성을 위해 “always”와 동일하게 동작합니다. Android, iOS, Electron에서 사용 가능합니다.	`false`	5.1.0
`autoSplashscreen`	`boolean`	사용 중단 예정인 directUpdate 값을 포함하여, 즉시 적용 모드(“atInstall”, “onLaunch” 또는 “always”)를 사용할 때 필수입니다. @capacitor/splash-screen가 설치되어 있어야 하며 launchAutoHide: false로 설정되어야 합니다. 이 옵션을 활성화하면 업데이트가 적용되거나 업데이트가 필요 없는 경우 플러그인이 자동으로 splashscreen을 숨깁니다. 이를 통해 appReady 이벤트를 수동으로 감지하고 SplashScreen.hide()를 호출할 필요가 없습니다. 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`	JavaScript 측에서 updateUrl, statsUrl 및 channelUrl을 동적으로 수정할 수 있도록 허용합니다.	`false`	5.4.0
`defaultChannel`	`string`	설정에서 앱의 기본 channel을 지정합니다. 대소문자를 구분합니다. 이 설정은 클라우드에 설정된 기본 channel을 덮어쓰지만, 클라우드에서 개별적으로 적용한 override 설정은 그대로 유지됩니다.	`undefined`	5.5.0
`appId`	`string`	config에서 앱의 appId를 설정합니다.	`undefined`	6.0.0
`keepUrlPathAfterReload`	`boolean`	새로고침 후에도 URL 경로를 유지하도록 플러그인을 설정합니다. 경고: 새로고침이 트리거되면 ‘window.history’가 초기화됩니다.	`false`	6.8.0
`disableJSLogging`	`boolean`	플러그인의 JavaScript 로깅을 비활성화합니다. true로 설정하면 플러그인이 JavaScript 콘솔에 로그를 남기지 않으며, 네이티브 로그만 기록됩니다.	`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>

현재 bundle이 정상 작동 중임을 Capacitor Updater에 알립니다 (이 메서드를 앱 실행 시마다 호출하지 않으면 롤백이 발생합니다). 기본적으로 앱 실행 후 10초 이내에 이 메서드를 호출해야 하며, 그렇지 않으면 롤백이 실행됩니다. {@link appReadyTimeout}을 통해 이 동작을 변경할 수 있습니다.

반환값: Promise<AppReadyResult>

setUpdateUrl(…)

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

앱의 updateUrl을 설정합니다. 이 URL은 업데이트 확인 시 사용됩니다.

파라미터	유형	설명
`options`	`UpdateUrl`	업데이트 확인 시 사용할 URL을 포함합니다.

지원 버전: 5.4.0

setStatsUrl(…)

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

앱의 statsUrl을 설정합니다. 이 URL은 통계 데이터를 전송하는 데 사용됩니다. 빈 문자열을 전달하면 통계 수집 기능이 비활성화됩니다.

파라미터	유형	설명
`options`	`StatsUrl`	통계 데이터를 전송할 때 사용할 URL을 포함합니다.

지원 버전: 5.4.0

setChannelUrl(…)

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

앱의 channelUrl을 설정합니다. 이 URL은 채널을 지정하는 데 사용됩니다.

파라미터	유형	설명
`options`	`ChannelUrl`	채널 설정을 위해 사용할 URL을 포함합니다.

지원 버전: 5.4.0

download(…)

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

제공된 URL에서 새 번들을 다운로드합니다. 번들은 zip 파일이어야 하며, 내부에 파일들이 직접 들어있거나 모든 파일이 포함된 고유 ID가 들어있어야 합니다.

파라미터	유형	설명
`options`	`DownloadOptions`	{@link} DownloadOptions}를 사용하여 새 번들 zip 파일을 다운로드합니다.

반환값: Promise<BundleInfo>

next(…)

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

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

파라미터	유형	설명
`options`	`BundleId`	다음 앱 실행 시 적용할 다음 Bundle의 ID를 포함합니다. {@link} BundleInfo.id}

반환값: Promise<BundleInfo>

set(…)

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

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

파라미터	유형	설명
`options`	`BundleId`	{@link} BundleId} 객체로, 현재 번들로 설정할 새로운 bundle id를 포함합니다.

delete(…)

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

네이티브 앱 스토리지에서 지정된 bundle을 삭제합니다. 저장된 Bundle ID 목록을 확인하려면 {@link list}와 함께 사용하세요.

파라미터	유형	설명
`options`	`BundleId`	{@link} BundleId} 삭제할 번들의 ID를 포함하는 객체 (주의: 버전 이름이 아닌 번들 ID입니다)

list(…)

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

앱에 로컬로 다운로드된 모든 번들 가져오기

파라미터	유형	설명
`options`	`ListOptions`	{@link} ListOptions} 번들 목록 조회용

반환값: Promise<BundleListResult>

reset(…)

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

앱을 다음 상태로 초기화합니다: builtin bundle(Apple App Store / Google Play Store에 전송된 버전) 또는 마지막으로 성공적으로 로드된 bundle.

파라미터	유형	설명
`options`	`ResetOptions`	{@link ResetOptions.toLastSuccessful} 포함}, `true` 내장된 bundle로 초기화하고 `false` 마지막으로 성공적으로 로드된 bundle로 재설정됩니다.

current()

current() => Promise<CurrentBundleResult>

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

반환값: Promise<CurrentBundleResult>

reload()

reload() => Promise<void>

뷰를 reload합니다.

setMultiDelay(…)

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

{@link DelayCondition} 배열을 설정합니다. 이 배열에는 플러그인이 업데이트를 지연하는 데 사용할 조건이 포함됩니다. 모든 조건이 충족되면 업데이트 프로세스가 평소처럼 다시 시작되어, 앱을 백그라운드로 전환하거나 종료한 후에 업데이트가 설치됩니다. date kind의 경우, 값은 iso8601 날짜 문자열이어야 합니다. background kind의 경우, 값은 밀리초 단위의 숫자여야 합니다. nativeVersion kind의 경우, 값은 버전 번호여야 합니다. kill kind의 경우, 값은 사용되지 않습니다. kill 옵션은 첫 번째 kill 후에 업데이트를 트리거하고, 다른 옵션들과 달리 다음 백그라운드 전환 후에는 트리거하지 않아 동작이 일관되지 않습니다. 이 문제는 향후 메이저 릴리스에서 수정될 예정입니다.

파라미터	유형	설명
`options`	`MultiDelayConditions`	{@link}을(를) 포함하는 MultiDelayConditions 조건 배열을 설정합니다.

지원 버전: 4.3.0

cancelDelay()

cancelDelay() => Promise<void>

{@link}을(를) 취소하여 DelayCondition 업데이트를 즉시 처리합니다.

지원 버전: 4.0.0

getLatest(…)

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

update URL에서 사용 가능한 최신 bundle 가져오기

파라미터	유형
`options`	`GetLatestOptions`

반환값: Promise<LatestVersion>

지원 버전: 4.0.0

setChannel(…)

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

이 디바이스에 대해 플러그인이 관리하는 로컬 채널을 설정합니다. 채널은 반드시 allow_device_self_set 활성화되어 있어야 이 기능이 작동합니다.

setChannel() 백엔드에서 채널 유효성을 검사한 다음, 선택한 채널을 기기에 로컬로 저장합니다. 이 방식은 백엔드 Device Override를 생성하거나 업데이트하지 않으므로, Capgo 대시보드에서 해당 기기가 override된 것으로 표시되지 않습니다. 대시보드나 Public API에서 생성된 할당만 Device Override UI에 표시됩니다.

중요 사항:

앱 부팅 시 채널을 설정할 때 이 메서드를 사용하지 마세요. 대신 defaultChannel 를 Capacitor 설정에서 사용하세요.
이 메서드는 앱이 준비되고 사용자가 상호작용한 뒤(예: 베타 프로그램 참여) 사용하기 위한 것입니다.
Public 채널은 직접 할당할 수 없습니다. 채널이 public로 표시된 경우, setChannel() 를 호출하면 에러가 반환됩니다. Public 채널을 사용하려면 unsetChannel() 를 호출하세요. 그러면 기기가 자동으로 일치하는 Public 채널로 전환됩니다.
사용 listChannels() 를 사용하여 사용 가능한 채널과 직접 할당 가능 여부를 확인하세요.

파라미터	유형	설명
`options`	`SetChannelOptions`	{@link} SetChannelOptions} 채널이

반환값: Promise<ChannelRes>

지원 버전: 4.7.0

unsetChannel(…)

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

Unset the plugin-managed local channel for this device. This clears only the channel stored locally by setChannel(); Dashboard 또는 Public API Device Override 레코드는 삭제하지 않습니다.

이 메서드를 호출한 후에는 기존 채널 우선순위가 적용됩니다. 즉, 기존의 Dashboard 또는 Public API Device Override가 여전히 우선하며, 그렇지 않은 경우에만 해당 기기의 조건(platform, device type, build type)에 맞는 public/default 채널로 전환됩니다.

다음과 같은 경우에 유용합니다:

기기를 다시 기본 업데이트 트랙으로 되돌리고 싶을 때
Public 채널을 사용하고 싶을 때 (Public 채널은 다음과 같이 직접 할당할 수 없으므로 setChannel())

파라미터	유형
`options`	`UnsetChannelOptions`

지원 버전: 4.7.0

getChannel()을 통해

getChannel() => Promise<GetChannelRes>

이 기기의 채널 가져오기

반환값: Promise<GetChannelRes>

지원 버전: 4.8.0

listChannels()

listChannels() => Promise<ListChannelsResult>

이 디바이스에서 사용 가능한 모든 채널을 나열합니다. 디바이스의 현재 환경(플랫폼, 에뮬레이터/실제 디바이스, dev/prod 빌드)과 호환되며, 공개 상태이거나 직접 할당이 가능한 채널을 반환합니다.

결과값의 각 채널에는 다음 항목이 포함됩니다:

public: 만약 true, 이것은 기본 채널입니다. 다음을 사용하여 직접 할당할 수 없습니다: setChannel(). 대신, 다음을 사용하여 채널 할당을 해제하면 unsetChannel(), 해당 기기는 이 퍼블릭 채널로부터 업데이트를 자동으로 수신합니다.
allow_self_set: 만약 true, 이것은 직접 지정 가능한 채널입니다. 다음을 사용하여 기기에 이 채널을 명시적으로 할당할 수 있습니다: setChannel().

반환값: Promise<ListChannelsResult>

지원 버전: 7.5.0

setCustomId(…)

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

이 기기에 대한 커스텀 ID 설정

파라미터	유형	설명
`options`	`SetCustomIdOptions`	설정할 {@link SetCustomIdOptions} customId입니다

지원 버전: 4.9.0

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

네이티브 앱 버전 또는 config에 설정된 builtin 버전을 가져옵니다

반환값: Promise<BuiltinVersion>

지원 버전: 5.2.0

getDeviceId()

getDeviceId() => Promise<DeviceId>

기기 식별에 사용되는 고유 ID를 가져옵니다 (auto update 서버로 전송됨)

반환값: Promise<DeviceId>

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

네이티브 Capacitor Updater 플러그인 버전을 가져옵니다 (auto update 서버로 전송됨)

반환값: Promise<PluginVersion>

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

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

반환값: Promise<AutoUpdateEnabled>

removeAllListeners()

removeAllListeners() => Promise<void>

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

지원 버전: 1.0.0

addListener(‘download’, …)

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

앱에서 bundle download 이벤트를 수신합니다. 다운로드가 시작될 때, 진행 중일 때, 완료될 때 발생합니다. 다운로드 중 모든 다운로드 퍼센트를 반환합니다.

파라미터	유형
`eventName`	`‘download’`
`listenerFunc`	`(state: DownloadEvent) => void`

반환값: Promise<PluginListenerHandle>

지원 버전: 2.0.11

addListener(‘noNeedUpdate’, …)

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

noNeedUpdate 이벤트를 수신합니다. 앱이 실행될 때마다 강제로 업데이트를 확인하고 싶을 때 유용합니다.

파라미터	유형
`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>

지원 버전: 4.0.0

addListener(‘downloadComplete’, …)

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

downloadComplete 이벤트를 감지합니다.

파라미터	유형
`eventName`	`‘downloadComplete’`
`listenerFunc`	`(state: DownloadCompleteEvent) => void`

반환값: Promise<PluginListenerHandle>

지원 버전: 4.0.0

addListener(‘majorAvailable’, …)

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

앱 내 Major update 이벤트를 감지합니다. disableAutoUpdateBreaking 설정으로 인해 Major update가 차단되었을 때 알림을 받을 수 있습니다.

파라미터	유형
`eventName`	`‘majorAvailable’`
`listenerFunc`	`(state: MajorAvailableEvent) => void`

반환값: Promise<PluginListenerHandle>

지원 버전: 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

addListener(‘appReloaded’, …)

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

App의 reload 이벤트를 감지하여 reload가 완료되었음을 알려줍니다

파라미터	유형
`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>

자동 업데이트가 가능한지 확인합니다 (serverUrl에 의해 비활성화되지 않은 경우).

반환값: Promise<AutoUpdateAvailable>

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

앱이 재실행될 때 사용할 다음 bundle을 가져옵니다. 설정된 다음 bundle이 없으면 null을 반환합니다.

반환값: Promise<BundleInfo | null>

지원 버전: 6.8.0

setShakeMenu(…)

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

디버깅 및 테스트를 위한 shake menu 활성화 또는 비활성화

파라미터	유형	설명
`options`	`SetShakeMenuOptions`	shake menu 활성화 여부를 설정하는 boolean 값을 포함합니다

지원 버전: 7.5.0

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

shake menu의 현재 상태를 가져옵니다

반환값: Promise<ShakeMenuEnabled>

지원 버전: 7.5.0

인터페이스

AppReadyResult

Prop	유형
`bundle`	`BundleInfo`

BundleInfo

Prop	유형
`id`	`string`
`version`	`string`
`downloaded`	`string`
`checksum`	`string`
`status`	`BundleStatus`

UpdateUrl

Prop	유형
`url`	`string`

StatsUrl

Prop	유형
`url`	`string`

ChannelUrl

Prop	유형
`url`	`string`

DownloadOptions

이 URL과 버전은 서버에서 bundle을 download하는 데 사용됩니다. 백엔드를 사용하는 경우 모든 정보는 getLatest 메서드를 통해 제공됩니다. 백엔드를 사용하지 않는 경우, bundle의 URL과 버전을 직접 제공해야 합니다. CLI encrypt 명령어로 bundle을 암호화했다면 SessionKey가 필요하며, 이는 해당 명령의 결과값으로 받으실 수 있습니다.

Prop	유형	설명	기본값	이후
`url`	`string`	다운로드할 번들 zip 파일의 URL (예: dist.zip). (Amazon S3, GitHub 태그, 또는 번들이 호스팅된 다른 모든 URL이 가능합니다.)
`version`	`string`	해당 번들/버전의 code 버전 또는 이름
`sessionKey`	`string`	번들이 세션 키로 암호화된 경우, 업데이트에 사용되는 세션 키	`undefined`	4.0.0
`checksum`	`string`	업데이트용 체크섬. sha256 형식이어야 하며, 번들이 암호화된 경우 개인 키로 암호화되어야 합니다.	`undefined`	4.0.0
`manifest`	`ManifestEntry[]`	Delta (manifest) 멀티 파일 다운로드를 위한 매니페스트	`undefined`	6.1.0

ManifestEntry

Prop	유형
`file_name`	`string \| null`
`file_hash`	`string \| null`
`download_url`	`string \| null`

BundleId

Prop	유형
`id`	`string`

BundleListResult

Prop	유형
`bundles`	`BundleInfo[]`

ListOptions

Prop	유형	설명	기본값	이후
`raw`	`boolean`	raw bundle 목록을 반환할지 manifest를 반환할지 여부입니다. true이면 목록은 디스크의 파일 대신 내부 데이터베이스를 읽으려고 시도합니다.	`false`	6.14.0

ResetOptions

Prop	유형
`toLastSuccessful`	`boolean`

CurrentBundleResult

Prop	유형
`bundle`	`BundleInfo`
`native`	`string`

MultiDelayConditions

Prop	유형
`delayConditions`	`DelayCondition[]`

DelayCondition

Prop	유형	설명
`kind`	`DelayUntilNext`	setMultiDelay에서 지연 조건 설정하기
`value`	`string`

LatestVersion

속성	유형	설명	이후
`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`	최신 버전을 가져올 채널입니다. 이 기능이 작동하려면 채널에서 ‘self_assign’을 허용해야 합니다.	`undefined`	6.8.0

ChannelRes

Prop	유형	설명	이후
`status`	`string`	설정된 채널의 현재 상태	4.7.0
`error`	`string`
`message`	`string`

SetChannelOptions

Prop	유형
`channel`	`string`
`triggerAutoUpdate`	`boolean`

UnsetChannelOptions

Prop	유형
`triggerAutoUpdate`	`boolean`

GetChannelRes

Prop	유형	설명	이후
`channel`	`string`	get channel의 현재 상태	4.8.0
`error`	`string`
`message`	`string`
`status`	`string`
`allowSet`	`boolean`

ListChannelsResult

Prop	유형	설명	이후
`channels`	`ChannelInfo[]`	사용 가능한 채널 목록	7.5.0

ChannelInfo

Prop	유형	설명	이후
`id`	`number`	숫자로 된 채널 ID	7.5.0
`name`	`string`	채널 이름	7.5.0
`public`	`boolean`	true인 경우, 이 채널은 기본/폴백 채널입니다. 디바이스는 공개 채널을 직접 지정할 수 없습니다. 대신, 디바이스가 채널 오버라이드를 제거하면( `unsetChannel()` 사용하여), 일치하는 공개 채널로부터 업데이트를 자동으로 받게 됩니다.	7.5.0
`allow_self_set`	`boolean`	true인 경우, 디바이스는 `setChannel()`를 사용하여 이 채널을 명시적으로 지정할 수 있습니다. 주로 베타 테스트, A/B 테스트 또는 옵트인 업데이트 트랙에 사용됩니다.	7.5.0

채널 명령은 name을 사용하며, 이 숫자형은 아닙니다. id.

SetCustomIdOptions

Prop	유형
`customId`	`string`

BuiltinVersion

Prop	유형
`version`	`string`

DeviceId

Prop	유형
`deviceId`	`string`

PluginVersion

Prop	유형
`version`	`string`

AutoUpdateEnabled

Prop	유형
`enabled`	`boolean`

PluginListenerHandle

Prop	유형
`remove`	`() => Promise<void>`

DownloadEvent

Prop	유형	설명	이후
`percent`	`number`	다운로드 진행 상태 (0에서 100 사이).	4.0.0
`bundle`	`BundleInfo`

NoNeedEvent

Prop	유형	설명	이후
`bundle`	`BundleInfo`	다운로드 진행 상태 (0에서 100 사이).	4.0.0

UpdateAvailableEvent

Prop	유형	설명	이후
`bundle`	`BundleInfo`	다운로드 진행 상태 (0에서 100 사이).	4.0.0

DownloadCompleteEvent

Prop	유형	설명	이후
`bundle`	`BundleInfo`	새로운 업데이트가 사용 가능할 때 발생합니다.	4.0.0

MajorAvailableEvent

Prop	유형	설명	이후
`version`	`string`	새로운 메이저 번들이 사용 가능할 때 발생합니다.	4.0.0

UpdateFailedEvent

Prop	유형	설명	이후
`bundle`	`BundleInfo`	업데이트 설치에 실패했을 때 발생합니다.	4.0.0

DownloadFailedEvent

Prop	유형	설명	이후
`version`	`string`	다운로드가 실패했을 때 발생합니다.	4.0.0

AppReadyEvent

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

AutoUpdateAvailable

Prop	유형
`available`	`boolean`

SetShakeMenuOptions

Prop	유형
`enabled`	`boolean`

ShakeMenuEnabled

Prop	유형
`enabled`	`boolean`

타입 별칭

BundleStatus

pending: 번들이 다음 번들로 SET 설정되기를 대기 중입니다. downloading: 번들을 다운로드 중입니다. success: 번들 다운로드가 완료되어 사용할 준비가 되었습니다. 설정 를 다음 번들로 설정합니다. error: 번들 다운로드에 실패했습니다.

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

DelayUntilNext

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

Functions 및 설정에서 계속하기

사용 중이라면 함수 및 설정 대시보드 및 API 운영을 계획하려면, 이를 다음과 연결하세요 @capgo/capacitor-updater 사용하기 네이티브 기능의 경우 @capgo/capacitor-updater 사용하기에서, API 개요 구현 세부 사항은 API 개요에서 소개 구현 세부 사항은 소개에서 API 키 API Keys의 구현 세부 사항은, 기기 Devices의 구현 세부 사항은.