이벤트

Capacitor 업데이터 플러그인은 업데이트 프로세스를 모니터링하고 다양한 상태에 반응하는 데 사용할 수 있는 여러 이벤트를 제공합니다.

이벤트 리스너 설정

이벤트를 듣기 위해 사용하는 방법은 addListener 객체의 CapacitorUpdater 메소드입니다:

import { CapacitorUpdater } from '@capgo/capacitor-updater';

// Add a listener
const listener = await CapacitorUpdater.addListener('eventName', (event) => {
  // Handle the event
});

// Remove the listener when no longer needed
listener.remove();

// Remove all listeners
await CapacitorUpdater.removeAllListeners();

사용 가능한 이벤트

download

다운로드 프로세스 중에 발생하는 이벤트. 다운로드 진행 정보를 제공합니다.

CapacitorUpdater.addListener('download', (event) => {
  console.log(`Download progress: ${event.percent}%`);
  console.log('Bundle info:', event.bundle);
});

이벤트 데이터:

• percent: 숫자 - 다운로드 진행률 퍼센트 (0-100)
• bundle: BundleInfo - 다운로드 중인 배포판에 대한 정보

주의

다운로드 중에 여러 번 발생하여 진행률을 보고합니다.

noNeedUpdate

업데이트 확인 중에 업데이트가 필요하지 않음을 결정할 때 발생합니다.

CapacitorUpdater.addListener('noNeedUpdate', (event) => {
  console.log('App is up to date');
  console.log('Current bundle:', event.bundle);
});

이벤트 데이터:

• bundle: BundleInfo - 현재 버블의 정보

updateAvailable

클립보드 복사

CapacitorUpdater.addListener('updateAvailable', (event) => {
  console.log('Update available');
  console.log('New bundle:', event.bundle);
  // You can trigger a download here if needed
});

: BundleInfo - 다운로드 가능한 업데이트의 정보

• bundle다운로드가 완료되었습니다.

downloadComplete

이벤트 데이터:

CapacitorUpdater.addListener('downloadComplete', (event) => {
  console.log('Download completed');
  console.log('Downloaded bundle:', event.bundle);
  // You might want to set this bundle as next
});

Fired when a bundle download has completed successfully.

• bundle: BundleInfo - __CAPGO_KEEP_0__ downloaded bundle 정보

majorAvailable

메이저 업데이트가 사용자 설정의 자동 업데이트 설정으로 인해 차단되었을 때 발생하는 이벤트

CapacitorUpdater.addListener('majorAvailable', (event) => {
  console.log('Major update available:', event.version);
  // Notify user about major update
});

이벤트 데이터:

• version: string - 메이저 업데이트의 버전 번호

팁

메이저 업데이트는 일반적으로 사용자 확인 또는 앱 스토어 업데이트가 필요합니다. 사용자에게 적절히 알리기 위해 이 이벤트를 사용하세요.

updateFailed

다음 앱 시작 시 업데이트가 설치되지 못했을 때 발생하는 이벤트

CapacitorUpdater.addListener('updateFailed', (event) => {
  console.error('Update failed to install');
  console.log('Failed bundle:', event.bundle);
  // Handle rollback or retry logic
});

이벤트 데이터:

• bundle: BundleInfo - 설치에 실패한 번들을 위한 정보

downloadFailed

다운로드 실패 시 발생하는 이벤트

CapacitorUpdater.addListener('downloadFailed', (event) => {
  console.error('Download failed for version:', event.version);
  // Handle download retry logic
});

이벤트 데이터:

• version: string - 다운로드에 실패한 버전

appReloaded

앱이 다시 로드되었을 때 발생하는 이벤트

CapacitorUpdater.addListener('appReloaded', () => {
  console.log('App has been reloaded');
  // Perform any necessary reinitialization
});

이벤트 데이터: 없음

appReady

앱이 업데이트 후 사용할 준비가 되었을 때 발생하는 이벤트

CapacitorUpdater.addListener('appReady', (event) => {
  console.log('App is ready');
  console.log('Current bundle:', event.bundle);
  console.log('Status:', event.status);
});

이벤트 데이터:

• bundle: BundleInfo - 현재 번들에 대한 정보
• status: string - 준비 상태

주의

자동 롤백을 방지하기 위해 10초 이내에 호출해야 합니다. notifyAppReady() BundleInfo 객체

BundleInfo 객체

많은 이벤트는 다음 속성을 가진 객체를 포함합니다: BundleInfo 클립보드에 복사

interface BundleInfo {
  id: string;           // Unique bundle identifier
  version: string;      // Bundle version
  downloaded: string;   // Download timestamp
  checksum?: string;    // Bundle checksum (if available)
  status: BundleStatus; // Bundle status
}

할 수 있습니다: BundleStatus - 다운로드가 성공적으로 완료되었습니다.

• 'success' - 다운로드/설치가 실패했습니다.
• 'error' - 다음으로 설정될 예정인 패키지입니다.
• 'pending' - 현재 다운로드 중입니다.
• 'downloading' 예제: 완전한 업데이트 흐름

제목이 '예제: 완전한 업데이트 흐름'인 섹션

예제: 완전한 업데이트 흐름

주의

이 UpdateManager 이 클래스는 자동 업데이트 흐름에 필요한 호출을 포함하지 않습니다. 자동 업데이트에 대한 자세한 정보는 CapacitorUpdater.notifyAppReady() 클립보드에 복사 최선의 방법 최선의 방법 섹션

import { CapacitorUpdater } from '@capgo/capacitor-updater';

export class UpdateManager {
  private listeners: any[] = [];

  async setupListeners() {
    // Listen for available updates
    this.listeners.push(
      await CapacitorUpdater.addListener('updateAvailable', async (event) => {
        console.log('Update available:', event.bundle.version);
        // Auto-download the update
        await CapacitorUpdater.download({
          url: event.bundle.url,
          version: event.bundle.version
        });
      })
    );

    // Monitor download progress
    this.listeners.push(
      await CapacitorUpdater.addListener('download', (event) => {
        console.log(`Downloading: ${event.percent}%`);
        // Update UI progress bar
        this.updateProgressBar(event.percent);
      })
    );

    // Handle download completion
    this.listeners.push(
      await CapacitorUpdater.addListener('downloadComplete', async (event) => {
        console.log('Download complete:', event.bundle.version);
        // Set as next bundle
        await CapacitorUpdater.next({ id: event.bundle.id });
      })
    );

    // Handle failures
    this.listeners.push(
      await CapacitorUpdater.addListener('downloadFailed', (event) => {
        console.error('Download failed:', event.version);
        this.showError('Update download failed. Please try again later.');
      })
    );

    this.listeners.push(
      await CapacitorUpdater.addListener('updateFailed', (event) => {
        console.error('Update installation failed:', event.bundle.version);
        this.showError('Update installation failed. The app has been rolled back.');
      })
    );

    // Handle app ready
    this.listeners.push(
      await CapacitorUpdater.addListener('appReady', async (event) => {
        console.log('App ready with bundle:', event.bundle.version);
      })
    );
  }

  cleanup() {
    // Remove all listeners when no longer needed
    this.listeners.forEach(listener => listener.remove());
    this.listeners = [];
  }

  private updateProgressBar(percent: number) {
    // Update your UI progress bar
  }

  private showError(message: string) {
    // Show error to user
  }
}

__CAPGO_KEEP_0__

1. __CAPGO_KEEP_0__ notifyAppReady()__CAPGO_KEEP_0__

2. 실패를 용감하게 처리하십시오: 다운로드 및 업데이트 실패 시 적절한 오류 처리를 구현하십시오.

3. 사용자 피드백 제공: 다운로드 진행 이벤트를 사용하여 사용자에게 업데이트 진행 상황을 표시하십시오.

4. 리스너 정리: 더 이상 필요하지 않은 이벤트 리스너를 제거하여 메모리 누수를 방지하십시오.

5. 업데이트 시나리오 테스트: 실패, 롤백, 및 주요 업데이트와 같은 다양한 업데이트 시나리오를 테스트하십시오.