Fungsi dan Pengaturan

Konfigurasi Plugin Pembarui

Lihat Github Baca Me untuk informasi lebih lanjut.

CapacitorUpdater dapat dikonfigurasi dengan pilihan-pilihan berikut:

Properti	Tipe	Deskripsi	Default	Sejak
appReadyTimeout	number	Konfigurasi jumlah milisecond plugin native harus menunggu sebelum memandang update ‘gagal’. Tersedia pada Android, iOS, dan Electron.	10000 // (10 seconds)
responseTimeout	number	Konfigurasi jumlah milisecond plugin native harus menunggu sebelum memandang 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 update sukses. Tersedia pada Android, iOS, dan Electron.	true
autoUpdate	boolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’	Konfigurasi cara 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 hanya setelah instalasi segar atau pembaruan aplikasi native, lainnya gunakan atBackground - onLaunch: Terapkan segera pada saat peluncuran, lainnya gunakan atBackground setelah pengecekan peluncuran - selalu: Terapkan segera kapan pun Auto Update berjalan - hanyaDownload: Periksa dan download secara otomatis, emit updateAvailable, dan tidak pernah menetapkan bundle berikut secara otomatis. Mode terapkan instan (“atInstall”, “onLaunch”, “selalu”) 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	Hapus otomatis bundle yang telah diunduh 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 dikirim. Tersedia pada Android, iOS, dan Electron.	https://plugin.capgo.app/updates
channelUrl	string	Konfigurasi URL / endpoint untuk operasi saluran. Tersedia pada Android, iOS, dan Electron.	https://plugin.capgo.app/channel_self
statsUrl	string	Konfigurasi URL / endpoint ke mana statistik pembaruan dikirim. Tersedia pada Android, iOS, dan Electron. Atur ke "" untuk menghentikan pelaporan statistik.	https://plugin.capgo.app/stats
publicKey	string	Konfigurasi kunci publik untuk enkripsi pembaruan 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 pembaruan 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’	Tidak digunakan lagi. 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 pembaruan tidak memperlambat pengalaman pengguna. Pada Android dan iOS, mode ini memerlukan autoSplashscreen: true dan @capacitor/splash-screen dengan launchAutoHide: false. - false: Tidak pernah melakukan pembaruan 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	Diperlukan 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 splashscreen setelah pembaruan diterapkan atau ketika tidak ada pembaruan 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 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	Biarkan plugin untuk memodifikasi updateUrl, statsUrl, dan channelUrl secara dinamis dari sisi JavaScript.	false	5.4.0
defaultChannel	string	Setel saluran default untuk aplikasi di konfigurasi. Case sensitive. Pengaturan ini akan menggantikan saluran default yang telah ditetapkan di cloud, tetapi akan tetap menghormati pengaturan yang telah dibuat di cloud.	undefined	5.5.0
appId	string	Konfigurasi ID aplikasi untuk aplikasi di konfigurasi.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Konfigurasi plugin untuk menjaga URL path setelah reload. PERINGATAN: Ketika reload dilakukan, ‘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 keperluan debugging/testing.	false	7.5.0

Contoh

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 bahwa paket saat ini sedang berjalan (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 akan terjadi rollback. Ubah perilaku ini dengan {@link appReadyTimeout}

Mengembalikan: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

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

Parameter	Jenis	Deskripsi
options	UpdateUrl	mengandung URL untuk digunakan untuk memeriksa pembaruan.

Sejak: 5.4.0

---

setStatsUrl(…)

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

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

Param	Jenis	Deskripsi
options	StatsUrl	mengandung URL untuk digunakan untuk mengirimkan statistik.

Sejak: 5.4.0

---

setChannelUrl(…)

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

Atur channelUrl untuk aplikasi, ini akan digunakan untuk menetapkan channel.

Param	Tipe	Deskripsi
options	ChannelUrl	mengandung URL yang digunakan untuk menetapkan channel.

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

Parameter	Jenis	Deskripsi
options	DownloadOptions	Opsi download untuk mengunduh zip bundle baru. Mengembalikan:next(…)

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

---

Salin ke clipboard

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

__CAPGO_KEEP_0__

__CAPGO_KEEP_1__	Tipe	Deskripsi
options	BundleId	Mengandung ID dari Bundle berikutnya untuk diatur pada peluncuran aplikasi selanjutnya. {@link} BundleInfo.id}

Hasil Pengembalian: Promise<BundleInfo>

---

set(…)

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

Set bundle saat ini dan memuat ulang aplikasi secara langsung.

Param	Tipe	Deskripsi
options	BundleId	A {@link} ID Paket} object containing the new bundle id to set as current.

---

delete(…)

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

Menghapus paket yang ditentukan dari penyimpanan aplikasi native. Gunakan dengan {@link list} untuk mendapatkan ID-ID Paket yang disimpan.

Param	Tipe	Deskripsi
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>

Dapatkan semua bundle yang telah diunduh secara lokal di aplikasi Anda

Param	Tipe	Deskripsi
options	ListOptions	Parameter {@link} ListOptionsHasil Pengembalian:

list(…) Promise<BundleListResult>

---

reset(…)

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

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

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

---

Mengembalikan()

current() => Promise<CurrentBundleResult>

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

Mengembalikan: Promise<CurrentBundleResult>

---

Mengisi ulang()

reload() => Promise<void>

Mengisi ulang tampilan

---

setMultiDelay(…)

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

Mengatur sebuah array {@link} DelayCondition} yang berisi kondisi-kondisi yang akan digunakan Plugin untuk mengundurkan update. Setelah semua kondisi terpenuhi, proses update akan berjalan kembali seperti biasa, sehingga update akan diinstal setelah aplikasi di background atau dihentikan. Untuk jenis date nilai harus berupa string tanggal iso8601. Untuk jenis background nilai harus berupa bilangan bulat dalam satuan milidetik. Untuk jenis nativeVersion nilai harus berupa nomor versi. Untuk jenis kill nilai tidak digunakan. Fungsi ini memiliki perilaku tidak konsisten, opsi

mengaktifkan update setelah aplikasi dihentikan pertama kali dan tidak setelah aplikasi di background seperti opsi lainnya. Hal ini akan diperbaiki dalam rilis mayor berikutnya.	Parameter	Jenis
options	MultiDelayConditions	Deskripsi MultiKeterangaKondisiArray dari kondisi untuk menetapkan

Sejak: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Membatalkan sebuah {@link} KondisiKeterlambatan} untuk memproses pembaruan segera.

Sejak: 4.0.0

---

getLatest(…)

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

Dapatkan Paket Terbaru yang Tersedia dari URL Perbarui

Param	Jenis
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 mengaktifkan 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:

• Jangan menggunakan metode ini untuk menetapkan 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 listChannels() untuk mengetahui saluran mana yang tersedia dan apakah mereka memungkinkan penetapan sendiri.

Param	Menggunakan	Deskripsi
options	SetChannelOptions	Apakah {@link Mengatur Opsi Saluran} saluran untuk mengatur

Mengembalikan: Promise<ChannelRes>

Sejak: 4.7.0

---

unsetChannel(…)

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

Menghapus saluran lokal yang diatur oleh plugin untuk perangkat ini. Ini hanya menghapus saluran yang disimpan secara lokal oleh setChannel()tidak menghapus catatan Pengaturan Dasbor atau Publik API Pengaturan Perangkat

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

Ini berguna ketika:

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

Param	Tipe
options	UnsetChannelOptions

Sejak: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Dapatkan kanal untuk perangkat ini

Mengembalikan: 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: true, ini adalah saluran defaultAnda tidak dapat menugaskan sendiri ke saluran ini 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 diberi tugas 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>

Setel ID kustom untuk perangkat ini

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

Sejak: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

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

Mengembalikan: Promise<BuiltinVersion>

Sejak: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

Mendapatkan ID unik yang digunakan untuk mengidentifikasi perangkat (dikirim ke server auto update)

Kembali: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Mendapatkan versi plugin native Capacitor Updater (dikirim ke server auto update)

Kembali: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Peroleh status konfigurasi auto update.

Kembali: Promise<AutoUpdateEnabled>

---

Hapus Semua Pemangku Jalan.

removeAllListeners() => Promise<void>

Hapus Semua Pemangku Jalan untuk Plugin ini.

Sejak: 1.0.0

---

Tambahkan Pemangku Jalan(‘download’, …)

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

Dengarkan Event Pengunduhan Paket di Aplikasi. Melempar sekali ketika pengunduhan dimulai, selama pengunduhan dan ketika selesai. Fungsi ini akan mengembalikan semua persentase pengunduhan selama pengunduhan

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 diperbarui, 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('updateTersedia', …)

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

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

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

Kembali: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

addListener(‘downloadComplete’, …)

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

Dengar event downloadComplete.

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

Kembali: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

tambahkanPengguna('majorTersedia', …)

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

Dengarkan event pembaruan besar di Aplikasi, memungkinkan Anda mengetahui ketika pembaruan besar diblokir dengan mengatur disableAutoUpdateBreaking

Parameter	Jenis
eventName	‘majorAvailable’
listenerFunc	(state: MajorAvailableEvent) => void

Kembali: Promise<PluginListenerHandle>

Sejak: 2.3.0

---

tambahkanPengguna('updateGagal', …)

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

Dengar event gagal update di Aplikasi, biarkan Anda tahu ketika update gagal terpasang di mulai aplikasi berikutnya

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

Mengembalikan: Promise<PluginListenerHandle>

Sejak: 2.3.0

---

Dengar event gagal download di Aplikasi, biarkan Anda tahu ketika pengunduhan paket gagal

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

Dengar event gagal download di Aplikasi, biarkan Anda tahu ketika pengunduhan paket gagal

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

Hasil: 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

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

Hasil: Promise<PluginListenerHandle>

Sejak: 4.3.0

---

tambahkanPengguna('appReady', …)

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

Dengarkan event siap aplikasi di App, memungkinkan Anda mengetahui ketika aplikasi siap digunakan

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

Kembali: Promise<PluginListenerHandle>

Sejak: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

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

Kembali: Promise<AutoUpdateAvailable>

---

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

getNextBundle() => Promise<BundleInfo | null>

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

Mengembalikan: Promise<BundleInfo | null>

Sejak: 6.8.0

---

Mengatur menu guncang untuk tujuan debugging/testing

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

Mengaktifkan atau menonaktifkan menu guncang untuk tujuan debugging/testing

Merkur	Tipe	Deskripsi
options	SetShakeMenuOptions	Mengandung boolean yang diaktifkan untuk mengaktifkan atau menonaktifkan menu guncangan

Sejak: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Dapatkan keadaan saat ini dari menu guncangan

Kembali: Promise<ShakeMenuEnabled>

Sejak: 7.5.0

---

Interface

AppReadyResult

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 Channel

Properti	Tipe
url	string

Pilihan Download

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. Kunci Sesi 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. (URL ini bisa apa saja. Misalnya: Amazon S3, tag GitHub, tempat lainnya yang Anda host bundle Anda.)
version	string	Versi code/nama dari bundle ini
sessionKey	string	Kunci sesi untuk melakukan update, ketika bundle dienkripsi dengan kunci sesi	undefined	4.0.0
checksum	string	Checksum untuk melakukan update, harus dalam sha256 dan dienkripsi dengan kunci pribadi jika bundle dienkripsi	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

Hasil 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

Prop	Jenis
toLastSuccessful	boolean

HasilBundleSaatIni

Prop	Jenis
bundle	BundleInfo
native	string

MultiKeterangKondisiMundur

Properti	Jenis
delayConditions	DelayCondition[]

KondisiMundur

Properti	Jenis	Deskripsi
kind	DelayUntilNext	Konfigurasi kondisi mundur di setMultiDelay
value	string

VersiTerbaru

Properti	Jenis	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

GetLatestOptions

Properti	Jenis	Deskripsi	Default	Sejak
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 telah ditetapkan	4.7.0
error	string
message	string

SetChannelOptions

Prop	Tipe
channel	string
triggerAutoUpdate	boolean

Opsi Saluran Tidak Terdefinisi

Properti	Tipe
triggerAutoUpdate	boolean

Respon Saluran

Properti	Tipe	Deskripsi	Sejak
channel	string	Status Saat Ini Get Saluran	4.8.0
error	string
message	string
status	string
allowSet	boolean

Hasil Daftar Saluran

Properti	Jenis	Deskripsi	Sejak
channels	ChannelInfo[]	Daftar saluran yang tersedia	7.5.0

ChannelInfo

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

Perintah saluran menggunakan saluran name bukan ID saluran angka id.

SetCustomIdOptions

Properti	Tipe
customId	string

Versi Bawaan

Properti	Jenis
version	string

Id Perangkat

Properti	Jenis
deviceId	string

Versi Plugin

Properti	Jenis
version	string

Diaktifkan Otomatis

Properti	Tipe
enabled	boolean

Referensi Pengguna Plugin

Properti	Tipe
remove	() => Promise<void>

Event Download

Properti	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

EventPembaruanTersedia

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

DownloadCompleteEvent

Properti	Tipe	Deskripsi	Sejak
bundle	BundleInfo	Dikirim ketika ada update baru tersedia.	4.0.0

PeristiwaVersiMajorku

Properti	Jenis	Deskripsi	Sejak
version	string	Emisi ketika bundel mayor baru tersedia.	4.0.0

PeristiwaPembaruanGagal

Properti	Jenis	Deskripsi	Sejak
bundle	BundleInfo	Event yang dipancarkan ketika update gagal terpasang.	4.0.0

DownloadFailedEvent

Properti	Tipe	Deskripsi	Sejak
version	string	Event yang dipancarkan ketika download gagal.	4.0.0

AppReadyEvent

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

AutoUpdateTersedia

Properti	Tipe
available	boolean

AturOpsiMenuGuncang

Properti	Tipe
enabled	boolean

Diaktifkan ShakeMenu

Sifat	Tipe
enabled	boolean

Alias Tipe

Status Paket

menunggu: Paket menunggu untuk di SET sebagai paket berikutnya. downloading: Paket sedang diunduh. success: Paket telah diunduh dan siap untuk di SET seperti bundle berikutnya. error: Bundle gagal untuk diunduh.

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

Menunggu Sampai Bundle Berikutnya

‘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 dalam Menggunakan @capgo/capacitor-updater, Ringkasan API untuk detail implementasi dalam Ringkasan API, Pengenalan untuk detail implementasi di Pengenalan, Kunci API untuk detail implementasi di Kunci API dan Perangkat untuk detail implementasi di Perangkat.