Pengaturan

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

Tips

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

Catatan

Membutuhkan residensi 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

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

Konfigurasi jumlah milisecond plugin native harus menunggu sebelum mempertimbangkan 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 otomatis 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 berhasil.

Tersedia pada Android, iOS, dan Electron.

Default: true

capacitor.config.json

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

autoSplashscreen

Menghandle otomatis menyembunyikan layar splashscreen ketika menggunakan mode instant apply. Ketika diaktifkan, plugin akan secara otomatis 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(). Hanya berfungsi ketika autoUpdate diatur 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 cara plugin memeriksa, mengunduh, dan menerapkan pembaruan hidup. Plugin memeriksa pembaruan ketika aplikasi berpindah ke latar depan dan pada timer yang berulang sementara aplikasi tetap terbuka. periodCheckDelay Kontrol interval timer tersebut. Nilai boolean masih didukung untuk konsistensi ke belakang: true sama dengan "atBackground" atau false sama dengan "off". Nilai string menggabungkan konfigurasi Auto Update dan Pembaruan Langsung sebelumnya.

Pilihan:

• "off" atau falseMengaktifkan pembaruan otomatis
• "atBackground" atau trueMintakan pembaruan secara otomatis setiap kali aplikasi berada di latar depan, lalu aplikasikan pembaruan berikutnya ketika aplikasi berada di latar belakang
• "atInstall"Menggunakan "atBackground" tingkah laku
• "onLaunch"Menggunakan "atBackground" tingkah laku
• "always"Menggunakan
• "onlyDownload"tingkah laku updateAvailableMenggunakan

tingkah laku

Menggunakan pembaruan secara otomatis setiap kali aplikasi berada di latar depan dan mengaplikasikannya segera ketika pembaruan tersedia "atBackground" (true masih diterima)

capacitor.config.json

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

channelUrl

Konfigurasi URL / endpoint untuk operasi kanal.

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

Tentukan saluran default untuk aplikasi di konfigurasi. Case sensitive. Pengaturan ini akan menggantikan saluran default yang ditetapkan di awan, tetapi akan tetap menghormati penggantian yang dibuat di awan.

Tersedia pada Android, iOS, dan Electron.

Default: undefined

capacitor.config.json

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

directUpdate

Dihapus. Gunakan autoUpdate mode string saja: "atInstall", "onLaunch", atau "always". Opsi ini tetap didukung 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 untuk kompatibilitas mundur) Sama seperti "always" untuk kompatibilitas mundur

Tersedia pada Android, iOS, dan Electron.

Bawaan: false

capacitor.config.json

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

disableJSLogging

Matikan log JavaScript plugin. Jika true, plugin tidak akan log 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 dipicu, ‘window.history’ akan dihapus.

Tersedia pada Android, iOS, dan Electron.

Default: false

capacitor.config.json

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

periodCheckDelay

Konfigurasi jeda waktu 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 pembaruan hidup ke akhir ke 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 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 tujuan debugging/pengujian.

Tersedia pada Android, iOS, dan Electron.

Default: 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 menghentikan penyimpanan perangkat Capgo secara keseluruhan. Jika updateUrl tetap diaktifkan, /updates masih menyimpan baris tagihan MAU, inventori perangkat, dan data keputusan pembaruan yang diperlukan untuk menyajikan pembaruan dan menghitung MAU. Lihat Ketentuan 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 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 pembaruan pertama. Jika tidak diset, 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 yang tersedia di Capgo web app yang dapat diatur per saluran tanpa memerlukan rilis aplikasi native.

Lanjutkan dari Pengaturan

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