Pengaturan

Untuk memiliki kontrol yang lebih halus atas sistem pembaruan, Anda dapat mengonfigurasi dengan pengaturan ini:

Trik

Perubahan apa pun pada pengaturan ini di file capacitor.config memerlukan sinkronisasi platform dan rilis ke toko untuk aplikasi produksi menerima mereka.

Catatan

Perlu data residensi Eropa untuk Capgo Cloud? Atur updateUrl ke https://plugin.eu.capgo.app/updates, statsUrl ke https://plugin.eu.capgo.app/stats, dan channelUrl ke https://plugin.eu.capgo.app/channel_self. Lihat Lokasi Data.

allowModifyUrl

Biarkan plugin mengubah updateUrl, statsUrl, dan channelUrl secara dinamis dari sisi JavaScript.

Tersedia pada Android, iOS, dan Electron.

Default: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "allowModifyUrl": true
    }
  }
}

appId

Konfigurasi ID aplikasi untuk aplikasi di konfigurasi.

tersedia pada Android, iOS, dan Electron.

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appId": "com.example.app"
    }
  }
}

appReadyTimeout

Konfigurasi waktu tunggu dalam milisecond sebelum plugin asli menganggap update gagal.

tersedia pada Android, iOS, dan Electron.

Default: 10000 (10 detik)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000
    }
  }
}

autoDeleteFailed

Konfigurasi apakah plugin harus secara otomatis menghapus bundle yang gagal.

Tersedia pada Android, iOS, dan Electron.

Berikut default: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeleteFailed": false
    }
  }
}

autoDeletePrevious

Konfigurasi apakah plugin harus secara otomatis menghapus bundle sebelumnya setelah update sukses.

Tersedia pada Android, iOS, dan Electron.

Berikut default: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeletePrevious": false
    }
  }
}

autoSplashscreen

Diwajibkan ketika menggunakan mode aplikasi instan ("atInstall", "onLaunch", or "always"termasuk yang sudah tidak digunakan directUpdate __CAPGO_KEEP_0__.config.json @capacitor/splash-screen dan atur launchAutoHide: false. When enabled, the plugin hides the splashscreen after updates are applied or when no update is needed. This removes the need to manually listen for appReady events and call SplashScreen.hide().

Tersedia di Android dan iOS.

Default: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall",
      "autoSplashscreen": true
    },
    "SplashScreen": {
      "launchAutoHide": false
    }
  }
}

autoUpdate

Konfigurasi cara plugin memeriksa, mendownload, dan menerapkan pembaruan hidup. Plugin memeriksa pembaruan ketika aplikasi berpindah ke latar depan dan pada timer yang berulang sementara aplikasi tetap terbuka. periodCheckDelay pengaturan interval timer. Nilai boolean masih didukung untuk konsistensi ke belakang: true sama seperti "atBackground" dan false sama seperti "off"String nilai menggabungkan konfigurasi Auto Update dan Pembaruan Langsung sebelumnya.

Pilihan:

• "off" atau false: Matikan pembaruan otomatis
• "atBackground" atau true: Periksa dan download secara otomatis pada setiap periksa latar depan, kemudian terapkan pembaruan ketika aplikasi berpindah ke latar belakang
• "atInstall": Aplikasikan segera hanya setelah instalasi segar atau pembaruan toko aplikasi asli; lainnya gunakan "atBackground" perilaku
• "onLaunch"Terapkan segera hanya ketika aplikasi dibawa ke depan dari keadaan mati (cold start). Setelah itu, kembali ke "atBackground" perilaku
• "always"Periksa setiap transisi latar depan dan terapkan segera ketika update tersedia
• "onlyDownload"Cek dan download secara otomatis, siapkan updateAvailableTidak pernah mengatur bundle berikutnya atau menerapkan pembaruan secara otomatis

Mode aplikasi instan (""atInstall", "onLaunch", "always"Mengaplikasikan saat pengguna menunggu. Unggah dengan npx @capgo/cli@latest bundle upload --delta Hanya file yang berubah diunduh. Mengunggah zip penuh memperlambat pengalaman pengguna. Pada Android dan iOS, mode ini memerlukan autoSplashscreen: true and @capacitor/splash-screen dan, dengan launchAutoHide: false.

tersedia pada Android, iOS, dan Electron.

Default: "atBackground" (true masih diterima)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "onlyDownload"
    }
  }
}

channelUrl

Konfigurasi URL / endpoint untuk operasi channel.

tersedia pada Android, iOS, dan Electron.

Default: https://plugin.capgo.app/channel_self

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "channelUrl": "https://example.com/api/channel"
    }
  }
}

defaultChannel

Setel saluran default untuk aplikasi di konfigurasi. Case sensitive. Pengaturan ini akan menggantikan saluran default yang ditetapkan di awan, tetapi masih akan menghormati pengaturan yang diubah di awan.

Tersedia pada Android, iOS, dan Electron.

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "defaultChannel": "production"
    }
  }
}

directUpdate

Usang. Gunakan autoUpdate mode string daripada: "atInstall", "onLaunch", or "always"Tetapkan opsi ini untuk aplikasi yang sudah ada. Instant apply harus diunggah dengan --delta Jadi pembaruan tidak akan memperlambat pengalaman pengguna. Mode-mode ini memerlukan autoSplashscreen: true context @capacitor/splash-screen dengan launchAutoHide: false.

Pilihan:

• false: Tidak melakukan pembaruan langsung
• 'atInstall': Sama seperti autoUpdate: "atInstall"
• 'onLaunch': Sama seperti autoUpdate: "onLaunch"
• 'always': Sama seperti autoUpdate: "always"
• true: (tersisa) Sama seperti "always" untuk kompatibilitas mundur

Tersedia pada Android, iOS, dan Electron.

Default: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall"
    }
  }
}

disableJSLogging

Nonaktifkan log JavaScript plugin. Jika benar, plugin tidak akan menulis ke konsol JavaScript. Hanya log native yang akan dilakukan.

Tersedia pada Android, iOS, dan Electron.

Bawaan: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "disableJSLogging": true
    }
  }
}

keepUrlPathAfterReload

Konfigurasi plugin untuk menjaga URL path setelah reload.

Peringatan

Saat reload dilakukan, ‘window.history’ akan dihapus.

Tersedia pada Android, iOS, dan Electron.

Default: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "keepUrlPathAfterReload": true
    }
  }
}

periodCheckDelay

Konfigurasi periode tunggu untuk cek pembaruan periodik. Satuan waktu dalam detik. Tidak dapat kurang dari 600 detik (10 menit).

Tersedia pada Android, iOS, dan Electron.

Default: 600 (10 menit)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "periodCheckDelay": 600 // (10 minutes)
    }
  }
}

publicKey

Konfigurasi kunci publik untuk enkripsi akhir ke akhir live update versi 2.

Tersedia pada Android, iOS, dan Electron.

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "publicKey": "YOUR_PUBLIC_KEY"
    }
  }
}

Peringatan

publicKey mengatur Enkripsi V2 dan harus sesuai dengan kunci pribadi yang digunakan selama unggahan. Untuk pembaruan Delta, gunakan enkripsi V2 dengan enkripsi parsial diaktifkan, dan aktifkan pengecekan paket enkripsi jika organisasi Anda memerlukan setiap unggahan untuk dienkripsi. Jangan bergantung pada publicKey sebagai kebijakan sisi server untuk mencegah pembaruan Delta yang tidak dienkripsi.

resetWhenUpdate

Menghapus otomatis paket yang telah diunduh sebelumnya ketika paket aplikasi native yang lebih baru diinstal ke perangkat.

Tersedia pada Android, iOS, dan Electron.

Default: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "resetWhenUpdate": false
    }
  }
}

responseTimeout

Konfigurasi jumlah milidetik plugin native harus menunggu sebelum menganggap API timeout.

Tersedia pada Android, iOS, dan Electron.

Baku: 20 (20 detik)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "responseTimeout": 10 // (10 seconds)
    }
  }
}

shakeMenu

Aktifkan gerakan goncang untuk menampilkan menu pembaruan untuk tujuan debugging/testing.

Tersedia pada Android, iOS, dan Electron.

Default: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "shakeMenu": true
    }
  }
}

statsUrl

Konfigurasi URL / endpoint ke mana data update statistik dikirim.

tersedia pada Android, iOS, dan Electron. Atur ke "" untuk menghapus laporan statistik eksplisit melalui /stats.

Menghapus statsUrl Tidak menghapus semua penyimpanan perangkat Capgo. Jika updateUrl tetap diaktifkan, /updates masih menyimpan baris pembayaran MAU, inventori perangkat, dan data keputusan update yang diperlukan untuk menyajikan update dan menghitung MAU. Lihat Komitmen untuk penjelasan level bidang.

Default: https://plugin.capgo.app/stats

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "statsUrl": "https://example.com/api/stats"
    }
  }
}

updateUrl

Konfigurasi URL / endpoint yang digunakan untuk memeriksa pembaruan.

Bisa digunakan pada Android, iOS, dan Electron.

Default: https://plugin.capgo.app/updates

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "updateUrl": "https://example.com/api/auto_update"
    }
  }
}

version

Konfigurasi versi aplikasi saat ini. Versi ini akan digunakan untuk permintaan pembaruan pertama. Jika tidak dikonfigurasi, plugin akan mendapatkan versi dari native code.

Bisa digunakan pada Android, iOS, dan Electron.

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "version": "1.0.0"
    }
  }
}

Pengaturan Pengembangan

localApi

Konfigurasi CLI untuk menggunakan api lokal untuk tes.

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApi": "http://localhost:54321/functions/v1"
    }
  }
}

localApiFiles

Konfigurasi CLI untuk menggunakan file api lokal untuk tes.

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApiFiles": "http://localhost:54321/functions/v1/files"
    }
  }
}

localHost

Konfigurasi CLI untuk menggunakan server lokal untuk pengujian atau server pembaruan self-hosted.

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localHost": "http://localhost:5173"
    }
  }
}

localSupa

Konfigurasi CLI untuk menggunakan server lokal untuk pengujian atau server pembaruan self-hosted.

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupa": "http://localhost:54321"
    }
  }
}

localSupaAnon

Konfigurasi CLI untuk menggunakan server lokal untuk tes.

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupaAnon": "YOUR_LOCAL_ANON_KEY"
    }
  }
}

localWebHost

Konfigurasi CLI untuk menggunakan server lokal untuk tes atau server pembaruan self-hosted.

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localWebHost": "http://localhost:5173"
    }
  }
}

Tips

Ada pengaturan tambahan yang tersedia di Capgo aplikasi web yang dapat dikonfigurasi per saluran tanpa memerlukan rilis aplikasi native.

Teruskan dari Pengaturan

Jika Anda menggunakan Pengaturan Untuk merencanakan dashboard dan operasi API, hubungkannya dengan Menggunakan @capgo/capacitor-updater untuk kemampuan asli di Menggunakan @capgo/capacitor-updater, untuk kemampuan native di Menggunakan @API/__CAPGO_KEEP_1__-updater, yang merupakan API Ringkasan untuk detail implementasi di API Panduan Umum, Pendahuluan untuk detail implementasi di Pendahuluan, API Kunci untuk detail implementasi di API Kunci, dan Perangkat untuk detail implementasi di Perangkat.