Fungsi dan Pengaturan

Konfigurasi Plugin Pembarui

Lihat Github Readme untuk informasi lebih lanjut.

CapacitorUpdater dapat dikonfigurasi dengan pilihan-pilihan berikut:

Prop	Type	Deskripsi	Default	Sejak
appReadyTimeout	number	Konfigurasi jumlah milisecond plugin native harus menunggu sebelum menganggap pembaruan ‘gagal’. Tersedia pada Android, iOS, dan Electron.	10000 // (10 seconds)
responseTimeout	number	Konfigurasi jumlah milisecond plugin native harus menunggu sebelum menganggap API timeout. Tersedia pada Android, iOS, dan Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Konfigurasi apakah plugin harus menggunakan otomatis menghapus bundle yang gagal. Tersedia pada Android, iOS, dan Electron.	true
autoDeletePrevious	boolean	Konfigurasi apakah plugin harus menggunakan otomatis menghapus bundle sebelumnya setelah pembaruan sukses. Tersedia pada Android, iOS, dan Electron.	true
autoUpdate	boolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’	Konfigurasi bagaimana plugin harus menggunakan Auto Update melalui server pembaruan. true sama dengan “atBackground”; false sama dengan “off”. - off: Matikan Auto Update - atBackground: Periksa dan download secara otomatis, kemudian terapkan ketika aplikasi berpindah ke latar belakang - atInstall: Terapkan segera setelah instalasi baru atau pembaruan aplikasi native, kecuali menggunakan atBackground - onLaunch: Terapkan segera pada saat aplikasi dibuka, kecuali menggunakan atBackground setelah periksa - always: Terapkan segera setiap kali Auto Update berjalan - onlyDownload: Periksa dan download secara otomatis, emit updateAvailable, dan tidak pernah menetapkan bundle berikut secara otomatis. Tersedia pada Android, iOS, dan Electron.	”atBackground” // true is still accepted
resetWhenUpdate	boolean	Menghapus bundle yang telah diunduh sebelumnya secara otomatis ketika bundle aplikasi native yang lebih baru diinstal ke perangkat. Tersedia pada Android, iOS, dan Electron.	true
updateUrl	string	Konfigurasi URL / endpoint ke mana periksa update dikirim. Tersedia pada Android, iOS, dan Electron.	https://plugin.capgo.app/updates
channelUrl	string	Konfigurasi URL / endpoint untuk operasi channel. Tersedia pada Android, iOS, dan Electron.	https://plugin.capgo.app/channel_self
statsUrl	string	Konfigurasi URL / endpoint ke mana statistik update dikirim. Tersedia pada Android, iOS, dan Electron. Atur ke "" untuk menonaktifkan pelaporan statistik.	https://plugin.capgo.app/stats
publicKey	string	Konfigurasi kunci publik untuk enkripsi update hidup akhir ke akhir Versi 2. Tersedia pada Android, iOS, dan Electron.	undefined	6.2.0
version	string	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.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Dihapuskan. Gunakan mode string autoUpdate “atInstall”, “onLaunch”, atau “always” saja. Opsi ini tetap mendukung untuk aplikasi yang sudah ada. - false: Tidak pernah melakukan update langsung - atInstall: Sama seperti autoUpdate: “atInstall” - onLaunch: Sama seperti autoUpdate: “onLaunch” - always: Sama seperti autoUpdate: “always” - true: Sama seperti “always” untuk konsistensi ke belakang. Tersedia pada Android, iOS, dan Electron.	false	5.1.0
autoSplashscreen	boolean	Menangani secara otomatis penghilangan layar splashscreen ketika menggunakan mode aplikasi instan. Ketika diaktifkan, plugin akan menghilangkan layar splashscreen setelah pembaruan diterapkan atau ketika tidak ada pembaruan yang diperlukan. Ini menghilangkan kebutuhan untuk mendengarkan event appReady secara manual dan memanggil SplashScreen.hide(). Hanya berfungsi ketika autoUpdate diatur ke “atInstall”, “onLaunch”, atau “always”. Nilai directUpdate legacy 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 dan iOS.	false	7.6.0
periodCheckDelay	number	Konfigurasi periode menunggu untuk cek pembaruan periodik. Satuan waktu dalam detik. Tersedia pada Android, iOS, dan Electron. Tidak dapat kurang dari 600 detik (10 menit).	600 // (10 minutes)
localS3	boolean	Konfigurasi CLI untuk menggunakan server lokal untuk tes atau server pembaruan self-hosted.	undefined	4.17.48
localHost	string	Konfigurasi CLI untuk menggunakan server lokal untuk tes atau server pembaruan self-hosted.	undefined	4.17.48
localWebHost	string	Konfigurasi CLI untuk menggunakan server lokal untuk tes atau server pembaruan self-hosted.	undefined	4.17.48
localSupa	string	Konfigurasi CLI untuk menggunakan server lokal untuk tes atau server pembaruan self-hosted.	undefined	4.17.48
localSupaAnon	string	Konfigurasi CLI untuk menggunakan server lokal untuk tes.	undefined	4.17.48
localApi	string	Konfigurasi CLI untuk menggunakan server lokal api untuk tes.	undefined	6.3.3
localApiFiles	string	Konfigurasi CLI untuk menggunakan file lokal api untuk tes.	undefined	6.3.3
allowModifyUrl	boolean	Memungkinkan plugin untuk mengubah updateUrl, statsUrl, dan channelUrl secara dinamis dari sisi JavaScript.	false	5.4.0
defaultChannel	string	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.	undefined	5.5.0
appId	string	Konfigurasi ID aplikasi untuk aplikasi di konfigurasi.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Konfigurasi plugin untuk menyimpan jalur URL setelah reload. PERINGATAN: Ketika reload dilakukan, ‘window.history’ akan dihapus.	false	6.8.0
disableJSLogging	boolean	Matikan log JavaScript plugin. Jika true, plugin tidak akan menulis ke konsol JavaScript. Hanya log native yang akan dilakukan	false	7.3.0
shakeMenu	boolean	Aktifkan gerakan goncang untuk menampilkan menu pembaruan untuk keperluan debugging/testing	false	7.5.0

Contoh-Contoh

Di capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000 // (1 second),
      "responseTimeout": 10 // (10 second),
      "autoDeleteFailed": false,
      "autoDeletePrevious": false,
      "autoUpdate": "onlyDownload",
      "resetWhenUpdate": false,
      "updateUrl": https://example.com/api/auto_update,
      "channelUrl": https://example.com/api/channel,
      "statsUrl": https://example.com/api/stats,
      "publicKey": undefined,
      "version": undefined,
      "directUpdate": undefined,
      "autoSplashscreen": undefined,
      "periodCheckDelay": undefined,
      "localS3": undefined,
      "localHost": undefined,
      "localWebHost": undefined,
      "localSupa": undefined,
      "localSupaAnon": undefined,
      "localApi": undefined,
      "localApiFiles": undefined,
      "allowModifyUrl": undefined,
      "defaultChannel": undefined,
      "appId": undefined,
      "keepUrlPathAfterReload": undefined,
      "disableJSLogging": undefined,
      "shakeMenu": undefined
    }
  }
}

Di capacitor.config.ts:

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      appReadyTimeout: 1000 // (1 second),
      responseTimeout: 10 // (10 second),
      autoDeleteFailed: false,
      autoDeletePrevious: false,
      autoUpdate: 'onlyDownload',
      resetWhenUpdate: false,
      updateUrl: https://example.com/api/auto_update,
      channelUrl: https://example.com/api/channel,
      statsUrl: https://example.com/api/stats,
      publicKey: undefined,
      version: undefined,
      directUpdate: undefined,
      autoSplashscreen: undefined,
      periodCheckDelay: undefined,
      localS3: undefined,
      localHost: undefined,
      localWebHost: undefined,
      localSupa: undefined,
      localSupaAnon: undefined,
      localApi: undefined,
      localApiFiles: undefined,
      allowModifyUrl: undefined,
      defaultChannel: undefined,
      appId: undefined,
      keepUrlPathAfterReload: undefined,
      disableJSLogging: undefined,
      shakeMenu: undefined,
    },
  },
};

export default config;

• notifyAppReady()
• setUpdateUrl(...)
• setStatsUrl(...)
• setChannelUrl(...)
• download(...)
• next(...)
• set(...)
• delete(...)
• list(...)
• reset(...)
• current()
• reload()
• setMultiDelay(...)
• cancelDelay()
• getLatest(...)
• setChannel(...)
• unsetChannel(...)
• getChannel()
• listChannels()
• setCustomId(...)
• getBuiltinVersion()
• getDeviceId()
• getPluginVersion()
• isAutoUpdateEnabled()
• removeAllListeners()
• addListener('download', ...)
• addListener('noNeedUpdate', ...)
• addListener('updateAvailable', ...)
• addListener('downloadComplete', ...)
• addListener('majorAvailable', ...)
• addListener('updateFailed', ...)
• addListener('downloadFailed', ...)
• addListener('appReloaded', ...)
• addListener('appReady', ...)
• isAutoUpdateAvailable()
• getNextBundle()
• setShakeMenu(...)
• isShakeMenuEnabled()
• Antarmuka
• Pengali Alias

Metode

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Perluas Pemberitahuan Capacitor Pembaruan ke Pengguna bahwa Paket saat ini sedang berjalan (akan terjadi pengembalian ke versi sebelumnya jika metode ini tidak dipanggil pada setiap peluncuran aplikasi) Metode ini secara default harus dipanggil dalam 10 detik pertama setelah aplikasi diluncurkan, jika tidak maka akan terjadi pengembalian ke versi sebelumnya. Perubahan perilaku ini dapat dilakukan dengan menggunakan {@link appReadyTimeout}

Kembali: Promise<AppReadyResult>

---

setUpdateUrl(…)

setUpdateUrl(options: UpdateUrl) => Promise<void>

Atur URL pembaruan untuk aplikasi, URL ini akan digunakan untuk memeriksa pembaruan.

Parameter	Tipe	Deskripsi
options	UpdateUrl	Mengandung URL untuk memeriksa pembaruan.

Sejak: 5.4.0

---

setStatsUrl(…)

setStatsUrl(options: StatsUrl) => Promise<void>

Atur URL statistik untuk aplikasi, ini akan digunakan untuk mengirimkan statistik. Mengirimkan string kosong akan menghentikan pengumpulan statistik.

Parameter	Tipe	Deskripsi
options	StatsUrl	mengandung URL untuk digunakan untuk mengirimkan statistik.

Sejak: 5.4.0

---

setChannelUrl(…)

setChannelUrl(options: ChannelUrl) => Promise<void>

Atur URL channel untuk aplikasi, ini akan digunakan untuk mengatur channel.

Param	Tipe	Deskripsi
options	ChannelUrl	mengandung URL untuk digunakan untuk mengatur channel.

Sejak: 5.4.0

---

download(…)

download(options: DownloadOptions) => Promise<BundleInfo>

Unduh sebuah bundle baru dari URL yang disediakan, harus berupa file zip, dengan file di dalamnya atau dengan id unik di dalamnya dengan semua file Anda

Param	Tipe	Deskripsi
options	DownloadOptions	Opsi untuk mengunduh sebuah bundle zip baru. Kembali:next(…)

Bagian berjudul “next(…)” Promise<BundleInfo>

---

__CAPGO_KEEP_0__

next(options: BundleId) => Promise<BundleInfo>

Setel bundle berikutnya untuk digunakan ketika aplikasi di-reload.

Param	Tipe	Deskripsi
options	BundleId	Mengandung ID dari Bundle berikutnya untuk di-set pada aplikasi launch berikutnya. {@link BundleInfo.id}

Kembali: Promise<BundleInfo>

---

set(…)

set(options: BundleId) => Promise<void>

Setel bundle saat ini dan reload aplikasi secara langsung.

Parameter	Tipe	Deskripsi
options	BundleId	A {@link BundleId } objek yang berisi ID bundle baru untuk ditetapkan sebagai bundle saat ini.

---

delete(…)

delete(options: BundleId) => Promise<void>

Menghapus bundle yang ditentukan dari penyimpanan aplikasi native. Gunakan dengan {@link list} untuk mendapatkan ID Bundle yang disimpan.

Parameter	Tipe	Deskripsi
options	BundleId	Sebuah objek {@link BundleId} yang berisi ID dari sebuah bundle untuk dihapus (perlu diingat, ini adalah ID bundle, BUKAN nama versi)

---

list(…)

list(options?: ListOptions | undefined) => Promise<BundleListResult>

Dapatkan semua bundle yang diunduh secara lokal di aplikasi Anda

Param	Jenis	Deskripsi
options	ListOptions	The {@link Daftar Opsi} untuk menampilkan bundle

Mengembalikan: Promise<BundleListResult>

---

reset(…)

reset(options?: ResetOptions | undefined) => Promise<void>

Mengatur ulang aplikasi ke builtin bundle (yang dikirim ke Apple App Store / Google Play Store ) atau bundle yang berhasil dimuat terakhir.

Param	Tipe	Deskripsi
options	ResetOptions	Mengandung {@link} ResetOptions.toLastSuccessful}, true mengembalikan ke bundle bawaan dan false akan mengembalikan ke bundle yang berhasil dimuat terakhir.

---

current()

current() => Promise<CurrentBundleResult>

Mengembalikan bundle saat ini, jika tidak ada yang ditetapkan maka akan mengembalikan builtin. currentNative adalah bundle asli yang terinstal di perangkat

Kembali: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Muat ulang tampilan

---

setMultiDelay(…)

setMultiDelay(options: MultiDelayConditions) => Promise<void>

Mengatur array {@link DelayCondition,} yang berisi kondisi-kondisi yang akan digunakan Plugin untuk menunda pembaruan. Setelah semua kondisi terpenuhi, proses pembaruan akan dijalankan kembali seperti biasa, sehingga pembaruan akan diinstal setelah aplikasi dibackground atau dihentikan. Untuk kind, nilai harus berupa string tanggal iso8601. Untukkind, nilai harus berupa bilangan bulat dalam satuan milidetik. Untuk date kind, nilai harus berupa nomor versi. Untuk background kind, nilai tidak digunakan. Fungsi ini memiliki perilaku tidak konsisten, opsi kill akan mengaktifkan pembaruan setelah kill pertama dan tidak setelah background berikutnya seperti opsi lainnya. Ini akan diperbaiki dalam rilis mayor masa depan. nativeVersion Param kill __CAPGO_KEEP_0__

__CAPGO_KEEP_1__	Jenis	Deskripsi
options	MultiDelayConditions	Mengandung array kondisi {@link MultiDelayConditions} untuk menetapkan

Sejak: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Membatalkan {@link DelayCondition} untuk memproses pembaruan segera.

Sejak: 4.0.0

---

getLatest(…)

getLatest(options?: GetLatestOptions | undefined) => Promise<LatestVersion>

Dapatkan Paket Terbaru yang Tersedia dari URL Perbaruan

Param	Tipe
options	GetLatestOptions

Dikembalikan: Promise<LatestVersion>

Sejak: 4.0.0

---

setChannel(…

setChannel(options: SetChannelOptions) => Promise<ChannelRes>

Mengatur saluran lokal yang diatur oleh plugin untuk perangkat ini. Saluran harus memiliki allow_device_self_set dijalankan untuk ini dapat berfungsi.

setChannel() mengvalidasi saluran dengan backend, kemudian menyimpan saluran yang dipilih secara lokal di perangkat. Ini tidak membuat atau memperbarui pengaturan Device Override di backend, sehingga perangkat tidak akan muncul sebagai diatur di dashboard Capgo. Hanya pengaturan yang dibuat dari dashboard atau API publik yang ditampilkan di UI Pengaturan Device Override.

Catatan penting:

• Jangan gunakan metode ini untuk mengatur saluran pada boot. Gunakan defaultChannel dalam konfigurasi Capacitor Anda.
• Metode ini dimaksudkan untuk digunakan setelah aplikasi siap dan pengguna telah berinteraksi (misalnya, mendaftar ke program beta).
• Saluran publik tidak dapat ditetapkan sendiri. Jika saluran ditandai sebagai public, memanggil setChannel() akan mengembalikan kesalahan. Untuk menggunakan saluran publik, panggil unsetChannel() sebaliknya - perangkat akan secara otomatis kembali ke saluran publik yang sesuai.
• Gunakan untuk mengetahui mana saja saluran yang tersedia dan apakah mereka memungkinkan pengaturan sendiri. listChannels() Param

Tipe	Deskripsi	Apakah saluran {@link SetChannelOptions} yang ditetapkan?
options	SetChannelOptions	Mengembalikan: Mulai dari:unsetChannel(…)

Judul bagian “unsetChannel(…) Promise<ChannelRes>

unsetChannel(…) 4.7.0

---

unsetChannel(…)

unsetChannel(options: UnsetChannelOptions) => Promise<void>

Mengatur ulang saluran lokal yang diatur oleh plugin untuk perangkat ini. Ini hanya menghapus saluran yang disimpan secara lokal oleh setChannel()tetapi tidak menghapus catatan pengaturan perangkat untuk Dashboard atau Publik API.

Setelah memanggil metode ini, kebiasaan saluran normal berlaku: catatan pengaturan perangkat untuk Dashboard atau Publik API masih berlaku; jika tidak, perangkat dapat kembali ke saluran publik/default yang sesuai untuk kondisinya (platform, jenis perangkat, jenis build).

Metode ini berguna ketika:

• Ini berguna ketika Anda ingin memindahkan perangkat ke jalur pembaruan default
• Ini berguna ketika Anda ingin menggunakan saluran publik (karena saluran publik tidak dapat ditetapkan sendiri melalui setChannel())

Param	Tipe
options	UnsetChannelOptions

Sejak: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Dapatkan saluran untuk perangkat ini

Kembali: Promise<GetChannelRes>

Sejak: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

Tampilkan semua saluran yang tersedia untuk perangkat ini. Kembali saluran yang kompatibel dengan lingkungan perangkat saat ini (platform, emulator/real device, dev/prod build) dan publik atau memungkinkan penugasan sendiri.

Setiap saluran dalam hasilnya termasuk:

• publicJika true, ini adalah saluran default. Anda tidak dapat menugaskan diri sendiri ke dalamnya menggunakan setChannel(). Sebaliknya, jika Anda menghapus penugasan saluran Anda menggunakan unsetChannel(), perangkat akan secara otomatis menerima pembaruan dari saluran publik ini.
• allow_self_set: Jika true, ini adalah saluran yang dapat ditugaskan sendiri. Anda dapat menugaskan perangkat secara eksplisit ke dalam saluran ini menggunakan setChannel().

Returns: Promise<ListChannelsResult>

Sejak: 7.5.0

---

setCustomId(…)

setCustomId(options: SetCustomIdOptions) => Promise<void>

Set ID kustom untuk perangkat ini

Param	Tipe	Deskripsi
options	SetCustomIdOptions	adalah {@link SetCustomIdOptions} ID kustom untuk diatur

Sejak: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Dapatkan versi aplikasi asli atau versi bawaan jika diatur dalam konfigurasi

Returns: Promise<BuiltinVersion>

Karena: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

ID Unik Digunakan untuk Mengidentifikasi Perangkat (dikirim ke server auto update)

Returns: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Dapatkan Versi Pembaruan Natif Capacitor (dikirim ke server auto update)

Returns: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Dapatkan konfigurasi update otomatis.

Returns: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Hapus semua pendengar untuk plugin ini.

Sejak: 1.0.0

---

addListener(‘download’, …)

addListener(eventName: 'download', listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>

Dengarkan event pengunduhan bundle di Aplikasi. Mengeluarkan panggilan sekali ketika pengunduhan dimulai, selama pengunduhan dan ketika selesai. Hal ini akan mengembalikan Anda semua persentase pengunduhan selama pengunduhan

Param	Tipe
eventName	’download’
listenerFunc	(state: DownloadEvent) => void

Kembali: Promise<PluginListenerHandle>

Sejak: 2.0.11

---

addListener(‘noNeedUpdate’, …)

addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>

Dengarkan event tidak perlu diperbarui, berguna ketika Anda ingin memaksa memeriksa setiap kali aplikasi diluncurkan

Param	Tipe
eventName	’noNeedUpdate’
listenerFunc	(state: NoNeedEvent) => void

Returns: Promise<PluginListenerHandle>

Karena: 4.0.0

---

addListener(‘updateAvailable’, …)

addListener(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>

Dengar untuk event pembaruan tersedia, berguna ketika Anda ingin memeriksa setiap kali aplikasi diluncurkan

Param	Tipe
eventName	’updateAvailable’
listenerFunc	(state: UpdateAvailableEvent) => void

Returns: Promise<PluginListenerHandle>

Karena: 4.0.0

---

addListener(‘downloadComplete’, …)

addListener(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>

Dengarkan untuk event downloadComplete.

Param	Tipe
eventName	’downloadComplete’
listenerFunc	(state: DownloadCompleteEvent) => void

Dikembalikan: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

addListener(‘majorAvailable’, …)

addListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>

Dengarkan event pembaruan besar di Aplikasi, biarkan Anda tahu ketika pembaruan besar diblokir dengan mengatur disableAutoUpdateBreaking

Param	Tipe
eventName	’majorAvailable’
listenerFunc	(state: MajorAvailableEvent) => void

Returns: Promise<PluginListenerHandle>

Sejak: 2.3.0

---

addListener(‘updateFailed’, …)

addListener(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>

Dengarkan event gagal update di Aplikasi, biarkan Anda tahu ketika update gagal terpasang di aplikasi selanjutnya

Param	Tipe
eventName	’updateFailed’
listenerFunc	(state: UpdateFailedEvent) => void

Returns: Promise<PluginListenerHandle>

Sejak: 2.3.0

---

addListener(‘downloadFailed’, …)

addListener(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>

Dengarkan event gagal download di Aplikasi, biarkan Anda tahu ketika pengunduhan bundle telah gagal

Param	Tipe
eventName	’downloadFailed’
listenerFunc	(state: DownloadFailedEvent) => void

Kembali: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

addListener(‘appReloaded’, …)

addListener(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>

Dengarkan event reload di Aplikasi, biarkan Anda tahu ketika reload telah terjadi

Param	Tipe
eventName	’appReloaded’
listenerFunc	() => void

Returns: Promise<PluginListenerHandle>

Sejak: 4.3.0

---

addListener(‘appReady’, …)

addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>

Dengar Event Siap Aplikasi di Aplikasi, biarkan Anda tahu ketika aplikasi siap digunakan

Param	Tipe
eventName	’appReady’
listenerFunc	(state: AppReadyEvent) => void

Returns: Promise<PluginListenerHandle>

Sejak: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Dapatkan jika update otomatis tersedia (tidak dinonaktifkan oleh serverUrl).

Kembali: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Dapatkan bundle berikutnya yang akan digunakan ketika aplikasi di-reload. Kembali null jika tidak ada bundle berikutnya yang ditetapkan.

Kembali: Promise<BundleInfo | null>

Sejak: 6.8.0

---

setShakeMenu(…)

setShakeMenu(options: SetShakeMenuOptions) => Promise<void>

Aktifkan atau nonaktifkan menu goncangan untuk tujuan debugging/testing

Param	Tipe	Deskripsi
options	SetShakeMenuOptions	Mengandung boolean yang diaktifkan untuk mengaktifkan atau menonaktifkan menu goncangan

Sejak: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Dapatkan keadaan saat ini dari menu goncangan

Kembali: Promise<ShakeMenuEnabled>

Sejak: 7.5.0

---

Antarmuka

Hasil Siap Aplikasi

Properti	Tipe
bundle	BundleInfo

Informasi Paket

Properti	Tipe
id	string
version	string
downloaded	string
checksum	string
status	BundleStatus

URL Perbarui

Properti	Tipe
url	string

URL Statistik

Properti	Tipe
url	string

URL Saluran

Properti	Tipe
url	string

Opsi Unduh

URL dan versi ini digunakan untuk mengunduh bundle dari server, Jika Anda menggunakan backend semua informasi akan diberikan oleh metode getLatest. Jika Anda tidak menggunakan backend, Anda perlu memberikan URL dan versi bundle. SessionKey diperlukan jika Anda mengenkripsi bundle dengan perintah CLI encrypt, Anda harus menerima mereka sebagai hasil dari perintah.

Properti	Tipe	Deskripsi	Default	Sejak
url	string	URL file zip bundle (misalnya: dist.zip) yang akan diunduh. (Ini bisa URL apa saja. Misalnya: Amazon S3, tag GitHub apa pun tempat Anda telah menyiapkan bundle Anda.)
version	string	Versi code/nama dari bundle ini/versi
sessionKey	string	Kunci sesi untuk update, ketika bundle dienkripsi dengan kunci sesi	undefined	4.0.0
checksum	string	Checksum untuk update, harus dalam sha256 dan dienkripsi dengan kunci pribadi jika bundle dienkripsi	undefined	4.0.0
manifest	ManifestEntry[]	Manifest untuk Delta (manifest) download multi-file	undefined	6.1.0

ManifestEntry

Properti	Tipe
file_name	string | null
file_hash	string | null
download_url	string | null

BundleId

Properti	Tipe
id	string

BundleListResult

Properti	Tipe
bundles	BundleInfo[]

ListOptions

Prop	Tipe	Deskripsi	Default	Sejak
raw	boolean	Apakah untuk mengembalikan daftar bundle mentah atau manifest. Jika benar, daftar akan mencoba membaca database internal daripada file di disk.	false	6.14.0

ResetOptions

Prop	Tipe
toLastSuccessful	boolean

Hasil Bundle Saat Ini

Prop	Tipe
bundle	BundleInfo
native	string

MultiDelayConditions

Prop	Tipe
delayConditions	DelayCondition[]

DelayCondition

Prop	Tipe	Deskripsi
kind	DelayUntilNext	Atur kondisi delay di setMultiDelay
value	string

Versi Terbaru

Properti	Tipe	Deskripsi	Sejak
version	string	Hasil metode getLatest	4.0.0
checksum	string		6
major	boolean
message	string
sessionKey	string
error	string
old	string
url	string
manifest	ManifestEntry[]		6.1

Opsi GetLatest

Properti	Tipe	Deskripsi	Default	Sejak
channel	string	Saluran untuk mendapatkan versi terbaru untuk Saluran harus memungkinkan ‘self_assign’ untuk ini bekerja	undefined	6.8.0

ChannelRes

Properti	Tipe	Deskripsi	Sejak
status	string	Status saat ini dari saluran yang ditetapkan	4.7.0
error	string
message	string

Pilihan Set Channel

Prop	Tipe
channel	string
triggerAutoUpdate	boolean

Tidak Atur Opsi Saluran

Prop	Tipe
triggerAutoUpdate	boolean

Ambil Saluran Res

Prop	Tipe	Deskripsi	Sejak
channel	string	Status saat ini dari get channel	4.8.0
error	string
message	string
status	string
allowSet	boolean

ListChannelsResult

Prop	Tipe	Deskripsi	Sejak
channels	ChannelInfo[]	Daftar channel yang tersedia	7.5.0

ChannelInfo

Prop	Tipe	Deskripsi	Sejak
id	number	__CAPGO_KEEP_0__	7.5.0
name	string	__CAPGO_KEEP_1__	7.5.0
public	boolean	Jika benar, ini adalah saluran default/fallback. Perangkat tidak dapat menetapkan saluran publik secara otomatis. Sebaliknya, ketika perangkat menghapus pengaturan saluran yang ditentukan (menggunakan unsetChannel()), perangkat akan secara otomatis menerima update dari saluran publik yang sesuai.	7.5.0
allow_self_set	boolean	Jika benar, perangkat dapat menetapkan saluran ini secara eksplisit menggunakan setChannel(). Hal ini biasanya digunakan untuk tes beta, tes A/B, atau jalur update opt-in.	7.5.0

Saluran perintah menggunakan saluran name, bukan __CAPGO_KEEP_0__ id.

SetCustomIdOptions

Properti	Tipe
customId	string

Versi Bawaan

Properti	Tipe
version	string

ID Perangkat

Properti	Tipe
deviceId	string

Versi Plugin

Properti	Tipe
version	string

Aktifkan Perbarui Otomatis

Properti	Tipe
enabled	boolean

Handle Pengguna Plugin

Properti	Tipe
remove	() => Promise<void>

Tanggapan Unduh

Properti	Tipe	Deskripsi	Sejak
percent	number	Status saat ini dari download, antara 0 dan 100.	4.0.0
bundle	BundleInfo

NoNeedEvent

Properti	Tipe	Deskripsi	Sejak
bundle	BundleInfo	Status download saat ini, antara 0 dan 100.	4.0.0

UpdateAvailableEvent

Prop	Type	Deskripsi	Sejak
bundle	BundleInfo	Status download saat ini, antara 0 dan 100.	4.0.0

DownloadCompleteEvent

Prop	Type	Deskripsi	Sejak
bundle	BundleInfo	Keluar ketika ada pembaruan baru tersedia.	4.0.0

MajorAvailableEvent

Properti	Tipe	Deskripsi	Sejak
version	string	Keluar ketika ada bundel mayor baru tersedia.	4.0.0

UpdateFailedEvent

Properti	Tipe	Deskripsi	Sejak
bundle	BundleInfo	Keluaran ketika sebuah update gagal untuk diinstal.	4.0.0

DownloadFailedEvent

Properti	Tipe	Deskripsi	Sejak
version	string	Keluaran ketika sebuah download gagal.	4.0.0

AppReadyEvent

Prop	Tipe	Deskripsi	Sejak
bundle	BundleInfo	Ditimbulkan ketika aplikasi sudah siap digunakan.	5.2.0
status	string

AutoUpdateAvailable

Prop	Tipe
available	boolean

SetShakeMenuOptions

Prop	Tipe
enabled	boolean

ShakeMenuEnabled

Prop	Tipe
enabled	boolean

Alias Tipe

Status Paket

menunggu: Paket menunggu untuk diproses SET sebagai bundle berikutnya. downloading: Bundle sedang diunduh. success: Bundle telah diunduh dan siap untuk digunakan. SET sebagai bundle berikutnya. error: Bundle gagal diunduh.

‘success’ | ‘error’ | ‘pending’ | ‘downloading’

DelayUntilNext

‘background’ | ‘kill’ | ‘nativeVersion’ | ‘date’

Lanjutkan dari Functions dan pengaturan

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