Electron Updater API 참조

이 페이지는 Electron Updater의 모든 사용 가능한 메서드, 이벤트 및 구성 옵션을 문서화합니다.

기본 메서드

모든 앱 런치 시 호출해야 합니다.

클립보드에 복사 주의: 사용에 주의가 필요합니다.

await updater.notifyAppReady();

주의

__CAPGO_KEEP_0__에서 호출되지 않으면 appReadyTimeout (기본 10 초), 업데이트 실패로 간주되어 이전 버전으로 롤백됩니다.

__CAPGO_KEEP_0__(options)

URL에서 패키지를 다운로드합니다.

const bundle = await updater.download({
  url: 'https://example.com/bundle.zip',
  version: '1.0.1',
  checksum: 'sha256-hash', // Optional but recommended
  sessionKey: '...', // For encrypted bundles
});

매개 변수:

옵션	타입	필수	설명
url	__CAPGO_KEEP_0__	__CAPGO_KEEP_1__	__CAPGO_KEEP_2__
version	__CAPGO_KEEP_0__	__CAPGO_KEEP_1__	__CAPGO_KEEP_3__
checksum	__CAPGO_KEEP_4__	__CAPGO_KEEP_5__	__CAPGO_KEEP_6__
sessionKey	__CAPGO_KEEP_7__	__CAPGO_KEEP_8__	__CAPGO_KEEP_9__

반환: BundleInfo 객체에 id, version, status

next(options)

앱이 다시 시작될 때 다음으로 로드될 배포를 큐에 추가합니다.

await updater.next({ id: 'bundle-id' });

매개 변수:

옵션	타입	필수	설명
id	문자열	네	Bundle ID를 큐에 추가

__CAPGO_KEEP_0__

즉시 앱을 재로드하고 Bundle로 Switch합니다.

await updater.set({ id: 'bundle-id' });

매개 변수:

옵션	타입	필수	설명
id	문자열	Yes	Bundle ID to activate

reload()

Manually reload the app with the current bundle.

await updater.reload();

Section titled “”

Copy to clipboard

await updater.delete({ id: 'bundle-id' });

Parameters:

Option	타입	필수	설명
id	string	Yes	삭제할 번들 ID

reset(options)

기본 버전 또는 마지막 성공 번들을 복원합니다.

// Reset to builtin
await updater.reset({ toLastSuccessful: false });

// Reset to last successful bundle
await updater.reset({ toLastSuccessful: true });

매개 변수:

옵션	타입	필수	설명
toLastSuccessful	boolean	아니요	true가면 마지막 성공한 번들로 리셋합니다.

번들 정보

현재()

현재 번들 및 네이티브 버전 정보를 가져옵니다.

const info = await updater.current();
// { bundle: { id, version, status }, native: '1.0.0' }

__CAPGO_KEEP_0__

__CAPGO_KEEP_2__

const bundles = await updater.list();
// [{ id, version, status, downloaded, checksum }, ...]

__CAPGO_KEEP_4__

__CAPGO_KEEP_6__

const next = await updater.getNextBundle();
// { id, version, status } or null

__CAPGO_KEEP_8__

__CAPGO_KEEP_10__

const failed = await updater.getFailedUpdate();
// { id, version, reason } or null

getBuiltinVersion()

앱 바이너리와 함께 제공되는 버전을 가져옵니다.

const version = await updater.getBuiltinVersion();
// '1.0.0'

업데이트 확인

getLatest(options)

서버에서 가장 최신 버전을 확인합니다.

const latest = await updater.getLatest();

if (latest.url && !latest.error) {
  // Update available
  console.log('New version:', latest.version);
  console.log('Download URL:', latest.url);
} else if (latest.error) {
  console.error('Error checking updates:', latest.error);
}

반환:

속성	버전	설명
url	문자열	다운로드 URL (업데이트가 없으면 빈 문자열)
version	문자열	사용 가능한 버전
checksum	SHA256 체크섬	암호화 세션 키
sessionKey	체크 실패 시 오류 메시지	__CAPGO_KEEP_0__
error	__CAPGO_KEEP_1__	__CAPGO_KEEP_2__
message	string	서버 메시지

채널 관리

채널을 특정 채널에 할당합니다.

채널 할당을 취소하고 기본값을 사용합니다.

await updater.setChannel({ channel: 'beta' });

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__

await updater.unsetChannel();

getChannel()

현재 채널 assignments을 가져옵니다.

const channel = await updater.getChannel();
// { channel: 'production', status: 'set' }

listChannels()

이 앱에 사용 가능한 모든 채널을 목록화합니다.

const channels = await updater.listChannels();
// ['production', 'beta', 'staging']

다운로드 된 업데이트를 적용하는 시기를 제어합니다.

멀티 딜레이 옵션을 설정합니다.

Copy to clipboard

업데이트가 적용되기 전에 충족해야 하는 조건을 설정합니다.

// Wait for app to be backgrounded
await updater.setMultiDelay({
  delayConditions: [{ kind: 'background' }]
});

// Wait until specific date
await updater.setMultiDelay({
  delayConditions: [{ kind: 'date', value: '2024-12-25T00:00:00Z' }]
});

// Wait for app to be killed and restarted
await updater.setMultiDelay({
  delayConditions: [{ kind: 'kill' }]
});

// Multiple conditions (all must be met)
await updater.setMultiDelay({
  delayConditions: [
    { kind: 'background' },
    { kind: 'date', value: '2024-12-25T00:00:00Z' }
  ]
});

지연 조건 유형:

종류	값	설명
background	선택적 지연 시간 (ms)	앱이 백그라운드에 들어가기를 기다립니다.
kill	-	앱이 종료되고 다시 시작되기를 기다립니다.
date	ISO 날짜 문자열	특정 날짜/시간까지 기다립니다.
nativeVersion	버전 문자열	네이티브 앱 업데이트 기다리기

cancelDelay()

즉시 업데이트 적용을 위해 다음 체크 시 모든 지연 조건을 취소합니다.

await updater.cancelDelay();

기기 식별

getDeviceId()

기기 고유 식별자를 가져옵니다.

const deviceId = await updater.getDeviceId();
// 'uuid-xxxx-xxxx-xxxx'

__CAPGO_KEEP_0__

__CAPGO_KEEP_2__

await updater.setCustomId({ customId: 'user-123' });

__CAPGO_KEEP_4__

__CAPGO_KEEP_6__

__CAPGO_KEEP_8__

await updater.setUpdateUrl({ url: 'https://my-server.com/updates' });

__CAPGO_KEEP_11__

Requires allowModifyUrl: true 생성자 옵션에서 지정합니다.

setStatsUrl(options)

통계 보고 URL을 변경합니다.

await updater.setStatsUrl({ url: 'https://my-server.com/stats' });

setChannelUrl(options)

채널 관리 URL을 변경합니다.

await updater.setChannelUrl({ url: 'https://my-server.com/channel' });

setAppId(options)

runtime에서 App ID를 변경하세요.

await updater.setAppId({ appId: 'com.example.newapp' });

주의

필요한 allowModifyAppId: true 생성자 옵션에서.

getAppId()

현재 App ID를 가져옵니다.

const appId = await updater.getAppId();

debug

setDebugMenu(options)

Debug 메뉴를 사용하거나 비활성화합니다.

await updater.setDebugMenu({ enabled: true });

isDebugMenuEnabled()

클립보드에 복사

const enabled = await updater.isDebugMenuEnabled();

Debug 메뉴 업데이트 이벤트를 듣기 위해

이벤트 addListener:

updater.addListener('eventName', (event) => {
  // Handle event
});

이벤트 목록

이벤트	데이터	설명
download	{ percent, status }	다운로드 진행 상황 업데이트
updateAvailable	{ bundle }	새로운 업데이트가 있습니다
noNeedUpdate	{ message }	업데이트가 최신 상태입니다
downloadComplete	{ bundle }	다운로드가 성공적으로 완료되었습니다
downloadFailed	{ bundle, error }	다운로드 실패
breakingAvailable	{ bundle }	업데이트가 호환되지 않습니다 (네이티브 업데이트가 필요합니다)
updateFailed	{ bundle, reason }	업데이트 설치가 실패했습니다
appReloaded	{}	앱이 다시 로드되었습니다
appReady	{}	notifyAppReady() __CAPGO_KEEP_0__가 호출되었습니다

예시: 전체 이벤트 처리

// Progress tracking
updater.addListener('download', (event) => {
  updateProgressBar(event.percent);
});

// Update available notification
updater.addListener('updateAvailable', (event) => {
  showNotification(`Update ${event.bundle.version} available!`);
});

// Handle completion
updater.addListener('downloadComplete', async (event) => {
  // Queue for next restart
  await updater.next({ id: event.bundle.id });
  showNotification('Update will apply on next restart');
});

// Handle failures
updater.addListener('updateFailed', (event) => {
  console.error('Update failed:', event.reason);
  reportError(event);
});

생성자 옵션

전체 구성 옵션 ElectronUpdater:

const updater = new ElectronUpdater({
  // Required
  appId: 'com.example.app',

  // Version override
  version: '1.0.0', // Override builtin version detection

  // Server URLs
  updateUrl: 'https://plugin.capgo.app/updates',
  channelUrl: 'https://plugin.capgo.app/channel_self',
  statsUrl: 'https://plugin.capgo.app/stats',

  // Behavior
  autoUpdate: true,           // Enable automatic update checks
  appReadyTimeout: 10000,     // Milliseconds before rollback (default: 10000)
  autoDeleteFailed: true,     // Auto-delete failed bundles
  autoDeletePrevious: true,   // Auto-delete old bundles
  resetWhenUpdate: true,      // Reset to builtin on native update

  // Channels
  defaultChannel: 'production',

  // Direct Update Mode
  directUpdate: false,        // 'atInstall' | 'onLaunch' | 'always' | false

  // Security
  publicKey: '...',           // RSA public key for E2E encryption

  // Dynamic Configuration
  allowModifyUrl: false,      // Allow runtime URL changes
  allowModifyAppId: false,    // Allow runtime App ID changes
  persistCustomId: false,     // Persist custom ID across updates
  persistModifyUrl: false,    // Persist URL changes

  // Debug
  debugMenu: false,           // Enable debug menu (Ctrl+Shift+D)
  disableJSLogging: false,    // Disable console logs

  // Periodic Updates
  periodCheckDelay: 0,        // Seconds between auto-checks (0 = disabled, min 600)
});

API Electron Updater에서 계속하기

Capgo를 사용 중이라면 Electron Updater API 참고문서 API 대시보드와 운영을 계획하고 연결하세요. @capgo/electron-updater를 사용하여 @capgo/electron-updater를 사용하여 Native 기능을 구현하는 경우, API 개요 API 개요에서 구현 세부 정보를 참조하세요. 소개 소개에서 구현 세부 정보를 참조하세요. API 키 API 키에서 구현 세부 정보를 참조하세요. 그리고 기기 기기에서 구현 세부 정보를 참조하세요.