Page/area: Capgo marketing website. Role: Website copy sentence. Seen in: component doc/SignupCta.astro, component Hero.astro. Message key `hero_subtitle_v2` (Hero Subtitle V2).
이 설정 프롬프트를 복사하여 설치 단계와 이 플러그인의 전체 마크다운 가이드를 포함합니다.
업데이터 플러그인 설정
업데이터 플러그인 설정See the Github README 더 많은 정보를 읽으려면
CapacitorUpdater를 설정하려면 다음 옵션을 사용할 수 있습니다:
| 속성 | 타입 | 설명 | 기본값 | 버전 |
|---|---|---|---|---|
appReadyTimeout | number | 업데이트 시간을 설정합니다. Android, iOS, Electron에서 사용할 수 있습니다. | 10000 // (10 seconds) | |
responseTimeout | number | 네이티브 플러그인 API 시간 초과를 고려하기 전에 대기하는 밀리초 수를 설정합니다. 안드로이드, 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’ | {"text":"백그라운드에서 자동 업데이트를 사용하는 방법을 설정합니다. true는 “atBackground”과 동일하며, false는 “off”과 동일합니다. - off: 자동 업데이트를 비활성화합니다. - atBackground: 앱이 백그라운드에 이동할 때 자동으로 체크하고 다운로드하고 적용합니다. - atInstall: 새로운 설치 또는 네이티브 앱 업데이트가 발생할 때 즉시 적용하고, 그렇지 않으면 atBackground를 사용합니다. - onLaunch: 앱이 시작될 때 즉시 적용하고, 그렇지 않으면 atBackground를 사용합니다. - always: 자동 업데이트가 실행될 때마다 즉시 적용합니다. - onlyDownload: 자동으로 체크하고 다운로드하고, updateAvailable를.emit하고, 다음 번들 자동으로 설정하지 않습니다. "atInstall", "onLaunch", "always"와 같은 즉시 적용 모드(Instant apply modes)는 —delta와 함께 업로드해야 사용자 경험을 느리게 하지 않습니다. Android와 iOS에서 이러한 모드는 autoSplashscreen: true와 @capacitor/splash-screen, launchAutoHide: false를 필요로합니다. Android, iOS, Electron에서 사용할 수 있습니다. "} | “atBackground” // true is still accepted | |
resetWhenUpdate | boolean | {"text":"이전 다운로드된 번들을 삭제하고, 최신 네이티브 앱 번들을 장치에 설치할 때 자동으로 삭제합니다. Android, iOS, Electron에서 사용할 수 있습니다. "} | true | |
updateUrl | string | {"text":"업데이트 체크를 위한 URL/엔드포인트를 설정합니다. Android, iOS, Electron에서 사용할 수 있습니다. "} | https://plugin.capgo.app/updates | |
channelUrl | string | {"text":"채널 연산을 위한 URL/엔드포인트를 설정합니다. Android, iOS, Electron에서 사용할 수 있습니다. "} | https://plugin.capgo.app/channel_self | |
statsUrl | string | {"text":"업데이트 통계를 위한 URL/엔드포인트를 설정합니다. Android, iOS, Electron에서 사용할 수 있습니다. 통계 보고를 비활성화하려면 ""을 설정합니다. "} | https://plugin.capgo.app/stats | |
publicKey | string | live update : Android, iOS, Electron에서 사용할 수 있습니다. | undefined | 6.2.0 |
version | string | code : 이 옵션을 설정하지 않으면 플러그인은 native code에서 앱 버전을 가져옵니다. Android, iOS, Electron에서 사용할 수 있습니다. | undefined | 4.17.48 |
directUpdate | boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’ | capacitor : deprecated. “atInstall”, “onLaunch”, “always” 대신 autoUpdate string modes를 사용하세요. existing 앱에 대해 지원을 유지합니다. Instant apply는 —delta 옵션과 함께 업로드해야 합니다. 사용자 경험을 느끼지 않도록 업데이트를 느리게 하지 마세요. Android, iOS에서 이 모드는 autoSplashscreen: true와 @capacitor/splash-screen을 사용해야 합니다. launchAutoHide: false를 설정해야 합니다. - false: 직접 업데이트를 수행하지 않습니다. - atInstall: autoUpdate: “atInstall”와 동일합니다. - onLaunch: autoUpdate: “onLaunch”와 동일합니다. - always: autoUpdate: “always”와 동일합니다. - true: backward compatibility를 위해 “always”와 동일합니다. Android, iOS, Electron에서 사용할 수 있습니다. | false | 5.1.0 |
autoSplashscreen | boolean | capacitor : instant apply 모드 (“atInstall”, “onLaunch”, “always”)를 사용할 때, deprecated directUpdate 값을 포함하여 필수입니다. @capacitor/splash-screen은 launchAutoHide: false를 설정해야 합니다. 활성화하면 플러그인은 업데이트가 적용되거나 업데이트가 필요하지 않으면 스플래시 스크린을 숨깁니다. 이로 인해 appReady 이벤트를 수신하고 SplashScreen.hide()를 호출하지 않도록 수동으로 듣는 필요가 없습니다. Android, 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 | JavaScript에서 동적으로 업데이트 URL, statsURL 및 channelURL을 수정할 수 있도록 플러그인을 허용합니다. | 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 | JavaScript 플러그인 로깅을 비활성화합니다. 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() 섹션notifyAppReady() => Promise<AppReadyResult>앱이 준비되면 Capacitor 업데이터에 현재 버전이 작동 중인지 알립니다. (이 메서드가 앱 런치에 호출되지 않으면 롤백이 발생합니다.) 기본적으로 이 메서드는 앱 런치 후 10초 이내에 호출되어야 합니다. 그렇지 않으면 롤백이 발생합니다. 이 동작을 변경하려면 {@link appReadyTimeout}을 참조하세요.
반환값: Promise<AppReadyResult>
setUpdateUrl(…)
setUpdateUrl(…) 섹션setUpdateUrl(options: UpdateUrl) => Promise<void>앱의 업데이트 URL을 설정합니다. 이 URL을 사용하여 업데이트 여부를 확인합니다.
| 매개변수 | 타입 | 설명 |
|---|---|---|
options | UpdateUrl | 업데이트를 확인하기 위한 URL을 포함합니다. |
Since: 5.4.0
setStatsUrl(…)
setStatsUrl(…) 섹션setStatsUrl(options: StatsUrl) => Promise<void>컨텍스트: Capgo 마케팅 웹사이트. 역할: UI 레이블. 위치: page agents/[slug].astro. 메시지 키 `agents_page_copy_label` (Agents Page Copy Label).
| Param | Param | 타입 |
|---|---|---|
options | StatsUrl | statistics 전송을 위한 URL을 포함합니다. |
Since: 5.4.0
setChannelUrl(options: ChannelUrl) => Promise<void>앱에 채널 URL을 설정하세요. 이 설정은 채널을 설정하는 데 사용됩니다.
| Param | Type | 설명 |
|---|---|---|
options | ChannelUrl | 채널을 설정하는 URL을 포함합니다. |
Since: 5.4.0
다운로드(…)
Section titled “다운로드(…)”download(options: DownloadOptions) => Promise<BundleInfo>다운로드 URL을 통해 새로운 패키지를 다운로드합니다. 이 패키지는 zip 파일이어야 하며, 내부에 파일이 포함되어야 하거나, 유니크한 ID를 포함한 파일이 내부에 포함되어야 합니다.
| 파라미터 | 타입 | 타입 |
|---|---|---|
options | DownloadOptions | 설명 DownloadOptions반환: |
다음(…) Promise<BundleInfo>
다음(…)
클립보드에 복사next(options: BundleId) => Promise<BundleInfo>설정
| 파라미터 | 종류 | 설명 |
|---|---|---|
options | BundleId | 다음 앱 실행 시 설정할 다음 번들의 ID를 포함합니다. {@link BundleInfo.id} |
반환: Promise<BundleInfo>
set(…)
set(…) 섹션set(options: BundleId) => Promise<void>현재 번들을 설정하고 즉시 앱을 재로드합니다.
| 파라미터 | 종류 | 설명 |
|---|---|---|
options | BundleId | A {@link} BundleId새로운 버전 아이디를 현재로 설정할 객체. |
delete(…)
삭제(…)delete(options: BundleId) => Promise<void>자연 앱 저장소에서 지정된 번들을 삭제합니다. {@link list}를 사용하여 저장된 Bundle ID를 가져올 수 있습니다.
| Param | Type | Description |
|---|---|---|
options | BundleId | A {@link} BundleId} 삭제할 번들 ID를 포함하는 객체 (주의: 이 ID는 버전 이름이 아닌 번들 ID입니다) |
리스트(…)
리스트(…) 섹션list(options?: ListOptions | undefined) => Promise<BundleListResult>앱에 다운로드 된 모든 번들을 가져옵니다
| 파라미터 | 타입 | 설명 |
|---|---|---|
options | ListOptions | 리스트 옵션 리스트 옵션리턴 |
리턴 Promise<BundleListResult>
reset(…)
reset(…) 섹션reset(options?: ResetOptions | undefined) => Promise<void>컨텍스트: Capgo 마케팅 웹사이트. 역할: UI 레이블. 위치: page agents/[slug].astro. 메시지 키 `agents_page_copy_label` (Agents Page Copy Label). builtin 앱을
| Param | Param | 타입 |
|---|---|---|
options | ResetOptions | 컨텍스트: Capgo 소개 페이지. 역할: 짧은 UI 레이블 또는 네비게이션 아이템. 위치: page about.astro. 메시지 키 `about_facts_type` (About Facts Type). 설명}, true Containing {@link false ResetOptions.toLastSuccessful |
현재()
현재() 섹션current() => Promise<CurrentBundleResult>현재 버전을 반환합니다. 만약 설정된 버전이 없다면 기본 버전을 반환합니다. builtincurrentNative는 기기에서 설치된 원래 버전입니다.
반환값: Promise<CurrentBundleResult>
재로드()
재로드reload() => Promise<void>setMultiDelay(…)
setMultiDelay(…) 섹션
Reload the viewsetMultiDelay(options: MultiDelayConditions) => Promise<void>업데이트를 지연시키기 위한 조건을 배열로 설정합니다. DelayCondition업데이트가 지연되기 전에 모든 조건이 충족될 때까지 업데이트 프로세스는 다시 시작됩니다. date kind background kind nativeVersion kind kill kind
| kind | Param | Type |
|---|---|---|
options | MultiDelayConditions | 설명 MultiDelayConditions업데이트를 설정하기 위한 조건들의 배열입니다. |
Since: 4.3.0
cancelDelay()
cancelDelay()를 취소하는 섹션cancelDelay() => Promise<void>페이지/영역: Capgo 마케팅 웹사이트. 역할: UI 레이블. 위치: page agents/[slug].astro. 메시지 키 `agents_page_copy_label` (Agents Page Copy Label). DelayConditiongetLatest(…)
Since: 4.0.0
getLatest(…)
Cancels a {@link DelayCondition}getLatest(options?: GetLatestOptions | undefined) => Promise<LatestVersion>최신 버전의 패키지를 업데이트 URL에서 가져옵니다
| 파라미터 | 타입 |
|---|---|
options | GetLatestOptions |
반환 Promise<LatestVersion>
시작 4.0.0
설정 채널(…)
설정setChannel(options: SetChannelOptions) => Promise<ChannelRes>이 장치에 대한 플러그인 관리 채널을 설정합니다. 채널은 allow_device_self_set 이 작업을 수행하려면 채널이 활성화되어 있어야 합니다.
setChannel() 채널을 백엔드와 검증한 다음 장치에 선택한 채널을 저장합니다. 이 작업은 백엔드의 장치 오버라이드 생성 또는 업데이트도 하지 않습니다. 따라서 장치 오버라이드 UI에서 장치가 오버라이드된 것으로 표시되지 않습니다. Capgo 대시보드에서만 오버라이드된 장치가 표시됩니다. Public API에서만 생성된 assignment만 오버라이드 UI에서 표시됩니다.
중요한 주의 사항:
- 이 메서드를 부트 시 채널 설정에 사용하지 마십시오. 대신 __CAPGO_KEEP_0__ 설정에서
defaultChannelCapacitor 설정에서 대신합니다. - 공개 채널은 자체 할당이 불가능합니다.
- 만약 채널이 로 표시되어 있다면,
public, callingsetChannel()를 호출하세요 - 장치가 자동으로 일치하는 공개 채널로 전환됩니다.unsetChannel()를 사용하여 사용 가능한 채널을 발견하고 자체 할당이 허용되는지 여부를 확인하세요. - Param
listChannels()채널을 발견하고 자체 할당이 허용되는지 여부를 확인하기 위해.
| Param | 유형 | 설명 |
|---|---|---|
options | SetChannelOptions | 링크된 {@link} SetChannelOptions} 채널을 설정 |
반환: Promise<ChannelRes>
Since: 4.7.0
unsetChannel(…)
unsetChannel(…) 섹션unsetChannel(options: UnsetChannelOptions) => Promise<void>이 장치에 저장된 채널을 플러그인 관리로 초기화합니다. 이 메소드는 로컬 저장소에 저장된 채널만 초기화하고, 대시보드나 공용 __CAPGO_KEEP_0__ 장치 오버라이드 기록은 삭제하지 않습니다. setChannel(); Dashboard 및 Public API 기기 오버라이드 기록은 삭제하지 않습니다.
이 메소드를 호출한 후 정상 채널 우선순위가 적용됩니다: 기존 대시보드 또는 공용 API 기기 오버라이드가 존재하면 기기 오버라이드가 우선하고, 그렇지 않으면 기기 조건(플랫폼, 기기 유형, 빌드 유형)에 맞는 공용/기본 채널로 돌아갈 수 있습니다.
이것은 유용합니다:
- 기기를 기본 업데이트 트랙으로 다시 이동하고 싶을 때
- 공용 채널을 사용하고 싶을 때 (공용 채널은 자체 할당을 통해 사용할 수 없습니다)
setChannel())
| Param | Type |
|---|---|
options | UnsetChannelOptions |
Since: 4.7.0
getChannel()
getChannel()getChannel() => Promise<GetChannelRes>이 기기의 채널을 가져옵니다
반환: Promise<GetChannelRes>
Since: 4.8.0
listChannels()
listChannels() 섹션listChannels() => Promise<ListChannelsResult>이 장치에 사용 가능한 모든 채널 목록을 반환합니다. 장치의 현재 환경(플랫폼, 에뮬레이터/실기기, 개발/운영 빌드)에 호환되는 채널을 반환하며, 이 채널은 공개 채널이거나 장치에 대한 채널 할당을 허용합니다.
결과에 포함된 각 채널에는:
publicIftrue, 이 채널은 기본 채널입니다. 이 채널에 대한 할당을 사용자 지정할 수 없습니다. 대신,setChannel()을 사용하여 채널 할당을 해제하면 장치가 이 공개 채널에서 자동으로 업데이트를 받습니다.unsetChannel()Copy to clipboardallow_self_set: 만약true, 이건 자신이 할당할 수 있는 채널입니다. 이 채널에 장치를 명시적으로 할당하려면setChannel().
반환: Promise<ListChannelsResult>
시작: 7.5.0
setCustomId(…)
setCustomId(…) 제목setCustomId(options: SetCustomIdOptions) => Promise<void>이 장치를 위한 사용자 지정 ID를 설정합니다
| Param | 타입 | 설명 |
|---|---|---|
options | SetCustomIdOptions | {@link}는 SetCustomIdOptions} customId를 설정하는 옵션 |
Since: 4.9.0
getBuiltinVersion()
getBuiltinVersion() 제목getBuiltinVersion() => Promise<BuiltinVersion>본인 앱 버전 또는 config에서 설정된 빌트인 버전을 가져옵니다
Returns: Promise<BuiltinVersion>
Since: 5.2.0
getDeviceId()
getDeviceId()getDeviceId() => Promise<DeviceId>기기 고유 ID를 얻습니다. (자동 업데이트 서버로 전송)
Returns: Promise<DeviceId>
getPluginVersion()
플러그인 버전 가져오기getPluginVersion() => Promise<PluginVersion>기기에서 Capacitor Updater 플러그인 버전을 가져옵니다. (자동 업데이트 서버로 전송)
Returns: Promise<PluginVersion>
isAutoUpdateEnabled()
자동 업데이트 가능 여부isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>업데이트 설정 상태를 가져옵니다.
반환: Promise<AutoUpdateEnabled>
removeAllListeners()
제목: removeAllListeners()removeAllListeners() => Promise<void>이 플러그인을 위한 모든 리스너를 제거합니다.
Since: 1.0.0
addListener(eventName: 'download', listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>제목: addListener(‘download’, …)
| Param | 종류 |
|---|---|
eventName | ‘download’ |
listenerFunc | (state: DownloadEvent) => void |
반환: Promise<PluginListenerHandle>
시작: 2.0.11
addListener('noNeedUpdate', …) 함수를 호출합니다.
addListener('noNeedUpdate', …) 함수addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>업데이트가 필요하지 않은 이벤트를 감지하여, 앱이 시작될 때마다 매번 업데이트 확인을 강제할 수 있습니다.
| 매개변수 | 종류 |
|---|---|
eventName | ‘noNeedUpdate’ |
listenerFunc | (state: NoNeedEvent) => void |
반환: Promise<PluginListenerHandle>
시작: 4.0.0
addListener('updateAvailable', …) 함수를 호출합니다.
Section titled “업데이트가 준비되면 …”에 추가합니다.”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(‘majorAvailable’, …)addListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>메이저 업데이트가 준비되면 앱에서 알림을 받을 수 있습니다. 자동 업데이트가 중단되는 것을 방지하기 위해 disableAutoUpdateBreaking을 설정합니다.
| Param | 종류 |
|---|---|
eventName | ‘majorAvailable’ |
listenerFunc | (state: MajorAvailableEvent) => void |
반환: Promise<PluginListenerHandle>
Since: 2.3.0
업데이트 실패 이벤트 리스너 추가(addListener('updateFailed', …))
addListener(‘업데이트 실패’, …)”addListener(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>앱에서 업데이트 실패 이벤트를 듣고, 다음 앱 시작 시 업데이트 설치가 실패한 것을 알려줍니다.
| 파라미터 | 타입 |
|---|---|
eventName | ‘updateFailed’ |
listenerFunc | (state: UpdateFailedEvent) => void |
반환: Promise<PluginListenerHandle>
Since: 2.3.0
addListener(‘다운로드 실패’, …)
addListener(‘다운로드 실패’, …)”addListener(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>앱에서 다운로드 실패 이벤트를 듣고, 다운로드 패키지 다운로드가 실패한 것을 알려줍니다.
| 파라미터 | 종류 |
|---|---|
eventName | ‘downloadFailed’ |
listenerFunc | (state: DownloadFailedEvent) => void |
반환: Promise<PluginListenerHandle>
시작: 4.0.0
addListener('appReloaded', …)
addListener('appReloaded', …) 섹션addListener(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>앱이 다시 로드되었습니다. 이벤트를 듣고 앱이 다시 로드되었는지 알 수 있습니다.
| 매개변수 | 종류 |
|---|---|
eventName | ‘appReloaded’ |
listenerFunc | () => void |
반환: Promise<PluginListenerHandle>
시작: 4.3.0
addListener('appReady', …)
Section titled “앱 준비 이벤트를 추가하기(‘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>자동 업데이트 가능 여부를 확인합니다 (서버 URL로 인해 비활성화되지 않은 경우)
Returns: Promise<AutoUpdateAvailable>
getNextBundle()
getNextBundle()getNextBundle() => Promise<BundleInfo | null>다음으로 reload 될 때 사용될 bundle을 가져옵니다. null이 반환되면 다음 bundle이 설정되지 않았음을 의미합니다.
반환: Promise<BundleInfo | null>
Since: 6.8.0
setShakeMenu(…)
setShakeMenu(…)setShakeMenu(options: SetShakeMenuOptions) => Promise<void>테스트/디버깅 목적으로 shake 메뉴를 활성/비활성화합니다
| Param | Type | 설명 |
|---|---|---|
options | SetShakeMenuOptions | 스케일 메뉴가 활성화되거나 비활성화되는 boolean 값을 포함합니다. |
Since: 7.5.0
스케일 메뉴가 활성화되어 있는지 확인합니다.
스케일 메뉴 활성화 여부 확인isShakeMenuEnabled() => Promise<ShakeMenuEnabled>스케일 메뉴의 현재 상태를 가져옵니다.
Returns: Promise<ShakeMenuEnabled>
Since: 7.5.0
인터페이스
인터페이스AppReadyResult
AppReadyResult 섹션| 속성 | 타입 |
|---|---|
bundle | BundleInfo |
배포 정보
배포 정보 섹션| 속성 | 타입 |
|---|---|
id | string |
version | string |
downloaded | string |
checksum | string |
status | BundleStatus |
업데이트 URL
업데이트 URL 섹션| 속성 | 타입 |
|---|---|
url | string |
통계 URL
StatsUrl 섹션| 속성 | 타입 |
|---|---|
url | string |
채널 URL
채널 URL 섹션| 속성 | 타입 |
|---|---|
url | string |
다운로드 옵션
다운로드 옵션 섹션다운로드할 때 사용하는 URL 및 버전입니다. 백엔드 사용 시, getLatest 메서드에서 모든 정보를 제공합니다. 백엔드 사용하지 않으면 URL 및 버전을 제공해야 합니다. CLI 명령어로 암호화한 경우 세션 키가 필요합니다.
| 속성 | 타입 | 설명 | 기본값 | 시작 |
|---|---|---|---|---|
url | string | GitHub 배포본 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
BundleId 섹션| 속성 | 타입 |
|---|---|
id | string |
BundleListResult
BundleListResult 섹션| 속성 | 타입 |
|---|---|
bundles | BundleInfo[] |
ListOptions
ListOptions 섹션| 속성 | 타입 | 설명 | 기본값 | Since |
|---|---|---|---|---|
raw | boolean | 배포본 목록을 원본으로 반환할지 또는 매니페스트를 반환할지 여부를 지정합니다. true로 설정하면 내부 데이터베이스를 읽으려는 대신 디스크에 있는 파일을 읽습니다. | false | 6.14.0 |
ResetOptions
ResetOptions 섹션| 속성 | 타입 |
|---|---|
toLastSuccessful | boolean |
현재 배포본 결과
설정| 속성 | 타입 |
|---|---|
bundle | BundleInfo |
native | string |
MultiDelayConditions
MultiDelayConditions 섹션| 속성 | 타입 |
|---|---|
delayConditions | DelayCondition[] |
DelayCondition
DelayCondition| 속성 | 타입 | DelayCondition 섹션 |
|---|---|---|
kind | DelayUntilNext | 설명 |
value | string |
LatestVersion
최신 버전| 속성 | 타입 | 설명 | 버전 |
|---|---|---|---|
version | string | 업데이트 결과 | 4.0.0 |
checksum | string | 6 | |
major | boolean | ||
message | string | ||
sessionKey | string | ||
error | string | ||
old | string | ||
url | string | ||
manifest | ManifestEntry[] | 6.1 |
업데이트 옵션
업데이트 옵션| 속성 | 타입 | 설명 | 기본값 | 버전 |
|---|---|---|---|---|
channel | string | 최신 버전을 가져오기 위한 채널 The 채널은 'self_assign'을 허용해야 합니다. | undefined | 6.8.0 |
ChannelRes
채널Res 섹션| 속성 | 타입 | 설명 | 시작 |
|---|---|---|---|
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
채널 정보| 속성 | 타입 | 설명 | 시작 |
|---|---|---|---|
id | number | 숫자 채널 ID | 7.5.0 |
name | string | 채널 이름 | 7.5.0 |
public | boolean | true이면 기본 채널입니다. 장치가 공공 채널에 할당할 수 없습니다. 대신 장치가 채널 오버라이드 제거 (using __CAPGO_KEEP_0__를 사용하여) 할 때, 자동으로 업데이트를 받을 수 있는 매칭되는 공공 채널을 받습니다. unsetChannel()true이면 장치가 이 채널에 명시적으로 할당할 수 있습니다. 이 채널은 일반적으로 베타 테스트, A/B 테스트 또는 옵트인 업데이트 트랙에 사용됩니다. | 7.5.0 |
allow_self_set | boolean | 채널 명령은 채널 __CAPGO_KEEP_1__를 사용합니다. 이 숫자 __CAPGO_KEEP_2__를 사용하지 않습니다. setChannel()SetCustomIdOptions | 7.5.0 |
SetCustomIdOptions name속성 id.
| Capgo에 대한 정보 | Capgo에 대한 정보 |
|---|---|
customId | string |
내장 버전
내장 버전 섹션| 속성 | 타입 |
|---|---|
version | string |
디바이스 아이디
디바이스 아이디 섹션| 속성 | 타입 |
|---|---|
deviceId | string |
플러그인 버전
플러그인 버전 섹션| 속성 | 타입 |
|---|---|
version | string |
자동 업데이트 활성화
자동 업데이트 활성화| 속성 | 타입 |
|---|---|
enabled | boolean |
Capgo에 대한 정보 페이지
플러그인 리스너 처리| 속성 | 타입 |
|---|---|
remove | () => Promise<void> |
다운로드 이벤트
다운로드 이벤트| 속성 | 타입 | 설명 | Since |
|---|---|---|---|
percent | number | 다운로드 진행률, 0에서 100까지. | 4.0.0 |
bundle | BundleInfo |
NoNeedEvent
NoNeedEvent 섹션| 속성 | 타입 | 설명 | Since |
|---|---|---|---|
bundle | BundleInfo | 다운로드 진행률, 0에서 100까지. | 4.0.0 |
업데이트 가능 이벤트
업데이트 가능 이벤트 섹션| 속성 | 타입 | 설명 | 시작 |
|---|---|---|---|
bundle | BundleInfo | 다운로드 진행률 | 4.0.0 |
다운로드 완료 이벤트
다운로드 완료 이벤트| 속성 | 타입 | 설명 | 시작 |
|---|---|---|---|
bundle | BundleInfo | 새 업데이트가 준비되면 발행 | 4.0.0 |
메이저_가용_이벤트
메이저_가용_이벤트| 속성 | 타입 | 설명 | 시작 |
|---|---|---|---|
version | string | 새로운 메이저 버전이 사용 가능할 때 발생합니다. | 4.0.0 |
업데이트_실패_이벤트
업데이트_실패_이벤트| 속성 | 타입 | 설명 | Since |
|---|---|---|---|
bundle | BundleInfo | 설치 실패 시 발생하는 이벤트입니다. | 4.0.0 |
DownloadFailedEvent
다운로드 실패 이벤트| 속성 | 타입 | 설명 | Since |
|---|---|---|---|
version | string | 다운로드 실패 시 발생하는 이벤트입니다. | 4.0.0 |
AppReadyEvent
AppReadyEvent| 속성 | 종류 | 설명 | 버전 |
|---|---|---|---|
bundle | BundleInfo | 앱이 사용할 준비가되면 발생합니다. | 5.2.0 |
status | string |
자동 업데이트 가능
자동 업데이트 가능| 속성 | 종류 |
|---|---|
available | boolean |
셰이크 메뉴 옵션 설정
셰이크 메뉴 옵션 설정| 속성 | 종류 |
|---|---|
enabled | boolean |
ShakeMenuEnabled
ShakeMenuEnabled 섹션| 속성 | 타입 |
|---|---|
enabled | boolean |
타입 별칭
BundleStatusBundleStatus 섹션
대기 중: 다음 번들로 대기 중입니다.SET SET 성공: 번들이 다운로드되어 다음 번들로 준비되었습니다. SET 다음 버전으로 업그레이드. 오류: 버전을 다운로드하는 데 실패했습니다.
‘success’ | ‘error’ | ‘pending’ | ‘downloading’
DelayUntilNext
DelayUntilNext 섹션‘background’ | ‘kill’ | ‘nativeVersion’ | ‘date’
기능과 설정에서 계속 진행하세요
기능과 설정에서 계속 진행하세요 섹션Functions and settings을 사용하여 기능 및 설정 계획 대시보드와 API 작업을 연결하려면 Using @capgo/capacitor-updater Using @capgo/capacitor-updater를 사용하여 API 개요 API Overview 소개 소개에 대한 구현 세부 정보를 위해 API 키 API 키에 대한 구현 세부 정보를 위해, 및 장치 소개에 대한 구현 세부 정보를 위해