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.

Pertimbangan

Memerlukan kewarganegaraan data Eropa untuk Capgo Cloud? Atur updateUrl ke https://plugin.eu.capgo.app/updates, statsUrl ke https://plugin.eu.capgo.app/statske channelUrl . Lihat https://plugin.eu.capgo.app/channel_selfLokasi Data Bagian berjudul “allowModifyUrl”.

allowModifyUrl

Tersedia pada Android, iOS, dan Electron.

Baku:

__CAPGO_KEEP_0__.config.json false

capacitor.config.json

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

appId

Konfigurasi ID aplikasi untuk aplikasi di konfigurasi.

Tersedia pada Android, iOS, dan Electron.

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

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

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

Bawaan: true

capacitor.config.json

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

autoSplashscreen

Diperlukan ketika menggunakan mode aplikasi instan (“ atau “), termasuk yang sudah tidak digunakan lagi “. Pasang "atInstall", "onLaunch"dan atur "always" Ketika diaktifkan, plugin ini 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(). directUpdate Tersedia pada Android dan iOS. @capacitor/splash-screen Default: launchAutoHide: false__CAPGO_KEEP_0__.config.json

Copy to clipboard

Section titled “autoSplashscreen” false

capacitor.config.json

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

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 menyesuaikan interval timer tersebut. Nilai boolean masih didukung untuk konsistensi ke belakang: true adalah sama dengan "atBackground" dan false context: Halaman/area: Situs web pemasaran Capgo. Peran: Label UI pendek atau item navigasi. Dilihat di: halaman trust.astro. Kunci pesan `dan` (Dan). "off"adalah sama dengan

. Nilai string menggabungkan konfigurasi Auto Update dan Pembaruan Langsung sebelumnya.

• "off" Pilihan: falseatau
• "atBackground" context: Fragment teks HTML dari kalimat Capgo UI yang lebih panjang (kunci induk `alternatives_cta_questions`). Halaman/area: Halaman perbandingan alternatif pembaruan hidup Capacitor. Peran: Paragraf pemasaran atau hukum yang panjang. Dilihat di: halaman alternatives.astro. Simpan istilah produk/merek dan pengembang Capgo secara tepat. Kunci pesan `alternatives_cta_questions` (Pertanyaan Tindakan Alternatif). | Fragment teks HTML dari kalimat Capgo UI yang lebih panjang (kunci induk `appflow_cta_questions`). Halaman/area: Halaman perbandingan/migrasi pemasaran Appflow. Peran: Paragraf pemasaran atau hukum yang panjang. Dilihat di: halaman ionic-appflow.astro. Simpan istilah produk/merek dan pengembang Capgo secara tepat. Kunci pesan `appflow_cta_questions` (Pertanyaan Tindakan Appflow). | Fragment teks HTML dari kalimat Capgo UI yang lebih panjang (kunci induk `capwesome_cta_questions`). Halaman/area: Halaman perbandingan Capawesome. Peran: Paragraf pemasaran atau hukum yang panjang. Dilihat di: halaman capwesome.astro. Simpan istilah produk/merek dan pengembang Capgo secara tepat. Kunci pesan `capwesome_cta_questions` (Pertanyaan Tindakan Capwesome). | Fragment teks HTML dari kalimat Capgo UI yang lebih panjang (kunci induk `consulting_faq_subtitle`). Halaman/area: Halaman layanan konsultasi. Peran: Judul atau tagline bagian. Dilihat di: halaman consulting.astro. Simpan istilah produk/merek dan pengembang Capgo secara tepat. Kunci pesan `consulting_faq_subtitle` (Judul Subsitus FAQ Konsultasi). | Halaman/area: Halaman perbandingan/migrasi pemasaran Appflow. Peran: Label UI pendek atau item navigasi. Dilihat di: halaman ionic-appflow.astro, halaman ionic-enterprise-plugins.astro, halaman solusi/ionic-enterprise-plugins.astro. Kunci pesan `appflow_plugins_or` (Appflow Plugins 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; selain itu gunakan "atBackground" behavior
• "onLaunch": Aplikasikan segera hanya ketika aplikasi dibawa ke latar depan dari keadaan mati (start dingin). Setelah periksa pertama, kembali ke "atBackground" behavior
• "always": Periksa pada setiap transisi latar depan dan aplikasikan segera ketika update tersedia
• "onlyDownload": Periksa secara otomatis dan download, emit updateAvailable, dan tidak pernah atur bundle berikutnya atau aplikasikan update secara otomatis

Instant apply modes ("atInstall", "onLaunch", "always") berlaku selama pengguna menunggu. Unggah dengan npx @capgo/cli@latest bundle upload --delta sehingga hanya file yang berubah download. Unggah zip penuh memperlambat pengalaman pengguna. Pada Android dan iOS, mode ini memerlukan autoSplashscreen: true dan (And) @capacitor/splash-screen Dengan launchAutoHide: false.

Tersedia di Android, iOS, dan Electron.

Default: "atBackground" (true masih diterima)

capacitor.config.json

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

channelUrl

Konfigurasi URL / endpoint untuk operasi kanal.

Tersedia di Android, iOS, dan Electron.

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

capacitor.config.json

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

defaultChannel

Setel saluran bawaan untuk aplikasi di konfigurasi. Case sensitive. Pengaturan ini akan menggantikan saluran bawaan yang ditetapkan di awan, tetapi akan tetap menghormati pengaturan pengganti yang dibuat 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"Option ini masih didukung untuk aplikasi yang sudah ada. Instant apply harus diunggah bersama --delta agar pengalaman pengguna tidak lambat. Mode-mode ini memerlukan autoSplashscreen: true dan @capacitor/splash-screen dengan launchAutoHide: false.

Pilihan:

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

Tersedia pada Android, iOS, dan Electron.

Default: false

capacitor.config.json

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

disableJSLogging

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

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

tersedia pada Android, iOS, dan Electron.

Default: false

capacitor.config.json

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

periodCheckDelay

Konfigurasi periode menunggu 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"
    }
  }
}

Peringatan

publicKey mengatur Enkripsi V2 dan harus sesuai dengan kunci pribadi yang digunakan selama unggahan. Untuk Delta update, gunakan enkripsi V2 dengan enkripsi parsial diaktifkan, dan aktifkan kebijakan bundle terenkripsi jika organisasi Anda memerlukan setiap unggahan untuk dienkripsi. Jangan bergantung pada publicKey sebagai kebijakan sisi server untuk mencegah update 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 pembaruan dikirim.

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

Menghentikan statsUrl tidak menghentikan penyimpanan perangkat Capgo secara keseluruhan. Jika updateUrl tetap diaktifkan, /updates masih menyimpan baris pembayaran MAU, inventori perangkat, dan data kejadian pemutakhiran yang diperlukan untuk menyajikan pembaruan dan menghitung MAU. Lihat Pengaturan Komplian 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. Versi ini akan digunakan untuk permintaan update 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 aplikasi web Aplikasi web Capgo yang dapat dikonfigurasi per saluran tanpa memerlukan rilis aplikasi native.

Teruskan dari Pengaturan

Jika Anda menggunakan Pengaturan untuk merencanakan dashboard dan API operasi, hubungkan 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.