Pengaturan

Untuk memiliki kontrol yang lebih halus atas sistem pembaruan, Anda dapat mengonfigurasi sistem tersebut 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

Penting untuk 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.

Untuk menggunakan hostname sendiri untuk updateUrl, statsUrl, dan channelUrl, lihat Pengaturan Domain Kustom.

allowModifyUrl

Biarkan plugin memodifikasi 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

Tetapkan jumlah milisecond plugin native menunggu sebelum 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 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 setelah update berhasil.

Tersedia di Android, iOS, dan Electron.

Default: true

capacitor.config.json

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

autoSplashscreen

Diperlukan ketika menggunakan mode aplikasi instan (“"atInstall", "onLaunch"”, atau “ "always"”), termasuk yang sudah tidak digunakan lagi “ directUpdate Nilai-nilai. Instal. @capacitor/splash-screen dan atur launchAutoHide: false. Ketika diaktifkan, plugin ini menyembunyikan layar splashscreen setelah update diterapkan atau ketika tidak ada update yang diperlukan. Hal ini menghilangkan kebutuhan untuk mendengarkan event appReady secara manual dan memanggil 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 menyesuaikan interval timer tersebut. 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 falseMengaktifkan pembaruan otomatis
• "atBackground" atau truePeriksa dan download secara otomatis setiap kali periksa latar depan, kemudian terapkan pembaruan berikutnya ketika aplikasi berpindah ke latar belakang
• "atInstall"Terapkan segera hanya setelah instalasi baru atau pembaruan aplikasi native; lainnya gunakan "atBackground" behavior
• "onLaunch"Mengaktifkan pembaruan otomatis hanya setelah instalasi segar atau pembaruan aplikasi toko native; jika tidak, gunakan "atBackground" behavior
• "always"Periksa setiap transisi latar depan dan terapkan segera ketika update tersedia
• "onlyDownload"Periksa dan download secara otomatis, lanjutkan updateAvailableMengaktifkan pembaruan otomatis dan mengunduh secara otomatis, mengeluarkan

Mode aplikasi instan (""atInstall", "onLaunch", "always"Terapkan saat pengguna menunggu. Unggah dengan npx @capgo/cli@latest bundle upload --delta Hanya file yang berubah download. Mengunggah 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.

Bawaan: "atBackground" (true masih diterima)

capacitor.config.json

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

channelUrl

Konfigurasi URL / endpoint untuk operasi channel.

Tersedia 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 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.

Bawaan: undefined

capacitor.config.json

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

directUpdate

Sudah tidak digunakan. Gunakan autoUpdate mode string sebaliknya: "atInstall", "onLaunch", atau "always"Untuk aplikasi yang sudah ada, fitur ini masih didukung. Instant apply harus diunggah bersama --delta sehingga update tidak memperlambat pengalaman pengguna. Mode ini memerlukan autoSplashscreen: true dan @capacitor/splash-screen dengan launchAutoHide: false.

Opsi:

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

tersedia pada Android, iOS, dan Electron.

Default: false

capacitor.config.json

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

disableJSLogging

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

Tersedia pada Android, iOS, dan Electron.

Default: false

capacitor.config.json

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

keepUrlPathAfterReload

Konfigurasi plugin untuk menjaga URL path setelah reload.

Peringatan

Ketika reload dipicu, ‘window.history’ akan dibersihkan.

Tersedia pada Android, iOS, dan Electron.

Bawaan: false

capacitor.config.json

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

periodCheckDelay

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

Tersedia pada Android, iOS, dan Electron.

Bawaan: 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.

Baku: undefined

capacitor.config.json

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

Peringatan

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

resetWhenUpdate

Menghapus otomatis bundle yang telah diunduh sebelumnya ketika bundle 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 milisecond plugin native harus menunggu sebelum menganggap API timeout.

Tersedia pada 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 pada Android, iOS, dan Electron.

Bawaan: false

capacitor.config.json

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

statsUrl

Konfigurasi URL/endpoint ke mana statistik pembaruan dikirim.

Tersedia pada Android, iOS, dan Electron. Atur ke "" untuk menghentikan pelaporan statistik eksplisit melalui /stats.

Menghentikan statsUrl Tidak menghapus semua penyimpanan perangkat Capgo. Jika updateUrl tetap aktif, /updates masih menyimpan baris tagihan MAU, inventori perangkat, dan data keputusan pembaruan yang diperlukan untuk menyajikan pembaruan dan menghitung MAU. Lihat Pengaturan 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 ke mana periksa pembaruan dikirimkan.

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

Konfigurasi versi aplikasi saat ini. Ini akan digunakan untuk permintaan pembaruan pertama. Jika tidak diatur, plugin akan mendapatkan versi dari 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 tes atau server pembaruan self-hosted.

Default: undefined

capacitor.config.json

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

Trik

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

Bab yang berjudul “Teruskan dari Pengaturan”

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