Fungsi dan Pengaturan

Konfigurasi Plugin Pembaruan

Lihat Github Baca Me untuk informasi lebih lanjut.

CapacitorUpdater dapat dikonfigurasi dengan pilihan-pilihan berikut:

Properti	Tipe	Deskripsi	Default	Sejak
appReadyTimeout	number	Tetapkan jumlah milisecond plugin native harus menunggu sebelum memandang update sebagai ‘gagal’. Tersedia pada Android, iOS, dan Electron.	10000 // (10 seconds)
responseTimeout	number	Tetapkan jumlah milisecond plugin native harus menunggu sebelum menganggap API sebagai waktu habis. 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 cara plugin 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 segar atau pembaruan aplikasi native, kecuali menggunakan atBackground - onLaunch: Terapkan segera pada saat peluncuran, kecuali menggunakan atBackground setelah periksaan peluncuran - always: Terapkan segera setiap kali Auto Update berjalan - onlyDownload: Periksa dan download secara otomatis, emit updateAvailable, dan tidak menetapkan bundle berikut secara otomatis. Mode terapkan segera (“atInstall”, “onLaunch”, “always”) harus diunggah dengan —delta agar pembaruan tidak memperlambat pengalaman pengguna. Pada Android dan iOS, mode tersebut memerlukan autoSplashscreen: true dan @capacitor/splash-screen dengan launchAutoHide: false. Tersedia pada Android, iOS, dan Electron.	“atBackground” // true is still accepted
resetWhenUpdate	boolean	Menghapus bundle yang telah di-download sebelumnya 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 pembaruan dikirimkan. 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 pembaruan dikirimkan. Tersedia pada Android, iOS, dan Electron. Atur ke "" untuk menonaktifkan pelaporan statistik.	https://plugin.capgo.app/stats
publicKey	string	Konfigurasi kunci publik untuk enkripsi akhir ke akhir live update 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 diset, plugin akan mendapatkan versi dari native code. Tersedia pada Android, iOS, dan Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Jadikan tidak aktif. Gunakan mode string autoUpdate: “atInstall”, “onLaunch”, atau “always” saja. Opsi ini tetap mendukung untuk aplikasi yang sudah ada. Instant apply harus diunggah dengan —delta agar update tidak memperlambat pengalaman pengguna. Pada Android dan iOS, mode ini memerlukan autoSplashscreen: true dan @capacitor/splash-screen dengan launchAutoHide: false. - 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	Wajib digunakan ketika menggunakan mode instant apply (“atInstall”, “onLaunch”, atau “always”), termasuk nilai directUpdate yang sudah tidak digunakan. @capacitor/splash-screen harus diinstal dan dikonfigurasi dengan launchAutoHide: false. Ketika diaktifkan, plugin menyembunyikan layar splashscreen setelah update diterapkan atau ketika tidak ada update yang diperlukan. Ini menghilangkan kebutuhan untuk mendengarkan event appReady secara manual dan memanggil SplashScreen.hide(). Tersedia pada Android dan iOS.	false	7.6.0
periodCheckDelay	number	Konfigurasi periode menunggu untuk cek pembaruan periode. 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 pengujian atau server pembaruan self-hosted.	undefined	4.17.48
localHost	string	Konfigurasi CLI untuk menggunakan server lokal untuk pengujian atau server pembaruan self-hosted.	undefined	4.17.48
localWebHost	string	Konfigurasi CLI untuk menggunakan server lokal untuk pengujian atau server pembaruan self-hosted.	undefined	4.17.48
localSupa	string	Konfigurasi CLI untuk menggunakan server lokal untuk pengujian atau server pembaruan self-hosted.	undefined	4.17.48
localSupaAnon	string	Konfigurasi CLI untuk menggunakan server lokal untuk pengujian.	undefined	4.17.48
localApi	string	Konfigurasi CLI untuk menggunakan server lokal api untuk pengujian.	undefined	6.3.3
localApiFiles	string	Konfigurasi CLI untuk menggunakan file lokal api untuk pengujian.	undefined	6.3.3
allowModifyUrl	boolean	Biarkan plugin untuk memodifikasi 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 cloud, tetapi akan tetap menghormati pengaturan yang diubah di cloud.	undefined	5.5.0
appId	string	Konfigurasi ID aplikasi untuk aplikasi di konfigurasi.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Konfigurasi plugin untuk menyimpan URL path setelah reload. PERINGATAN: Ketika reload dipicu, ‘window.history’ akan dihapus.	false	6.8.0
disableJSLogging	boolean	Mengaktifkan atau menonaktifkan log JavaScript plugin. Jika true, plugin tidak akan menulis ke konsol JavaScript. Hanya log native yang akan dilakukan.	false	7.3.0
shakeMenu	boolean	Mengaktifkan gerakan goncang untuk menampilkan menu pembaruan untuk tujuan debugging/testing.	false	7.5.0

Misalnya

Pada 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
    }
  }
}

Pada 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()
• Interface
• Alias Tipe

Metode

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Pemberitahuan Capacitor Pembarui Aplikasi bahwa paket saat ini berfungsi (rollback akan terjadi jika metode ini tidak dipanggil pada setiap peluncuran aplikasi) Dengan default, metode ini harus dipanggil dalam 10 detik pertama setelah aplikasi diluncurkan, jika tidak maka rollback akan terjadi. Ubah perilaku ini dengan {@link appReadyTimeout}

Mengembalikan: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

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

Parameter	Jenis	Pengenalan
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 mengirim statistik. Mengirimkan string kosong akan menonaktifkan pengumpulan statistik.

Param	Param	Tipe
options	StatsUrl	Mengandung URL untuk mengirim statistik.

Sejak: 5.4.0

---

setChannelUrl(…)

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

Set URL channel untuk aplikasi, ini akan digunakan untuk menetapkan channel.

Param	Tipe	Deskripsi
options	ChannelUrl	Mengandung URL untuk mengatur saluran.

Sejak: 5.4.0

---

download(…)

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

Unduh 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	Jenis	Deskripsi
options	DownloadOptions	Deskripsi Opsi DownloadUntuk mengunduh file zip bundle baru.

Mengembalikan: Promise<BundleInfo>

---

next(…)

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

Menetapkan bundle berikutnya yang akan digunakan ketika aplikasi di-reload.

Param	Tipe	Deskripsi
options	BundleId	Mengandung ID dari Bundle berikutnya untuk diatur pada peluncuran aplikasi berikutnya. Informasi Paket.id}

Mengembalikan: Promise<BundleInfo>

---

set(…)

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

Menetapkan bundle saat ini dan memuat ulang aplikasi secara langsung.

Param	Tipe	Deskripsi
options	BundleId	A {@link} ID PaketObjek { } yang berisi ID paket baru untuk ditetapkan sebagai versi saat ini.

---

delete(…)

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

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

Param	Param	Description
options	BundleId	A {@link} ID Paketobjek yang berisi ID dari sebuah bundle untuk dihapus (perlu diingat, ini adalah ID bundle, BUKAN nama versi)

---

list(…)

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

Olehkan semua bundle yang telah diunduh secara lokal di aplikasi Anda

Param	Jenis	Deskripsi
options	ListOptions	The {link} Hasil Pengembalian:Opsi untuk menampilkan daftar bundle

Returns: Promise<BundleListResult>

---

reset(…)

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

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

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

---

current()

current() => Promise<CurrentBundleResult>

Ambil paket saat ini, jika tidak ada yang ditetapkan maka kembali builtin. currentNative adalah bundle asli yang terpasang di perangkat

Returns: 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 mengundurkan pembaruan. Setelah semua kondisi terpenuhi, proses pembaruan akan dijalankan lagi seperti biasa, sehingga pembaruan akan diinstal setelah aplikasi di background atau dibunuh. Untuk jenis date kind, nilai harus berupa string tanggal iso8601. Untuk jenis background kind, nilai harus berupa bilangan bulat dalam satuan milidetik. Untuk jenis nativeVersion kind, nilai harus berupa nomor versi. Untuk jenis kill kind, nilai tidak digunakan. Fungsi ini memiliki perilaku tidak konsisten dengan opsi kill yang akan memicu pembaruan setelah kill pertama dan tidak setelah kill berikutnya seperti opsi lainnya. Hal ini akan diperbaiki dalam rilis mayor masa depan.

Param	Jenis	Deskripsi
options	MultiDelayConditions	Mengandung {@link} Kondisi PengunduranArray kondisi untuk menetapkan

Sejak: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Batalkan sebuah getLatest(…)Bagian berjudul “getLatest(…)”

Sejak: 4.0.0

---

Salin ke clipboard

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

Dapatkan Paket Terbaru dari URL Perbarui

Param	Tipe
options	GetLatestOptions

Kembali: Promise<LatestVersion>

Sejak: 4.0.0

---

setChannel(…)

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

Mengatur saluran lokal yang diatur oleh plugin untuk perangkat ini. Saluran harus allow_device_self_set diaktifkan 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.

Catatan penting:

• Tidak gunakan metode ini untuk menetapkan saluran pada boot. Gunakan defaultChannel di dalam konfigurasi Capacitor Anda sebaliknya.
• Setelah aplikasi siap dan pengguna telah berinteraksi (misalnya, mendaftar ke program beta).
• Saluran publik tidak dapat ditetapkan sendiri. Jika saluran ditandai sebagai publicpanggilan setChannel() akan mengembalikan kesalahan. Untuk menggunakan saluran publik, panggil unsetChannel() sebaliknya - perangkat akan secara otomatis kembali ke saluran publik yang sesuai.
• Gunakan listChannels() untuk mengetahui saluran mana yang tersedia dan apakah mereka memungkinkan penetapan sendiri.

Param	Tipe	Deskripsi
options	SetChannelOptions	Apakah {@link} SetChannelOptionsMengatur opsi channel

Kembali: Promise<ChannelRes>

Sejak: 4.7.0

---

unsetChannel(…)

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

Menghapus channel lokal yang dikelola plugin untuk perangkat ini. Ini hanya menghapus channel yang disimpan secara lokal oleh setChannel(); tidak menghapus catatan Dashboard atau Publik API Pengaturan Perangkat

Setelah memanggil metode ini, keutamaan saluran normal berlaku: saluran Dashboard atau Public API Device Override yang sudah ada masih menang; jika tidak, perangkat dapat kembali ke saluran publik/default yang sesuai untuk kondisinya (platform, jenis perangkat, jenis bangunan).

Hal ini berguna ketika:

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

Param	Tipe
options	UnsetChannelOptions

Sejak: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Ambil saluran untuk perangkat ini

getChannel() Promise<GetChannelRes>

Sejak: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

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

Setiap saluran dalam hasilnya termasuk:

• publicJika trueini adalah saluran defaultSaluran ini tidak dapat Anda tugas sendiri 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 diperbarui sendiri. Anda dapat menetapkan perangkat secara eksplisit ke saluran ini menggunakan setChannel().

Returns: Promise<ListChannelsResult>

Since: 7.5.0

---

setCustomId(…)

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

Menetapkan ID khusus untuk perangkat ini

Param	Jenis	Deskripsi
options	SetCustomIdOptions	adalah {@link} SetCustomIdOptionsopsi untuk mengatur customId

Sejak: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Peroleh versi aplikasi native atau versi bawaan jika telah ditetapkan di konfigurasi

Kembali: Promise<BuiltinVersion>

Sejak: 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 plugin Updater native Capacitor (dikirim ke server auto update)

Returns: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Mendapatkan status konfigurasi auto update.

Mengembalikan: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Menghapus semua pendengar untuk plugin ini.

Mengingat: 1.0.0

---

Tambahkan Pengguna (addListener('download', …))

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

Mendengarkan event download bundle di Aplikasi. Mengeluarkan peristiwa ketika download dimulai, selama download berlangsung dan ketika selesai. Mengembalikan persentase download selama proses download

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

Kembali: Promise<PluginListenerHandle>

Sejak: 2.0.11

---

tambahkanPengguna('tidakPerluUpdate', …)

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

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

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

Kembali: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

tambahkanPengguna('updateAvailable', …)

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

Dengarkan event update yang tersedia, berguna ketika Anda ingin memeriksa update setiap kali aplikasi diluncurkan.

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

Mengembalikan: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

addListener(‘downloadComplete’, …)

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

Tunggu event download selesai

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

Kembali: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

tambahkanPengguna('majorTersedia', …)

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

Tunggu Peristiwa Pembaruan Besar di Aplikasi, biarkan Anda tahu ketika pembaruan besar diblokir dengan mengatur disableAutoUpdateBreaking

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

Kembali: Promise<PluginListenerHandle>

Sejak: 2.3.0

---

tambahkanPengguna('updateGagal', …)

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

Dengarkan event gagal update di Aplikasi, memberitahu Anda ketika update gagal terpasang pada aplikasi mulai berikutnya

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

Mengembalikan: Promise<PluginListenerHandle>

Mulai dari: 2.3.0

---

Tambahkan Pengguna (addListener('downloadFailed', …))

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

Perhatikan event gagal download di Aplikasi, Anda akan mendapat notifikasi ketika pengunduhan bundle gagal

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

Kembali: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

tambahkanPengguna('appReloaded', …)

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

Dengarkan event reload aplikasi, memungkinkan Anda mengetahui ketika reload telah terjadi

Parameter	Tipe
eventName	‘appReloaded’
listenerFunc	() => void

Kembali: Promise<PluginListenerHandle>

Sejak: 4.3.0

---

tambahkanPengguna('appReady', …)

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

Tunggu event siap aplikasi di Aplikasi, memberitahu Anda ketika aplikasi siap digunakan

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

Mengembalikan: Promise<PluginListenerHandle>

Sejak: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Periksa jika pembaruan otomatis tersedia (tidak dinonaktifkan oleh serverUrl)

Mengembalikan: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

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

Returns: Promise<BundleInfo | null>

Mengembalikan: 6.8.0

---

setShakeMenu(…)

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

Aktifkan atau nonaktifkan menu goncang untuk tujuan debugging/test.

Param	Type	Deskripsi
options	SetShakeMenuOptions	Mengandung boolean yang diaktifkan untuk mengaktifkan atau menonaktifkan menu getar

Sejak: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Dapatkan keadaan saat ini dari menu guncangan

Kembali: Promise<ShakeMenuEnabled>

Sejak: 7.5.0

---

Interface

AppReadyResult

Prop	Tipe
bundle	BundleInfo

Info Paket

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

URL Perbarui

Prop	Tipe
url	string

URL Statistik

Prop	Tipe
url	string

SaluranUrl

Prop	Tipe
url	string

Pilihan Download

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

Prop	Tipe	Deskripsi	Default	Sejak
url	string	URL dari file zip bundle (misal: dist.zip) yang akan diunduh. (URL ini bisa apa saja. Misal: Amazon S3, tag GitHub, atau tempat lain yang kamu host bundle kamu.)
version	string	Versi code/nama dari bundle ini
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 terenkripsi	undefined	4.0.0
manifest	ManifestEntry[]	Manifest untuk download Delta (manifest) multi-file	undefined	6.1.0

ManifestEntry

Sifat	Tipe
file_name	string | null
file_hash	string | null
download_url	string | null

ID Paket

Properti	Tipe
id	string

ID Daftar Paket

Properti	Tipe
bundles	BundleInfo[]

Opsi Daftar

Properti	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

Properti	Tipe
toLastSuccessful	boolean

Informasi Bundle Saat Ini

Properti	Tipe
bundle	BundleInfo
native	string

MultiDelayConditions

Properti	Tipe
delayConditions	DelayCondition[]

DelayCondition

Properti	Tipe	Deskripsi
kind	DelayUntilNext	Atur kondisi pengunduran diri dalam setMultiDelay
value	string

Versi Terbaru

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

Hasil metode getLatest

Properti	Tipe	Description	Default	Deskripsi
channel	string	Saluran untuk mendapatkan versi terbaru untuk Saluran harus memungkinkan ‘self_assign’ agar ini dapat berfungsi	undefined	6.8.0

ChannelRes

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

SetChannelOptions

Prop	Tipe
channel	string
triggerAutoUpdate	boolean

UnsetChannelOptions

Prop	Tipe
triggerAutoUpdate	boolean

GetChannelRes

Prop	Tipe	Deskripsi	Sejak
channel	string	Status Saat Ini Get Channel	4.8.0
error	string
message	string
status	string
allowSet	boolean

ListChannelsResult

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

ChannelInfo

Prop	Tipe	Deskripsi	Sejak
id	number	ID Kanal Numerik	7.5.0
name	string	Nama Saluran	7.5.0
public	boolean	Jika benar, ini adalah saluran default/fallback. Perangkat tidak dapat menetapkan saluran secara otomatis ke saluran publik. Sebaliknya, ketika perangkat menghapus penetapan saluran yang diubah (menggunakan unsetChannel()), perangkat akan menerima pembaruan secara otomatis dari saluran publik yang sesuai.	7.5.0
allow_self_set	boolean	Jika benar, perangkat dapat menetapkan saluran secara eksplisit menggunakan setChannel(). Ini biasanya digunakan untuk tes beta, tes A/B, atau jalur pembaruan opt-in.	7.5.0

Saluran menggunakan perintah saluran name, bukan ID numerik id.

SetCustomIdOptions

Properti	Tipe
customId	string

Versi Bawaan

Prop	Tipe
version	string

ID Perangkat

Prop	Tipe
deviceId	string

Versi Plugin

Prop	Tipe
version	string

AutoUpdateEnabled

Prop	Tipe
enabled	boolean

Penanganan Plugin

Prop	Tipe
remove	() => Promise<void>

Event Download

Prop	Tipe	Deskripsi	Sejak
percent	number	Status saat ini pengunduhan, antara 0 dan 100.	4.0.0
bundle	BundleInfo

TidakPerluEvent

Properti	Jenis	Deskripsi	Sejak
bundle	BundleInfo	Status saat ini pengunduhan, antara 0 dan 100.	4.0.0

Status Pengunduhan Tersedia

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

DownloadCompleteEvent

Properti	Jenis	Deskripsi	Sejak
bundle	BundleInfo	Emisi Ketika Ada Update Baru	4.0.0

Peristiwa Versi Utama

Properti	Tipe	Keterangan	Sejak
version	string	Terbitkan ketika tersedia bundel mayor baru.	4.0.0

UpdateFailedEvent

Properti	Tipe	Keterangan	Sejak
bundle	BundleInfo	Emit ketika sebuah pembaruan gagal terpasang.	4.0.0

DownloadFailedEvent

Prop	Tipe	Deskripsi	Sejak
version	string	Emit ketika sebuah download gagal.	4.0.0

AppReadyEvent

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

Tersedia Perbarui Otomatis

Properti	Tipe
available	boolean

Atur Opsi Menu Guncang

Properti	Tipe
enabled	boolean

ShakeMenuEnabled

Prop	Tipe
enabled	boolean

Tipe Aliasi

Status Paket

menunggu: Paket menunggu untuk di SET mendownload: Paket sedang diunduh. sukses: Paket telah diunduh dan siap untuk diinstal. SET seperti bundel berikutnya. error: Bundel gagal untuk diunduh.

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

DelayUntilNext

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

Teruskan dari Fungsi dan Pengaturan

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