기능과 설정

설치 단계와 전체 마크다운 가이드를 포함한 설치提示 복사하기.

업데이터 플러그인 설정

Github를 참조하십시오. README __CAPGO_KEEP_0__

CapacitorUpdater를 설정하는 옵션입니다.

속성	타입	설명	기본값	버전
`appReadyTimeout`	`number`	업데이터를 위한 네이티브 플러그인에서 업데이트 실패를 고려하기 전에 기다리는 밀리초 수를 설정합니다. 안드로이드, iOS, Electron에서 사용 가능합니다.	`10000 // (10 seconds)`
`responseTimeout`	`number`	업데이터를 위한 네이티브 플러그인에서 API 시간 초과를 고려하기 전에 기다리는 밀리초 수를 설정합니다. 안드로이드, iOS, Electron에서 사용 가능합니다.	`20000 // (20 seconds)`
`autoDeleteFailed`	`boolean`	실패한 패키지를 자동으로 삭제할지 여부를 설정합니다. 안드로이드, iOS, Electron에서 사용 가능합니다.	`true`
`autoDeletePrevious`	`boolean`	업데이트가 성공적으로 완료된 후 이전 패키지를 자동으로 삭제할지 여부를 설정합니다. 안드로이드, iOS, Electron에서 사용 가능합니다.	`true`
`autoUpdate`	`boolean \| ‘off’ \| ‘atBackground’ \| ‘atInstall’ \| ‘onLaunch’ \| ‘always’ \| ‘onlyDownload’`	업데이트 서버를 통해 자동 업데이트를 사용하는 방법을 설정합니다. true는 'atBackground'과 동일하며, false는 'off'과 동일합니다. - off: 자동 업데이트를 비활성화합니다. - atBackground: 앱이 배경으로 이동할 때 자동으로 다운로드하고 적용합니다. - atInstall: 새로운 설치 또는 네이티브 앱 업데이트가 발생한 경우 즉시 적용하고, 그렇지 않은 경우 atBackground을 사용합니다. - onLaunch: 앱이 시작될 때 즉시 적용하고, 그렇지 않은 경우 atBackground을 사용합니다. - always: 자동 업데이트가 실행될 때마다 즉시 적용합니다. - onlyDownload: 자동으로 다운로드하고, updateAvailable 이벤트를.emit하고, 다음 패키지를 자동으로 설정하지 않습니다. 안드로이드, iOS, Electron에서 사용 가능합니다.	`”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"와 같은 autoUpdate 문자열 모드를 사용하세요. 이 옵션은 기존 앱에 대해 지원됩니다. - false: 직접 업데이트를 수행하지 않습니다. - atInstall: autoUpdate: "atInstall"와 동일합니다. - onLaunch: autoUpdate: "onLaunch"와 동일합니다. - always: autoUpdate: "always"와 동일합니다. - true: "always"와 동일합니다. Android, iOS, Electron에서 사용할 수 있습니다.	`false`	5.1.0
`autoSplashscreen`	`boolean`	자동으로 스플래시 화면을 숨기기 위해 instant apply 모드 사용 시 처리합니다. 활성화 시, 플러그인은 업데이트가 적용되거나 업데이트가 필요하지 않을 때 스플래시 화면을 자동으로 숨깁니다. 이로 인해 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__을 사용하여 로컬 서버를 테스트하기 위해 또는 자체 호스팅된 업데이트 서버를 사용하도록 구성합니다.	`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`	디버깅/테스트 목적으로 업데이트 메뉴를 표시하기 위해 흔들기 동작을 활성화합니다.	`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을 포함합니다.

Since: 5.4.0

setStatsUrl(…)

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

앱의 statsUrl을 설정합니다. 이 설정은 statistic 수집을 위해 사용됩니다. 빈 문자열을 전달하면 statistic 수집이 비활성화됩니다.

속성	타입	설명
`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} 다운로드 옵션 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>

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

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

삭제(…)

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

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

속성	타입	설명
`options`	`BundleId`	ID를 삭제하는 {@link} BundleId} 객체는 버전 이름이 아닌 번들 ID입니다.

list(…)

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

앱 내에서 다운로드 한 모든 번들을 가져옵니다.

Param	Type	설명
`options`	`ListOptions`	The {@link} 리스트 옵션}으로 번들 목록

반환: Promise<BundleListResult>

reset(…)

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

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

타입	설명	참조 {@link
`options`	`ResetOptions`	__CAPGO_KEEP_0__ 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 DelayCondition background DelayCondition nativeVersion DelayCondition kill DelayCondition

DelayCondition	형식	설명
`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에서 가져옵니다.

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

반환: Promise<LatestVersion>

Since: 4.0.0

setChannel(…)

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

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

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

중요한 주의사항:

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

파라미터	형식	설명
`options`	`SetChannelOptions`	링크된 {@link} SetChannelOptions} 채널을 설정합니다.

반환값: Promise<ChannelRes>

버전: 4.7.0

unsetChannel(…)

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

이 장치에 저장된 플러그인 관리 채널을 취소합니다. 이 메서드는 로컬로 저장된 채널만 삭제하고, 대시보드나 공용 __CAPGO_KEEP_0__ 장치 오버라이드 기록은 삭제하지 않습니다. setChannel(); 로컬로 저장된 채널만 삭제하고, 대시보드나 공용 API 장치 오버라이드 기록은 삭제하지 않습니다.

이 메서드를 호출한 후, 일반적인 채널 우선순위가 적용됩니다: 기존 대시보드나 공용 API 장치 오버라이드가 우선순위가 있으며, 그렇지 않으면 장치가 플랫폼, 장치 유형, 빌드 유형에 맞는 공용/기본 채널로 돌아갑니다.

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

장치가 기본 업데이트 트랙으로 돌아가길 원할 때
공용 채널을 사용하고 싶을 때 (공용 채널은 대시보드나 __CAPGO_KEEP_0__ 장치 오버라이드를 통해 할당할 수 없습니다) 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, 이 채널은 기본 채널. 이 채널에 자동 ASSIGN 할 수 없습니다. setChannel(). 대신에, 채널 ASSIGN 를 제거하면 이 공개 채널에서 자동으로 업데이트 받습니다. unsetChannel(): If 이 채널은
allow_self_set, 이 채널은 true 채널입니다. 이 채널에 장치를 명시적으로 ASSIGN 할 수 있습니다. Returns:Since: setChannel().

setCustomId(…) Promise<ListChannelsResult>

setCustomId(…) 제목 7.5.0

복사

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

이 장치에 대한 사용자 정의 ID를 설정하세요

Param	Type	설명
`options`	`SetCustomIdOptions`	는 {@link} SetCustomIdOptions} 사용자 정의 ID를 설정하는 customId

Since: 4.9.0

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

설정된 config에서 builtin 버전이 있는 경우 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>

시작: 2.0.11

addListener(‘noNeedUpdate’, …) 섹션

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

파라미터

타입	addListener(‘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>

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

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`

반환값: Promise<PluginListenerHandle>

Since: 2.3.0

addListener('업데이트 실패', …) 함수를 호출합니다.

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

앱에서 업데이트 실패 이벤트를 듣고, 다음 앱 시작 시 업데이트가 설치되지 않은 경우 알립니다.

매개 변수	타입
`eventName`	`’updateFailed’`
`listenerFunc`	`(state: UpdateFailedEvent) => void`

반환값: Promise<PluginListenerHandle>

Since: 2.3.0

addListener('다운로드 실패', …) 함수를 호출합니다.

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>

Type

__CAPGO_KEEP_0__	__CAPGO_KEEP_1__
`eventName`	`’appReloaded’`
`listenerFunc`	`() => void`

반환값: Promise<PluginListenerHandle>

시작: 4.3.0

addListener('앱준비', ...)

addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>

앱이 준비되면 앱에서 이벤트를 듣습니다.

Param	Type
`eventName`	`’appReady’`
`listenerFunc`	`(state: AppReadyEvent) => void`

반환값: Promise<PluginListenerHandle>

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

테스트/디버깅 목적으로 셰이크 메뉴를 활성화/비활성화합니다.

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

Since: 7.5.0

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

현재 셰이크 메뉴 상태를 가져옵니다.

반환: Promise<ShakeMenuEnabled>

Since: 7.5.0

인터페이스

AppReadyResult

속성	타입
`bundle`	`BundleInfo`

BundleInfo

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

UpdateUrl

속성	형식
`url`	`string`

StatsUrl

속성	형식
`url`	`string`

ChannelUrl

속성	형식
`url`	`string`

다운로드 옵션

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

속성	형식	설명	기본값	Since
`url`	`string`	다운로드할 패키지 zip 파일의 URL (예: dist.zip)입니다. (이 URL은 임의의 URL일 수 있습니다. 예를 들어 Amazon S3, GitHub 태그, 패키지를 호스팅한 다른 장소 등)
`version`	`string`	code/name 패키지 버전의 이름
`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__

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

ResetOptions 섹션

타입	CurrentBundleResult
`toLastSuccessful`	`boolean`

__CAPGO_KEEP_0__

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

멀티 딜레이 조건

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

딜레이 조건

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

타입	설명	설명	기본값	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`

UnsetChannelOptions 섹션

타입	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`	이 채널이 기본/대체 채널인지 여부입니다. 기기들은 공개 채널에 할당될 수 없습니다. 대신 기기는 채널 override를 제거할 때 ( `unsetChannel()`를 사용하여), 자동으로 업데이트를 받을 수 있는 매칭되는 공개 채널을 받습니다.	7.5.0
`allow_self_set`	`boolean`	이 채널이 기본/대체 채널인지 여부입니다. 기기들은 공개 채널에 할당될 수 없습니다. 대신 기기는 채널 override를 제거할 때 ( `setChannel()`를 사용하여), 자동으로 업데이트를 받을 수 있는 매칭되는 공개 채널을 받습니다.	7.5.0

이 채널이 기본/대체 채널인지 여부입니다. 기기들은 공개 채널에 할당될 수 없습니다. 대신 기기는 채널 override를 제거할 때 ( name를 사용하여), 자동으로 업데이트를 받을 수 있는 매칭되는 공개 채널을 받습니다. id.

기기들이 이 채널에 명시적으로 할당될 수 있는지 여부입니다. 이 기능은 일반적으로 베타 테스트, A/B 테스트 또는 옵트인 업데이트 트랙에 사용됩니다.

속성	타입
`customId`	`string`

내장 버전

속성	타입
`version`	`string`

기기 ID

타입	플러그인 버전
`deviceId`	`string`

설정 제목 ‘DeviceId’

속성	타입
`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

속성	형식	설명	시작
`bundle`	`BundleInfo`	업데이트 설치에 실패할 때 발생합니다.	4.0.0

다운로드 실패 이벤트

속성	형식	설명	시작
`version`	`string`	다운로드에 실패할 때 발생합니다.	4.0.0

앱 준비 이벤트

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

자동 업데이트 가능

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

설명

속성	형식
`enabled`	`boolean`

ShakeMenuEnabled

속성	형식
`enabled`	`boolean`

형식 별명

BundleStatus

pending: 배포가 준비 중입니다. SET 다음 버전으로 설정합니다. 다운로드 중입니다. : 버전이 다운로드 중입니다. 다운로드 성공 : 다운로드가 완료되었습니다.

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

SET

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

다음 버전까지 기다립니다.

Functions and settings에서 계속합니다. Functions and settings을 사용하여 대시보드와 __CAPGO_KEEP_0__ 작업을 계획하고 있다면, __CAPGO_KEEP_0__-updater와 연결하세요. 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의 구현 세부 정보에 대해 __CAPGO_KEEP_0__ 키 Capgo의 구현 세부 정보에 대해 API 키, for the implementation detail in API Keys, and 장치의 구현 세부 정보에 대해 편집 페이지