기능과 설정

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

업데이터 플러그인 설정

Github를 보세요. README for more information.

CapacitorUpdater가 다음 옵션과 함께 구성될 수 있습니다.

속성	형식	설명	기본값	Since
`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 \| ‘off’ \| ‘atBackground’ \| ‘atInstall’ \| ‘onLaunch’ \| ‘always’ \| ‘onlyDownload’`	Android, iOS 및 Electron에서 플러그인이 업데이트를 자동으로 사용할지 설정합니다. true는 ‘atBackground’와 동일하며 false는 ‘off’와 동일합니다. - off: 업데이트를 비활성화합니다. - atBackground: 앱이 배경으로 이동할 때 자동으로 다운로드하고 적용합니다. - atInstall: 새로운 설치 또는 네이티브 앱 업데이트가 발생한 후에 즉시 적용합니다. 그 외의 경우 atBackground를 사용합니다. - onLaunch: 앱이 시작될 때 즉시 적용합니다. 그 외의 경우 배경에서 확인한 후 atBackground를 사용합니다. - always: 업데이트를 즉시 적용합니다. - onlyDownload: 업데이트를 자동으로 다운로드하고 updateAvailable 이벤트를.emit하고 다음 패키지를 자동으로 설정하지 않습니다. Android, iOS 및 Electron에서 사용할 수 있습니다.	`”atBackground” // true is still accepted`
`resetWhenUpdate`	`boolean`	__CAPGO_KEEP_0__ 이전 다운로드 패키지를 자동으로 삭제합니다. 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`	앱의 현재 버전을 설정합니다. 첫 번째 업데이트 요청을 위해 사용됩니다. 설정하지 않으면 플러그인은 native 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`	자동으로 스플래시 스크린을 숨기는 모드가 사용될 때 스플래시 스크린을 숨기는 기능을 자동으로 처리합니다. 활성화 시, 업데이트 적용이 완료되거나 업데이트가 필요하지 않을 때 스플래시 스크린을 자동으로 숨깁니다. 이 기능은 appReady 이벤트를 수동으로 듣고 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을 사용하여 로컬 __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`	__CAPGO_KEEP_0__을 사용하여 업데이트 URL, statsURL, 및 channelURL을 동적으로 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`	__CAPGO_KEEP_3__

__CAPGO_KEEP_4__ 5.4.0

__CAPGO_KEEP_5__

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

__CAPGO_KEEP_8__

__CAPGO_KEEP_9__	__CAPGO_KEEP_10__	__CAPGO_KEEP_11__
`options`	`StatsUrl`	statistic을 전송하기 위한 URL을 사용하는 데 필요한 URL입니다.

__CAPGO_KEEP_0__ 5.4.0

setChannelUrl(…)

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

앱에 채널 URL을 설정하세요. 이 URL은 채널을 설정하는 데 사용됩니다.

Param	Type	설명
`options`	`ChannelUrl`	채널을 설정하기 위한 URL을 사용하는 데 필요한 URL입니다.

__CAPGO_KEEP_0__ 5.4.0

download(…)

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

지정된 URL에서 새로운 배ंडल을 다운로드합니다. 이 배ंडल은 zip 파일이어야 하며, 내부에 파일이 있거나, 유니크한 아이디를 가진 파일이 있으면 됩니다.

Param	Type	설명
`options`	`DownloadOptions`	다운로드 옵션을 위한 {@link DownloadOptions}입니다.

반환: 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`	A {@link BundleId} 객체로, 현재 설정할 새로운 번들 아이디를 포함합니다.

delete(…)

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

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

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

클립보드에 복사

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

Type

설명	The {@link}	Description
`options`	`ListOptions`	The {@link 리스트 옵션}으로 버블 목록

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

뷰를 다시 로드하세요

setMultiDelay(…)

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

DelayCondition 배열을 설정하여 플러그인이 업데이트 시간을 지연시키기 위한 조건을 설정합니다. 모든 조건이 충족되면 업데이트 프로세스는 다시 시작되어 정상적으로 업데이트가 설치됩니다. 배경화면 또는 앱을 종료한 후 업데이트가 설치됩니다. kind에 대한 값은 ISO 8601 날짜 문자열이어야 합니다. kind에 대한 값은 밀리초 단위의 숫자이어야 합니다. kind에 대한 값은 버전 번호이어야 합니다. kind에 대한 값은 사용되지 않습니다. kill 옵션을 사용하면 첫 번째 종료 후 업데이트가 트리거되지 않으며 다음 배경화면 후에 업데이트가 트리거됩니다. 이 문제는 미래의 주요 릴리스에서 해결될 예정입니다. Param__CAPGO_KEEP_0__ date __CAPGO_KEEP_0__ background __CAPGO_KEEP_0__ nativeVersion __CAPGO_KEEP_0__ kill __CAPGO_KEEP_0__

__CAPGO_KEEP_0__	타입	설명
`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>

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

Param	Type
`options`	`GetLatestOptions`

Returns: Promise<LatestVersion>

Since: 4.0.0

setChannel(…)

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

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

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

중요한 주의 사항:

이 메서드를 부트 시 채널을 설정하지 마십시오. __CAPGO_KEEP_0__ config에서 defaultChannel in your Capacitor config instead.
이 메서드는 앱이 준비되었을 때 사용자와 상호 작용(예: 베타 프로그램에 가입) 한 후에 사용됩니다.
공개 채널은 자체 assign할 수 없습니다. 채널이 public, 호출 setChannel() 에러를 반환합니다. 공개 채널을 사용하려면 unsetChannel() 를 호출하세요 - 장치가 자동으로 일치하는 공개 채널로 전환됩니다.
사용 listChannels() 을 통해 사용 가능한 채널을 확인하고 채널이 자체 할당을 허용하는지 여부를 확인할 수 있습니다.

Param	Type	설명
`options`	`SetChannelOptions`	{@link SetChannelOptions} channel을 설정합니다. Returns:Since:

unsetChannel(…) Promise<ChannelRes>

unsetChannel(…) 제목의 섹션 4.7.0

unsetChannel(…)

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

이 장치에 저장된 플러그인 관리 채널을 취소합니다. 이 메소드는 로컬로 저장된 채널만 삭제하고, 대시보드 또는 공용 __CAPGO_KEEP_0__ 장치 오버라이드 기록은 삭제하지 않습니다. setChannel()이 메소드를 호출한 후, 일반 채널 우선순위가 적용됩니다: 기존 대시보드 또는 공용 API 장치 오버라이드가 우선권을 가집니다. 그렇지 않으면 장치가 플랫폼, 장치 유형, 빌드 유형에 맞는 공용/기본 채널로 자동으로 전환할 수 있습니다.

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).

장치 업데이트를 기본 트랙으로 되돌리려면

공용 채널을 사용하려면 (공용 채널은 자체 할당이 불가능합니다)
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, 이 채널은 기본 채널. __CAPGO_KEEP_0__을 직접 할당할 수 없습니다. setChannel(). 대신에 __CAPGO_KEEP_0__ 채널 할당을 제거하여 unsetChannel(), 이 공공 채널에서 장치가 자동으로 업데이트를 받습니다.
allow_self_set: 만약 true, 이 채널은 자신이 할당할 수 있는 채널입니다.이 채널에 장치를 직접 할당할 수 있습니다. setChannel().

Returns: Promise<ListChannelsResult>

Since: 7.5.0

setCustomId(…)

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

이 장치에 사용자 지정 ID를 설정하세요

Param	Type	설명
`options`	`SetCustomIdOptions`	는 {@link SetCustomIdOptions} 사용자 지정 ID를 설정하는 옵션입니다

Since: 4.9.0

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

설정된 구성 파일에 builtin 버전이 설정되어 있으면 native 앱 버전을 가져옵니다

Returns: Promise<BuiltinVersion>

Since: 5.2.0

getDeviceId()

getDeviceId() => Promise<DeviceId>

기기 고유 ID를 식별하기 위해 전송 (자동 업데이트 서버)

Returns: Promise<DeviceId>

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Get the native Capacitor Updater plugin version (sent to auto update server)

Returns: Promise<PluginVersion>

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

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

반환값: Promise<AutoUpdateEnabled>

removeAllListeners()

removeAllListeners() => Promise<void>

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

Since: 1.0.0

download 이벤트에 리스너를 추가합니다.

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

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

Param	Type
`eventName`	`’download’`
`listenerFunc`	`(state: DownloadEvent) => void`

반환: Promise<PluginListenerHandle>

Since: 2.0.11

addListener(‘noNeedUpdate’, …)

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

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

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

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

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

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

__CAPGO_KEEP_1__

__CAPGO_KEEP_2__ Promise<AutoUpdateAvailable>

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

__CAPGO_KEEP_3__ Returns null if no next bundle is set.

__CAPGO_KEEP_2__ Promise<BundleInfo | null>

Since: 6.8.0

setShakeMenu(…)

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

__CAPGO_KEEP_0__을 사용하거나 비활성화하여 디버깅/테스트 목적으로 흔들기 메뉴를 활성화/비활성화합니다.

__CAPGO_KEEP_0__	__CAPGO_KEEP_0__	__CAPGO_KEEP_0__
`options`	`SetShakeMenuOptions`	__CAPGO_KEEP_0__을 포함하여 흔들기 메뉴를 활성화/비활성화할 수 있는 boolean 값을 포함합니다.

__CAPGO_KEEP_0__ 7.5.0

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__ Promise<ShakeMenuEnabled>

__CAPGO_KEEP_0__ 7.5.0

인터페이스

AppReadyResult

속성	타입
`bundle`	`BundleInfo`

BundleInfo

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

업데이트 URL

속성	타입
`url`	`string`

StatsUrl

속성	타입
`url`	`string`

ChannelUrl

속성	타입
`url`	`string`

다운로드 옵션

이 URL 및 버전은 서버에서 배ंडल을 다운로드하는 데 사용됩니다. 백엔드 사용 시 모든 정보는 getLatest 메서드에 의해 제공됩니다. 백엔드 사용하지 않는 경우 배ंडल의 URL 및 버전을 제공해야 합니다. SessionKey은 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

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

ResetOptions 섹션

형식	현재 배포 결과
`toLastSuccessful`	`boolean`

__CAPGO_KEEP_0__

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

멀티 딜레이 조건

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

딜레이 조건

형식	설명	속성
`kind`	`DelayUntilNext`	__CAPGO_KEEP_0__ 설정을 위한 지연 조건을 설정하세요.
`value`	`string`

__CAPGO_KEEP_1__ 버전

__CAPGO_KEEP_3__	__CAPGO_KEEP_4__	__CAPGO_KEEP_5__	__CAPGO_KEEP_6__
`version`	`string`	__CAPGO_KEEP_7__	4.0.0
`checksum`	`string`		6
`major`	`boolean`
`message`	`string`
`sessionKey`	`string`
`error`	`string`
`old`	`string`
`url`	`string`
`manifest`	`ManifestEntry[]`		6.1

__CAPGO_KEEP_8__

__CAPGO_KEEP_10__	__CAPGO_KEEP_11__	설명	기본	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`

채널 옵션 삭제

속성	형식
`triggerAutoUpdate`	`boolean`

채널 가져오기

속성	형식	설명	__CAPGO_KEEP_0__
`channel`	`string`	__CAPGO_KEEP_1__	4.8.0
`error`	`string`
`message`	`string`
`status`	`string`
`allowSet`	`boolean`

__CAPGO_KEEP_2__

__CAPGO_KEEP_4__	__CAPGO_KEEP_5__	__CAPGO_KEEP_6__	__CAPGO_KEEP_0__
`channels`	`ChannelInfo[]`	__CAPGO_KEEP_7__	7.5.0

__CAPGO_KEEP_8__

__CAPGO_KEEP_4__	타입	설명	__CAPGO_KEEP_0__
`id`	`number`	__CAPGO_KEEP_0__	7.5.0
`name`	`string`	__CAPGO_KEEP_0__	7.5.0
`public`	`boolean`	__CAPGO_KEEP_0__ `unsetChannel()`__CAPGO_KEEP_0__	7.5.0
`allow_self_set`	`boolean`	__CAPGO_KEEP_0__ `setChannel()`__CAPGO_KEEP_0__	7.5.0

__CAPGO_KEEP_0__ name__CAPGO_KEEP_0__ id.

__CAPGO_KEEP_0__

속성	형식
`customId`	`string`

내장 버전

속성	형식
`version`	`string`

기기 ID

형식	플러그인 버전
`deviceId`	`string`

protectedTokens

속성	형식
`version`	`string`

자동 업데이트 가능

속성	형식
`enabled`	`boolean`

플러그인 리스너 핸들

형식	플러그인 리스너 핸들
`remove`	`() => Promise<void>`

속성 (다운로드 이벤트)

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

NoNeedEvent

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

UpdateAvailableEvent

Prop	Type	설명	Since
`bundle`	`BundleInfo`	다운로드 진행률, 0과 100 사이.	4.0.0

DownloadCompleteEvent

Prop	Type	설명	__CAPGO_KEEP_0__
`bundle`	`BundleInfo`	새로운 업데이트가 있는 경우 발생합니다.	4.0.0

MajorAvailableEvent

Prop	Type	설명	__CAPGO_KEEP_0__
`version`	`string`	새로운 메이저 버전이 있는 경우 발생합니다.	4.0.0

UpdateFailedEvent

속성	타입	설명	Since
`bundle`	`BundleInfo`	다운로드 설치가 실패하여 발생합니다.	4.0.0

DownloadFailedEvent

속성	타입	설명	Since
`version`	`string`	다운로드가 실패합니다.	4.0.0

AppReadyEvent

Prop	Type	설명	Since
`bundle`	`BundleInfo`	앱이 사용할 준비가 되었을 때 발행됩니다.	5.2.0
`status`	`string`

AutoUpdateAvailable

Prop	Type
`available`	`boolean`

셰이크 메뉴 옵션 설정

속성	타입
`enabled`	`boolean`

ShakeMenuEnabled

속성	타입
`enabled`	`boolean`

타입 별칭

BundleStatus

보류 중: 번들 준비 중입니다. SET 다음 번들로 설정합니다. downloading: 번들이 다운로드 중입니다. success: 번들이 다운로드되었습니다. 사용할 준비가 되었습니다. SET 다음 번들로 설정합니다. error: 번들이 다운로드에 실패했습니다.

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

DelayUntilNext

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

Keep going from Functions and settings

If you are using Functions and settings 를 사용하여 대시보드와 API 작업을 계획하고 있습니다. API을 Using @capgo/capacitor-updater capgo의 내장 기능을 위한 @capacitor/capgo-업데이터 사용 API 개요 API의 구현 세부 정보를 위한 API 개요 소개 소개의 구현 세부 정보를 위한 __CAPGO_KEEP_0__ API 키 API 키의 구현 세부 정보를 위한 API 및 장치 장치의 구현 세부 정보를 위한 __CAPGO_KEEP_0__.