Pengaturan

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

Tip

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

Catatan

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

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 memandang 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 sukses.

Tersedia pada Android, iOS, dan Electron.

Default: true

capacitor.config.json

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

autoSplashscreen

Tangani secara otomatis menyembunyikan layar splash ketika menggunakan mode aplikasi instan. Ketika diaktifkan, plugin akan menyembunyikan layar splash 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 bagaimana plugin harus menggunakan Auto Update melalui server pembaruan. Nilai boolean masih didukung untuk konsistensi ke belakang: true sama dengan "atBackground" atau false sama dengan "off".

Pilihan:

• "off" atau false: Matikan Auto Update
• "atBackground" atau true: Periksa dan download secara otomatis, kemudian terapkan ketika aplikasi berpindah ke latar belakang
• "atInstall": Terapkan segera hanya setelah instalasi segar atau pembaruan aplikasi asli, lainnya gunakan "atBackground"
• "onLaunch": Terapkan segera pada saat startup, lainnya gunakan "atBackground" setelah peluncuran cek
• "always": Terapkan segera setiap Auto Update berjalan
• "onlyDownload" : Periksa dan download secara otomatis, emit updateAvailable , dan tidak pernah atur bundle berikutnya 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 di Android, iOS, dan Electron.

Default: undefined

capacitor.config.json

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

directUpdate

Dihapus. Gunakan mode string "string modes" autoUpdate Gunakan "string modes" "atInstall", "onLaunch"atau "always"Opsi ini masih didukung untuk aplikasi yang sudah ada.

Opsi:

• false: Tidak pernah melakukan pembaruan langsung
• 'atInstall': Sama seperti autoUpdate: "atInstall"
• 'onLaunch': Sama seperti autoUpdate: "onLaunch"
• 'always': Sama seperti autoUpdate: "always"
• true: (dihapus) Sama seperti “selalu” 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 true, 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.

Tersedia pada Android, iOS, dan Electron.

Default: false

capacitor.config.json

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

periodCheckDelay

Konfigurasi periode tunggu untuk periksa pembaruan periode. Satuan 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 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 yang diperlukan oleh plugin native untuk 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 goncangan untuk menampilkan menu pembaruan untuk tujuan debugging/testing.

Tersedia pada Android, iOS, dan Electron.

Default: false

capacitor.config.json

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

statsUrl

Konfigurasi URL / endpoint ke mana statistik pembaruan dikirimkan.

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

Menghapus statsUrl tidak menonaktifkan 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 Kepatuhan 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 yang digunakan untuk memeriksa pembaruan.

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 pengujian 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 __CAPGO_KEEP_0__ Capgo web app __CAPGO_KEEP_0__

Teruskan 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, API Ringkasan untuk detail implementasi dalam API Ringkasan, Pendahuluan untuk detail implementasi dalam Pendahuluan, API Kunci untuk detail implementasi di API Keys, dan Perangkat untuk detail implementasi di Perangkat.