Pengaturan

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

Tip

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

Catatan

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

Untuk menggunakan hostname Anda sendiri untuk updateUrl, statsUrldan channelUrlLihat, lihat Pengaturan Domain Kustom.

allowModifyUrl

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

tersedia pada Android, iOS, dan Electron.

Batasan Default: false

capacitor.config.json

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

appId

Konfigurasi ID aplikasi untuk aplikasi di konfigurasi.

tersedia pada Android, iOS, dan Electron.

Batasan Default: undefined

capacitor.config.json

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

appReadyTimeout

Konfigurasi jumlah milidetik plugin native harus menunggu sebelum memandang sebuah pembaruan ‘gagal’.

Tersedia pada Android, iOS, dan Electron.

Batasan default: 10000 (10 detik)

capacitor.config.json

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

autoDeleteFailed

Konfigurasi apakah plugin harus menghapus bundle yang gagal secara otomatis.

Tersedia pada Android, iOS, dan Electron.

Default: true

capacitor.config.json

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

autoDeletePrevious

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

Tersedia pada Android, iOS, dan Electron.

Default: true

capacitor.config.json

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

autoSplashscreen

Diperlukan ketika menggunakan mode aplikasi instan (“, atau "atInstall", "onLaunch", or "always"), termasuk yang sudah tidak digunakan directUpdate nilai-nilai. Pasang @capacitor/splash-screen dan atur launchAutoHide: false. Ketika diaktifkan, plugin menyembunyikan layar splashscreen setelah pembaruan diterapkan atau ketika tidak ada pembaruan yang diperlukan. Hal ini menghilangkan kebutuhan untuk mendengarkan event appReady secara manual dan memanggil SplashScreen.hide().

Tersedia pada Android dan iOS.

Bawaan: false

capacitor.config.json

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

autoUpdate

Configure how the plugin checks for, downloads, and applies live updates. The plugin checks for updates when the app moves to the foreground and on a repeating timer while the app stays open. periodCheckDelay Interval kontrol timer yang. Nilai boolean masih didukung untuk konsistensi ke belakang: true Sama dengan "atBackground" dan false sama seperti "off"String nilai-nilai ini menggabungkan konfigurasi Auto Update dan Direct Update sebelumnya.

Pilihan:

• "off" atau false: Nonaktifkan periksa update otomatis
• "atBackground" atau true: Periksa dan download secara otomatis pada setiap periksa latar depan, kemudian aplikasikan update pada saat aplikasi berpindah ke latar belakang
• "atInstall": Aplikasikan segera hanya setelah instalasi segar atau update aplikasi toko native; lainnya gunakan "atBackground" tingkah laku
• "onLaunch"Terapkan segera hanya ketika aplikasi dibawa ke depan dari keadaan mati (cold start). Setelah itu, kembali ke "atBackground" tingkah laku
• "always": Periksa setiap transisi latar depan dan terapkan segera ketika update tersedia
• "onlyDownload": Periksa dan download secara otomatis, emit updateAvailable, dan tidak pernah menetapkan bundle berikutnya atau menerapkan update secara otomatis

Mode aplikasi instan ("atInstall", "onLaunch", "always") berlaku saat pengguna menunggu. Unggah dengan npx @capgo/cli@latest bundle upload --delta jadi hanya file yang berubah saja yang diunduh. Unggah zip penuh memperlambat pengalaman pengguna. Pada Android dan iOS, mode-mode ini memerlukan autoSplashscreen: true dan @capacitor/splash-screen bersama 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 kanal.

Terjangkau pada Android, iOS, dan Electron.

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

capacitor.config.json

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

defaultChannel

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

Terjangkau pada Android, iOS, dan Electron.

Bawaan: undefined

capacitor.config.json

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

directUpdate

Sudah tidak digunakan. Gunakan autoUpdate mode string saja: "atInstall", "onLaunch", atau "always". Opsi ini tetap mendukung aplikasi yang sudah ada. Instant apply harus diunggah dengan --delta Jadi pembaruan tidak akan memperlambat pengalaman pengguna. Mode-mode ini memerlukan autoSplashscreen: true dan @capacitor/splash-screen dengan launchAutoHide: false.

Opsi:

• false: Tidak pernah melakukan update langsung
• 'atInstall': Sama seperti autoUpdate: "atInstall"
• 'onLaunch'Sama seperti : autoUpdate: "onLaunch"
• 'always'Sama seperti : autoUpdate: "always"
• trueSama seperti (deprecated) : "always" Untuk kompatibilitas mundur :

Tersedia pada Android, iOS, dan Electron.

Bawaan : false

capacitor.config.json

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

disableJSLogging

Menghilangkan 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

Ketika reload diaktifkan, ‘window.history’ akan dihapus.

tersedia pada Android, iOS, dan Electron.

Bawaan: false

capacitor.config.json

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

periodCheckDelay

Konfigurasi periode menunggu untuk cek pembaruan periode. Satuan 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 Konfigurasi 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 bundel enkripsi jika organisasi Anda memerlukan setiap unggahan untuk dienkripsi. Jangan bergantung pada publicKey sendiri sebagai kebijakan sisi server yang mencegah pembaruan Delta tidak dienkripsi.

resetWhenUpdate

Hapus otomatis bundle yang diunduh sebelumnya ketika bundle aplikasi native yang lebih baru diinstal ke perangkat.

Tersedia pada Android, iOS, dan Electron.

Batasan Default: true

capacitor.config.json

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

responseTimeout

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

tersedia di Android, iOS, dan Electron.

Default: 20 (20 detik)

capacitor.config.json

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

shakeMenu

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

tersedia di Android, iOS, dan Electron.

Default: false

capacitor.config.json

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

statsUrl

Konfigurasi URL / endpoint untuk mengirimkan statistik pembaruan.

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

Menghapus statsUrl Tidak menghapus penyimpanan perangkat Capgo secara keseluruhan. updateUrl tetap diaktifkan, /updates masih menyimpan baris tagihan MAU, inventori perangkat, dan data keputusan pembaruan yang diperlukan untuk menyajikan pembaruan dan menghitung MAU. Lihat Compliance untuk penjelasan detail bidang.

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

capacitor.config.json

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

updateUrl

Konfigurasi URL / endpoint untuk memeriksa pembaruan.

tersedia pada Android, iOS, dan Electron.

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

capacitor.config.json

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

version

Configure the current version of the app. This will be used for the first update request. If not set, the plugin will get the version from the native code.

tersedia 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 lokal api untuk tes.

Default: undefined

capacitor.config.json

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

localHost

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

Default: undefined

capacitor.config.json

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

localSupa

Konfigurasi CLI untuk menggunakan server lokal untuk tes 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 pengujian atau server pembaruan self-hosted.

Default: undefined

capacitor.config.json

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

Trik

Terdapat pengaturan tambahan yang tersedia di Aplikasi web Capgo yang dapat dikonfigurasi per saluran tanpa memerlukan rilis aplikasi asli.

Teruskan dari Pengaturan

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