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

Memerlukan residensi data 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 Lokasi Data.

allowModifyUrl

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

tersedia pada Android, iOS, dan Electron.

Baku: 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 memandang sebuah 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

Menangani secara otomatis penghilangan layar splash ketika menggunakan mode aplikasi instan. Ketika diaktifkan, plugin akan menghilangkan layar splash 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 diatur ke "atInstall", "onLaunch", atau "always". Nilai legacy directUpdate masih didukung untuk kompatibilitas mundur. Memerlukan plugin @capacitor/splash-screen untuk diinstal dan dikonfigurasi dengan launchAutoHide: false. Memerlukan Auto Update untuk diaktifkan. Tersedia pada Android, iOS, dan Electron. Default:

__CAPGO_KEEP_0__.config.json

Salin ke clipboard false

capacitor.config.json

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

autoUpdate

Copy to clipboard periodCheckDelay Section titled “autoUpdate” true adalah sama seperti "atBackground" dan false adalah sama seperti "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 native toko; lainnya gunakan "atBackground" pengaturan
• "onLaunch"atau : Aplikasikan segera hanya ketika aplikasi dibawa ke depan dari keadaan mati (start dingin). Setelah periksa pertama, kembali ke "atBackground" Indonesia
• "always": Periksa setiap transisi latar depan dan terapkan segera ketika update tersedia
• "onlyDownload": Periksa dan download secara otomatis, emit updateAvailable, dan tidak pernah atur bundle berikutnya atau terapkan update secara otomatis

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.

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 string modes "atInstall", "onLaunch"Atau "always"untuk aplikasi yang sudah ada.

Opsi:

• false: Tidak pernah melakukan update langsung
• 'atInstall': Sama seperti autoUpdate: "atInstall"
• 'onLaunch': Sama seperti autoUpdate: "onLaunch"
• 'always': Sama seperti autoUpdate: "always"
• true: (tersisa untuk konsistensi) Sama seperti "always" untuk konsistensi ke belakang

tersedia pada Android, iOS, dan Electron.

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

Default: false

capacitor.config.json

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

keepUrlPathAfterReload

Konfigurasi plugin untuk menjaga URL path setelah reload.

Peringatan

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

Available on Android, iOS, dan Electron.

Default: false

capacitor.config.json

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

periodCheckDelay

Konfigurasi periode tunggu untuk periksa pembaruan. Satuan dalam detik. Tidak boleh kurang dari 600 detik (10 menit).

Available on 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"
    }
  }
}

Peringatan

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

resetWhenUpdate

Menghapus otomatis bundle yang 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 goncang untuk menampilkan menu pembaruan untuk keperluan debugging/testing.

Tersedia pada Android, iOS, dan Electron.

Default: false

capacitor.config.json

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

statsUrl

Konfigurasi URL / endpoint ke mana data statistik diperbarui dikirim.

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

Menghentikan statsUrl tidak menghentikan penyimpanan Capgo perangkat 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 Komitmen untuk analisis level field.

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

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

Konfigurasi capacitor.json

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

localSupaAnon

Konfigurasi CLI untuk menggunakan server lokal untuk tes.

Default: undefined

capacitor.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.json

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

Tips

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

Lanjutkan dari Pengaturan

Jika Anda menggunakan Pengaturan untuk merencanakan dashboard dan API operasi, hubungkannya dengan Menggunakan @capgo/capacitor-updater untuk kemampuan native di Menggunakan @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.