Pengaturan

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

Tip

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

Catatan

Membutuhkan kewarganegaraan data 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

Izinkan plugin untuk 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

Konfigurasi jumlah milisecond plugin native harus menunggu sebelum menganggap pembaruan ‘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.

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.

Default: true

capacitor.config.json

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

autoSplashscreen

Automatis menghandle penghilangan layar splashscreen ketika menggunakan mode aplikasi instan. Ketika diaktifkan, plugin akan secara otomatis menghilangkan 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(). Hanya berfungsi ketika autoUpdate dipasang ke "atInstall", "onLaunch", atau "always". Nilai lama directUpdate masih didukung untuk konsistensi ke belakang. Memerlukan plugin @capacitor/splash-screen untuk diinstal dan dikonfigurasi dengan launchAutoHide: false. Memerlukan Auto Update untuk diaktifkan.

Tersedia pada Android, iOS, dan Electron.

Default: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall",
      "autoSplashscreen": true
    }
  }
}

autoUpdate

Konfigurasi plugin untuk memeriksa, mengunduh, dan menerapkan pembaruan live. Plugin memeriksa pembaruan ketika aplikasi berpindah ke latar depan dan pada timer yang berulang sambil aplikasi tetap terbuka. periodCheckDelay pengaturan interval timer. Nilai Boolean masih didukung untuk konsistensi ke belakang: true adalah sama dengan "atBackground" atau false adalah sama dengan "off". Nilai string menggabungkan konfigurasi Auto Update dan Direct Update sebelumnya.

Pilihan:

• "off" atau false: Matikan 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 asli; lainnya gunakan "atBackground" pengaturan
• "onLaunch": Aplikasikan segera hanya ketika aplikasi dibawa ke depan dari keadaan mati (cold start). Setelah itu, cek pertama kali, kembali ke "atBackground" behavior
• "always": Cek pada setiap transisi ke depan dan aplikasikan segera ketika ada update yang tersedia
• "onlyDownload": Cek dan download secara otomatis, emit updateAvailable, dan tidak pernah atur bundle berikutnya atau aplikasikan update secara otomatis

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

Atur 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

Dihapus. Gunakan autoUpdate mode string bukan: "atInstall", "onLaunch", atau "always". Opsi ini tetap mendukung untuk aplikasi yang sudah ada.

Pilihan:

• false: Tidak pernah melakukan update 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 log 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 diaktifkan, ‘window.history’ akan dibersihkan.

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 update hidup akhir ke akhir Versi 2.

Tersedia pada Android, iOS, dan Electron.

Default: undefined

capacitor.config.json

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

resetWhenUpdate

Menghapus bundle yang telah diunduh sebelumnya secara otomatis 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 sebagai waktu tunggu.

Tersedia pada Android, iOS, dan Electron.

Bawaan: 20 (20 detik)

capacitor.config.json

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

shakeMenu

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

Tersedia pada Android, iOS, dan Electron.

Bawaan: false

capacitor.config.json

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

statsUrl

Konfigurasi URL / endpoint ke mana data statistik diperbarui dikirimkan.

Tersedia di Android, iOS, dan Electron. Atur ke "" untuk menonaktifkan pelaporan statistik eksplisit. /stats.

Menonaktifkan statsUrl tidak menonaktifkan penyimpanan perangkat Capgo secara keseluruhan. Jika updateUrl tetap diaktifkan, /updates masih menyimpan baris pembayaran MAU, inventori perangkat, dan data keputusan pembaruan yang diperlukan untuk menyajikan pembaruan dan menghitung MAU. Lihat Kemampuan Kompatibilitas 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 ke mana periksa update 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 update 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"
    }
  }
}

Tips

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

Lanjutkan dari Pengaturan

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