Pengaturan

Untuk kontrol yang lebih detail atas sistem update, Anda bisa mengonfigurasinya lewat pengaturan berikut:

Tips

Setiap perubahan pada pengaturan ini di file capacitor.config memerlukan sinkronisasi platform dan rilis ke store agar aplikasi produksi dapat menerimanya.

Catatan

Butuh data residency EU 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.

Untuk menggunakan hostname Anda sendiri untuk updateUrl, statsUrl, dan channelUrl, lihat Pengaturan Custom Domain.

allowModifyUrl

Izinkan plugin untuk memodifikasi updateUrl, statsUrl, dan channelUrl secara dinamis dari sisi JavaScript.

Tersedia di Android, iOS, dan Electron.

Default: false

capacitor.config.json

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

appId

Konfigurasi app id untuk aplikasi di config.

Tersedia di Android, iOS, dan Electron.

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appId": "com.example.app"
    }
  }
}

appReadyTimeout

Konfigurasi jumlah milidetik yang harus ditunggu plugin native sebelum menganggap update 'gagal'.

Tersedia di Android, iOS, dan Electron.

Default: 10000 (10 detik)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000
    }
  }
}

autoDeleteFailed

Atur apakah plugin otomatis menghapus bundle yang gagal.

Tersedia di Android, iOS, dan Electron.

Default: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeleteFailed": false
    }
  }
}

autoDeletePrevious

Atur apakah plugin otomatis menghapus bundle sebelumnya setelah update berhasil.

Tersedia di Android, iOS, dan Electron.

Default: true

capacitor.config.json

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

autoSplashscreen

Wajib saat menggunakan mode instant apply ("atInstall", "onLaunch", atau "always"), termasuk nilai yang sudah deprecated directUpdate values. Install @capacitor/splash-screen dan atur launchAutoHide: false. Jika diaktifkan, plugin menyembunyikan splashscreen setelah update diterapkan atau saat tidak ada update yang diperlukan. Dengan ini, tidak perlu lagi mendengarkan event appReady secara manual dan memanggil SplashScreen.hide().

Tersedia di Android dan iOS.

Default: false

capacitor.config.json

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

autoUpdate

Konfigurasi cara plugin memeriksa, mengunduh, dan menerapkan live update. Plugin memeriksa pembaruan saat aplikasi berpindah ke foreground dan pada timer berulang selama aplikasi tetap terbuka. periodCheckDelay mengontrol interval timer tersebut. Nilai Boolean masih didukung untuk kompatibilitas mundur: true sama dengan "atBackground" dan false sama dengan "off". Nilai String menggabungkan konfigurasi Auto Update dan Direct Update sebelumnya.

Opsi:

• "off" atau false: Nonaktifkan pemeriksaan pembaruan otomatis
• "atBackground" atau true: Periksa dan unduh secara otomatis pada setiap pemeriksaan foreground, lalu terapkan update saat aplikasi berikutnya berpindah ke background
• "atInstall": Terapkan segera hanya setelah instalasi baru atau pembaruan native app store; selain itu gunakan "atBackground" behavior
• "onLaunch": Terapkan segera hanya ketika aplikasi dibawa ke foreground dari keadaan killed (cold start). Setelah pemeriksaan pertama, kembali ke "atBackground" behavior
• "always": Periksa pada setiap transisi foreground dan terapkan segera setiap kali update tersedia
• "onlyDownload": Periksa dan unduh secara otomatis, emit updateAvailable, dan jangan pernah set bundle berikutnya atau terapkan update secara otomatis

Mode penerapan instan ("atInstall", "onLaunch", "always") terapkan saat pengguna menunggu. Upload dengan npx @capgo/cli@latest bundle upload --delta sehingga hanya file yang berubah yang diunduh. Upload zip penuh memperlambat pengalaman pengguna. Di Android dan iOS, mode ini memerlukan autoSplashscreen: true dan @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 channel.

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

Atur channel default untuk aplikasi di config. Case sensitive. Pengaturan ini akan menimpa channel default yang diatur di cloud, tetapi override yang dibuat di cloud tetap berlaku.

Tersedia di Android, iOS, dan Electron.

Default: undefined

capacitor.config.json

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

directUpdate

Deprecated. Gunakan autoUpdate string modes sebagai gantinya: "atInstall", "onLaunch", atau "always". Opsi ini tetap didukung untuk aplikasi yang sudah ada. Instant apply harus di-upload dengan --delta agar update tidak memperlambat pengalaman pengguna. Mode-mode ini membutuhkan autoSplashscreen: true dan @capacitor/splash-screen dengan launchAutoHide: false.

Opsi:

• false: Jangan pernah lakukan update langsung
• 'atInstall': Sama dengan autoUpdate: "atInstall"
• 'onLaunch': Sama dengan autoUpdate: "onLaunch"
• 'always': Sama dengan autoUpdate: "always"
• true: (tidak didukung lagi) Sama dengan "always" untuk kompatibilitas mundur

Tersedia di Android, iOS, dan Electron.

Default: false

capacitor.config.json

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

disableJSLogging

Nonaktifkan logging JavaScript dari plugin. Jika true, plugin tidak akan mencatat ke konsol JavaScript. Hanya log native yang akan dilakukan.

Tersedia di Android, iOS, dan Electron.

Default: false

capacitor.config.json

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

keepUrlPathAfterReload

Konfigurasi plugin untuk mempertahankan path URL setelah reload.

Peringatan

Saat reload dipicu, 'window.history' akan dihapus.

Tersedia di Android, iOS, dan Electron.

Default: false

capacitor.config.json

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

periodCheckDelay

Konfigurasi jeda waktu untuk pengecekan update berkala. Satuannya dalam detik. Tidak boleh kurang dari 600 detik (10 menit).

Tersedia di Android, iOS, dan Electron.

Default: 600 (10 menit)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "periodCheckDelay": 600 // (10 minutes)
    }
  }
}

publicKey

Konfigurasi public key untuk enkripsi end-to-end live update Versi 2.

Tersedia di Android, iOS, dan Electron.

Default: undefined

capacitor.config.json

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

Peringatan

publicKey mengonfigurasi Encryption V2 dan harus cocok dengan private key yang digunakan saat upload. Untuk Delta updates, gunakan enkripsi V2 dengan partial encryption diaktifkan, dan aktifkan encrypted-bundle enforcement jika organisasi Anda mewajibkan setiap upload terenkripsi. Jangan mengandalkan publicKey saja sebagai kebijakan server-side untuk mencegah Delta tanpa enkripsi dipublikasikan.

resetWhenUpdate

Otomatis hapus bundle yang diunduh sebelumnya saat native app bundle yang lebih baru diinstal ke perangkat.

Tersedia di Android, iOS, dan Electron.

Default: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "resetWhenUpdate": false
    }
  }
}

responseTimeout

Atur berapa milidetik plugin native harus menunggu sebelum menganggap API timeout.

Tersedia di Android, iOS, dan Electron.

Default: 20 (20 detik)

capacitor.config.json

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

shakeMenu

Aktifkan gestur goyang untuk menampilkan menu update untuk keperluan debugging/testing.

Tersedia di Android, iOS, dan Electron.

Default: false

capacitor.config.json

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

statsUrl

Konfigurasikan URL / endpoint tempat statistik update dikirim.

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

Menonaktifkan statsUrl tidak menonaktifkan seluruh penyimpanan perangkat Capgo. Jika updateUrl tetap aktif, /updates masih menyimpan baris billing MAU, inventaris perangkat, dan data event keputusan update yang diperlukan untuk menyajikan update dan menghitung MAU. Lihat Kepatuhan untuk rincian per field.

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

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "statsUrl": "https://example.com/api/stats"
    }
  }
}

updateUrl

Atur URL / endpoint tempat pengecekan update dikirim.

Tersedia di Android, iOS, dan Electron.

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

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "updateUrl": "https://example.com/api/auto_update"
    }
  }
}

version

Atur versi aplikasi saat ini. Ini akan dipakai untuk request update pertama. Jika tidak diatur, plugin akan mengambil versi dari native code.

Tersedia di Android, iOS, dan Electron.

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "version": "1.0.0"
    }
  }
}

Pengaturan Development

localApi

Konfigurasi CLI untuk menggunakan api lokal untuk keperluan testing.

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApi": "http://localhost:54321/functions/v1"
    }
  }
}

localApiFiles

Konfigurasi CLI untuk menggunakan file api lokal untuk keperluan testing.

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApiFiles": "http://localhost:54321/functions/v1/files"
    }
  }
}

localHost

Konfigurasikan CLI untuk memakai server lokal saat testing atau server update self-hosted.

Default: undefined

capacitor.config.json

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

localSupa

Konfigurasikan CLI untuk memakai server lokal saat testing atau server update self-hosted.

Default: undefined

capacitor.config.json

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

localSupaAnon

Konfigurasikan CLI agar memakai server lokal untuk testing.

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupaAnon": "YOUR_LOCAL_ANON_KEY"
    }
  }
}

localWebHost

Konfigurasikan CLI untuk memakai server lokal saat testing atau server update self-hosted.

Default: undefined

capacitor.config.json

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

Tips

Ada pengaturan tambahan yang tersedia di web app Capgo yang bisa diatur per channel tanpa perlu rilis aplikasi native.

Lanjutkan dari Pengaturan

Jika Anda menggunakan Pengaturan untuk merencanakan operasi dashboard dan API, hubungkan dengan Menggunakan @capgo/capacitor-updater untuk fitur native di bagian Menggunakan @capgo/capacitor-updater, Ringkasan API untuk detail implementasi di API Overview, Pendahuluan untuk detail implementasi di Introduction, Kunci API untuk detail implementasi di API Keys, dan Perangkat untuk detail implementasi di Devices.