Mulai

Pemasangan

Anda dapat menggunakan Pengaturan Bantu AI untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI Anda menggunakan perintah berikut:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Lalu gunakan prompt berikut:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-updater` plugin in my project.

Jika Anda lebih suka Pengaturan Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:

npm

bun add @capgo/capacitor-updater
bunx cap sync

yarn

yarn add @capgo/capacitor-updater
bunx cap sync

pnpm

pnpm add @capgo/capacitor-updater
bunx cap sync

bun

bun add @capgo/capacitor-updater
bunx cap sync

Mulai Cepat

Bagi pengguna kebanyakan, kami merekomendasikan mengikuti panduan Quickstart utama panduan ini mencakup baik instalasi plugin dan __CAPGO_KEEP_0__ integrasi cloud. which covers both the plugin installation and Capgo cloud integration.

Pendahuluan

Judul Bagian “Pendahuluan”

The Capacitor Updater plugin enables over-the-air (OTA) updates for your Capacitor applications. This allows you to push updates to your app without going through app store reviews.

Judul Bagian “Bagaimana Cara Kerjanya”

1. Paket Unduh: Plugin ini mengunduh bundle pembaruan (file ZIP yang berisi aset web Anda)
2. Ekstraksi: Bundle dibongkar ke penyimpanan perangkat
3. Hot Reload: Aplikasi beralih ke bundle baru tanpa memerlukan restart
4. Gagal Ambil: Jika pembaruan gagal, aplikasi kembali ke versi kerja sebelumnya

Mode Penggunaan

1. Mode Pembaruan Otomatis (Dianjurkan)

Metode Termudah untuk Menggunakan Plugin dengan Pengelolaan Pembaruan Otomatis:

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

// Plugin handles everything automatically
// Configure in capacitor.config.ts

Tambahkan ke capacitor.config.ts:

{
  plugins: {
    CapacitorUpdater: {
      autoUpdate: 'atBackground',
      updateUrl: 'https://your-update-server.com/api/updates'
    }
  }
}

2. Mode Manual

Untuk kendali lanjutan atas proses pembaruan:

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

// Download an update
const bundle = await CapacitorUpdater.download({
  url: 'https://your-server.com/updates/v1.0.1.zip',
  version: '1.0.1'
});

// Set the bundle (will be used on next app start)
await CapacitorUpdater.set({
  id: bundle.id
});

// Or reload immediately
await CapacitorUpdater.reload();

Konfigurasi Platform

iOS

Tidak diperlukan konfigurasi tambahan. Plugin ini berfungsi secara otomatis.

Android

Tidak perlu konfigurasi tambahan. Plugin ini berfungsi secara otomatis.

Penggunaan Dasar API

Unduh Perbarui

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

const bundle = await CapacitorUpdater.download({
  url: 'https://example.com/update.zip',
  version: '1.0.1'
});

console.log('Downloaded bundle:', bundle.id);

Set Aktifkan Paket

// Set bundle to be used on next app start
await CapacitorUpdater.set({
  id: bundle.id
});

Muat Ulang dengan Paket Baru

// Reload app immediately with new bundle
await CapacitorUpdater.reload();

Daftar Paket

const { bundles } = await CapacitorUpdater.list();
console.log('Available bundles:', bundles);

Hapus Paket

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

Ambil Paket Saat Ini

const { bundle } = await CapacitorUpdater.current();
console.log('Current bundle:', bundle.version);

Dengar Pemberitahuan

Dengarkan event pembaruan:

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

// Listen for download progress
CapacitorUpdater.addListener('download', (info) => {
  console.log('Download progress:', info.percent);
});

// Listen for download completion
CapacitorUpdater.addListener('downloadComplete', (bundle) => {
  console.log('Download complete:', bundle.version);
});

// Listen for update failures
CapacitorUpdater.addListener('updateFailed', (error) => {
  console.error('Update failed:', error);
});

// Listen for successful updates
CapacitorUpdater.addListener('updateAvailable', (info) => {
  console.log('Update available:', info.version);
});

Pilihan Konfigurasi

Konfigurasi plugin di capacitor.config.ts:

{
  plugins: {
    CapacitorUpdater: {
      // Auto-update settings
      autoUpdate: 'atBackground',
      updateUrl: 'https://api.example.com/updates',

      // Update behavior
      resetWhenUpdate: true,

      // Version settings
      version: '1.0.0',

      // Security
      allowModifyUrl: false,

      // Stats collection
      statsUrl: 'https://api.example.com/stats',

      // Channel (for Capgo cloud)
      defaultChannel: 'production'
    }
  }
}

Gaya Integrasi

Dengan Cloud Capgo

Cara termudah untuk memulai:

// Install the Capgo CLI
bun add -g @capgo/cli

// Login to Capgo
npx @capgo/cli login

// Upload your first bundle
npx @capgo/cli bundle upload

// The plugin auto-updates from Capgo cloud

Lihat panduan Petunjuk cepat utama untuk detail.

Pembaruan Otomatis

Tetapkan server pembaruan Anda sendiri:

// Configure your update endpoint
{
  plugins: {
    CapacitorUpdater: {
      autoUpdate: 'atBackground',
      updateUrl: 'https://your-server.com/api/check-update'
    }
  }
}

Server Anda harus mengembalikan:

{
  "version": "1.0.1",
  "url": "https://your-server.com/updates/1.0.1.zip"
}

Lihat Mode Otomatis Untuk detail lengkap.

Alur Perbarui Manual

Penuh kontrol atas perbarui:

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

async function checkAndUpdate() {
  // Check for updates from your server
  const response = await fetch('https://api.example.com/check-update');
  const { version, url } = await response.json();

  // Download the update
  const bundle = await CapacitorUpdater.download({
    url,
    version
  });

  // Notify bundle is ready
  await CapacitorUpdater.notifyAppReady();

  // Set as next version
  await CapacitorUpdater.set({ id: bundle.id });

  // Reload when ready
  await CapacitorUpdater.reload();
}

Praktik Terbaik

• Selalu panggil notifyAppReady() ketika aplikasi Anda berhasil dimuat
• Perbarui secara teliti sebelum memasukkannya ke produksi
• Implementasikan penanganan kesalahan yang tepat untuk gagal jaringan
• Gunakan nomor versi secara konsisten
• Pastikan ukuran bundle tetap kecil untuk download yang lebih cepat
• Monitorlah tingkat kesuksesan update

Langkah-Langkah Selanjutnya

• Referensi Plugin API - Dokumentasi lengkap API
• Pengaturan Plugin - Semua opsi pengaturan
• Event - Event update yang tersedia
• Mode Diri Sendiri - Jalankan server update sendiri
• Pengembangan Lokal - Uji coba pembaruan secara lokal
• Pengembangan - Panduan troubleshooting

Bantuan

• Judul Bagian: Bantuan Masalah yang Dikenal
• GitHub Discussions __CAPGO_KEEP_0__ Diskusi
• - Dukungan komunitas Discord (Discord) - Percakapan waktu nyata

Mengikuti dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan pekerjaan plugin native, hubungkannya dengan Menggunakan @capgo/capacitor-updater untuk kemampuan native di Menggunakan @capgo/capacitor-updater, Capgo Direktori Plugin untuk alur kerja produk di Capgo Direktori Plugin, Capacitor Plugin oleh Capgo untuk detail implementasi di Capacitor Plugin oleh Capgo, Mengambah atau Mengupdate Plugin untuk detail implementasi di Menambahkan atau Mengupdate Plugin, dan Alternatif Plugin Perusahaan Ionic untuk alur kerja produk di Alternatif Plugin Perusahaan Ionic.