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 menganggap update ‘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 update sukses. Tersedia pada Android, iOS, dan Electron.	true
autoUpdate	boolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’	Konfigurasi bagaimana plugin menggunakan Auto Update melalui server update. true sama dengan “atBackground”; false sama dengan “off”. - off: Matikan Auto Update - atBackground: Periksa dan download secara otomatis, kemudian aplikasikan ketika aplikasi berpindah ke latar belakang - atInstall: Aplikasikan segera setelah instalasi baru atau update aplikasi native, kecuali menggunakan atBackground - onLaunch: Aplikasikan segera pada saat launch, kecuali menggunakan atBackground setelah periksa - always: Aplikasikan 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 otomatis bundle yang 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 update 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 yang menerima statistik pembaruan. Tersedia pada Android, iOS, dan Electron. Atur ke "" untuk menonaktifkan 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 diatur, 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 aplikasi yang sudah ada. - 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	Mengatur otomatis untuk menyembunyikan layar splashscreen ketika menggunakan mode aplikasi instant. Ketika diaktifkan, plugin akan secara otomatis 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(). Hanya berfungsi ketika autoUpdate diatur ke “atInstall”, “onLaunch”, atau “always”. Nilai directUpdate legacy masih didukung untuk kompatibilitas 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 update 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 update self-hosted.	undefined	4.17.48
localHost	string	Konfigurasi CLI untuk menggunakan server lokal untuk tes atau server update self-hosted.	undefined	4.17.48
localWebHost	string	Konfigurasi CLI untuk menggunakan server lokal untuk tes atau server update self-hosted.	undefined	4.17.48
localSupa	string	Konfigurasi CLI untuk menggunakan server lokal untuk tes atau server update 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	Mengizinkan 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. Kasus sensitif. 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 menjaga URL path setelah reload. PERINGATAN: Ketika reload dipicu, ‘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 tujuan debugging/testing	false	7.5.0

Contoh

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

Dalam 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
• Tipe Alias

Metode

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Peringatkan Pembarui Capacitor 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}

Kembali: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

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

Param	Tipe	Deskripsi
options	UpdateUrl	mengandung URL untuk memeriksa pembaruan.

Sejak: 5.4.0

---

setStatsUrl(…)

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

Simpan ke clipboard

Atur URL statistik untuk aplikasi, ini akan digunakan untuk mengirimkan statistik. Mengirimkan string kosong akan menghentikan pengumpulan statistik.	Param	Tipe
options	StatsUrl	mengandung URL untuk mengirim 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 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>

---

Opsi untuk mengunduh sebuah bundle zip baru.

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

Atur bundle berikutnya untuk digunakan ketika aplikasi di-reload.

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

Kembali: Promise<BundleInfo>

---

set(…)

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

Atur bundle saat ini dan reload aplikasi secara langsung.

Parameter	Tipe	Deskripsi
options	BundleId	A {@link Objek BundleId} yang berisi ID bundle baru untuk diatur 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	Objek {@link BundleId} yang berisi ID dari 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	Objek {@link Daftar Opsi} untuk menampilkan bundle

Dikembalikan: 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 terakhir yang sukses dimuat.

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 terpasang di perangkat

Kembali: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Muat ulang tampilan

---

__CAPGO_KEEP_0__

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 jenis __CAPGO_KEEP_1__, nilai yang harus dimasukkan adalah string tanggal ISO 8601. Untuk jenis __CAPGO_KEEP_2__, nilai yang harus dimasukkan adalah bilangan bulat dalam milidetik. Untuk jenis __CAPGO_KEEP_3__, nilai yang harus dimasukkan adalah nomor versi. Untuk jenis __CAPGO_KEEP_4__, nilai yang tidak digunakan. Fungsi ini memiliki perilaku tidak konsisten, karena opsi kill akan memicu pembaruan setelah kill pertama dan tidak setelah background berikutnya seperti opsi lainnya. Hal ini akan diperbaiki dalam rilis mayor masa depan. ParamMengatur waktu tunggu multi date Bagian berjudul “Mengatur waktu tunggu multi” background Salin ke klipbord nativeVersion 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 jenis __CAPGO_KEEP_1__, nilai yang harus dimasukkan adalah string tanggal ISO 8601. Untuk jenis __CAPGO_KEEP_2__, nilai yang harus dimasukkan adalah bilangan bulat dalam milidetik. Untuk jenis __CAPGO_KEEP_3__, nilai yang harus dimasukkan adalah nomor versi. Untuk jenis __CAPGO_KEEP_4__, nilai yang tidak digunakan. Fungsi ini memiliki perilaku tidak konsisten, karena opsi kill akan memicu pembaruan setelah kill pertama dan tidak setelah background berikutnya seperti opsi lainnya. Hal ini akan diperbaiki dalam rilis mayor masa depan. kill Param

Mengatur waktu tunggu multi	Tipe	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

---

__CAPGO_KEEP_0__

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

Dapatkan bundle terbaru yang tersedia dari URL update

Param	Tipe
options	GetLatestOptions

Dikembalikan: Promise<LatestVersion>

Sejak: 4.0.0

---

setChannel(…)

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

Mengatur saluran untuk perangkat ini. Saluran harus allow_device_self_set diperlukan untuk ini berfungsi.

Catatan penting:

• Jangan menggunakan 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, panggilan setChannel() akan mengembalikan kesalahan. Untuk menggunakan saluran publik, panggil unsetChannel() sebaliknya - perangkat akan secara otomatis kembali ke saluran publik yang sesuai.
• Gunakan listChannels() untuk menemukan mana-mana saluran yang tersedia dan apakah mereka memungkinkan pengasasan sendiri.

Param	Tipe	Deskripsi
options	SetChannelOptions	Apakah saluran {@link SetChannelOptions} yang digunakan untuk pengaturan

Kembali: Promise<ChannelRes>

Sejak: 4.7.0

---

unsetChannel(…)

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

Mengatur ulang pengaturan saluran untuk perangkat ini. Setelah memanggil metode ini, perangkat akan secara otomatis menerima pembaruan dari saluran publik yang sesuai dengan kondisinya (platform, jenis perangkat, jenis build). saluran publik Hal ini berguna ketika:

Anda ingin memindahkan perangkat kembali ke jalur pembaruan default

• Anda ingin menggunakan saluran publik (karena saluran publik tidak dapat ditugaskan sendiri melalui
• Param setChannel())

Type	Since:
options	UnsetChannelOptions

getChannel() 4.7.0

---

Bagian berjudul “getChannel()”

getChannel() => Promise<GetChannelRes>

Dapatkan saluran untuk perangkat ini

Kembali: Promise<GetChannelRes>

Sejak: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

Daftar semua saluran yang tersedia untuk perangkat ini. Kembali 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 hasil termasuk:

• publicJika trueini adalah saluran standar. Anda tidak dapat menugaskan sendiri kepadanya menggunakanAnda tidak dapat menugaskan sendiri kepadanya setChannel(). Sebaliknya, jika Anda menghapus pengaturan saluran Anda menggunakan unsetChannel(), perangkat akan secara otomatis menerima update dari saluran publik ini.
• allow_self_set: Jika true, ini adalah saluran yang dapat diassign sendiri. Anda dapat mengassign perangkat secara eksplisit ke saluran ini menggunakan setChannel().

Returns: Promise<ListChannelsResult>

Sejak: 7.5.0

---

setCustomId(…)

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

Atur ID kustom untuk perangkat ini

Parameter	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 telah ditetapkan di konfigurasi

Kembali: Promise<BuiltinVersion>

Sejak: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

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

Kembali: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

Kembali: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Dapatkan status konfigurasi auto update.

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>

Tunggu event download bundle di Aplikasi. Mengeluarkan panggilan sekali ketika download dimulai, selama proses download dan ketika selesai.

Ini akan mengembalikan persentase download selama proses download	Param
eventName	’download’
listenerFunc	(state: DownloadEvent) => void

Tipe Promise<PluginListenerHandle>

Kembali: 2.0.11

---

Sejak:

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

Salin ke clipboard

Tunggu event tidak perlu update, berguna ketika Anda ingin memeriksa setiap kali aplikasi diluncurkan	Param
eventName	’noNeedUpdate’
listenerFunc	(state: NoNeedEvent) => void

Tipe Promise<PluginListenerHandle>

Sejak: 4.0.0

---

addListener(‘updateAvailable’, …)

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

Dengarkan event pembaruan 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>

Tunggu event downloadComplete.

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

Kembali: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

addListener(‘majorAvailable’, …)

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

Tunggu event 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

---

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 mulai aplikasi berikutnya

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

Kembali: 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 bundle download gagal

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

Kembali: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

Tambahkan pendengar (‘appReloaded’, …)

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

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

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

Kembali: Promise<PluginListenerHandle>

Sejak: 4.3.0

---

addListener(‘appReady’, …)

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

Dengarkan event siap aplikasi di App, biarkan Anda tahu 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 pembaruan 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 goncang untuk keperluan debugging/testing

Parameter	Tipe	Deskripsi
options	SetShakeMenuOptions	Mengandung boolean yang diaktifkan untuk mengaktifkan atau menonaktifkan menu goncang

Sejak: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Dapatkan status saat ini dari menu goncang

Kembali: Promise<ShakeMenuEnabled>

Sejak: 7.5.0

---

Interface

__CAPGO_KEEP_0__

__CAPGO_KEEP_1__	__CAPGO_KEEP_2__
bundle	BundleInfo

Informasi Paket

__CAPGO_KEEP_3__	__CAPGO_KEEP_4__
id	string
version	string
downloaded	string
checksum	string
status	BundleStatus

URL Perbarui

__CAPGO_KEEP_5__	Tipe
url	string

__CAPGO_KEEP_0__

Prop	Tipe
url	string

URL Saluran

Prop	Tipe
url	string

Pilihan Download

This URL and versions are used to download the bundle from the server, If you use backend all information will be given by the method getLatest. If you don’t use backend, you need to provide the URL and version of the bundle. SessionKey are required if you encrypted the bundle with the CLI command encrypt, you should receive them as result of the command.

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

ManifestEntry

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

ID Paket

Properti	Tipe
id	string

Hasil Daftar Paket

Opsi Daftar	Bagian Opsi Daftar
bundles	BundleInfo[]

Bagian Opsi Daftar

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

Reset Opsi

Properti	Tipe
toLastSuccessful	boolean

Hasil Bundle Saat Ini

Properti	Tipe
bundle	BundleInfo
native	string

Kondisi Pengunduran Diri yang Berulang

Properti	Tipe
delayConditions	DelayCondition[]

Kondisi Pengunduran Diri

Properti	Tipe	Deskripsi
kind	DelayUntilNext	Tetapkan kondisi pengunduran diri dalam 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

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

SetChannelOptions

Properti	Tipe
channel	string
triggerAutoUpdate	boolean

__CAPGO_KEEP_0__

Properti	Tipe
triggerAutoUpdate	boolean

__CAPGO_KEEP_0__

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

__CAPGO_KEEP_0__

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

__CAPGO_KEEP_0__

Prop	Type	Deskripsi	Sejak
id	string	ID Saluran	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 pengaturan saluran yang ditetapkan (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 secara eksplisit menggunakan setChannel(). Ini biasanya digunakan untuk tes beta, tes A/B, atau jalur update opt-in.	7.5.0

SetCustomIdOptions

Properti	Tipe
customId	string

__CAPGO_KEEP_0__

__CAPGO_KEEP_1__	Properti
version	string

__CAPGO_KEEP_2__

__CAPGO_KEEP_3__	ID Perangkat
deviceId	string

Bagian ID Perangkat

Tipe	__CAPGO_KEEP_5__
version	string

Aktifkan Perbarui Otomatis

Properti	Tipe
enabled	boolean

Penanganan 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	Tipe	Deskripsi	Sejak
bundle	BundleInfo	Status saat ini pengunduhan, antara 0 dan 100.	4.0.0

EventDiperbarui

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

__CAPGO_KEEP_0__

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

Event Utama Tersedia

Properti	Tipe	Deskripsi	Sejak
version	string	__CAPGO_KEEP_0__ Ketika bundel utama baru tersedia.	4.0.0

Event Pembaruan Gagal

Properti	Tipe	Deskripsi	Sejak
bundle	BundleInfo	__CAPGO_KEEP_0__	4.0.0

DownloadFailedEvent

Properti	Tipe	Deskripsi	Sejak
version	string	__CAPGO_KEEP_0__	4.0.0

AppReadyEvent

Properti	Tipe	Deskripsi	Sejak
bundle	BundleInfo	Ditimbulkan 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

Aktifkan Shake Menu

Properti	Tipe
enabled	boolean

Pengganti Tipe

Status Paket

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

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

error: Bundle gagal untuk didownload.

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

Judul Bagian “Menggunakan DelayUntilNext”

Fungsi dan Pengaturan untuk merencanakan dashboard dan operasi __CAPGO_KEEP_0__, hubungkannya dengan Menggunakan @API/__CAPGO_KEEP_1__-updater untuk kemampuan asli dalam Menggunakan @capgo/capacitor-updater, for the native capability in Using @capgo/capacitor-updater, untuk detail implementasi dalam Ringkasan API, for the implementation detail in API Overview, Pendahuluan untuk detail implementasi di Pendahuluan, API Kunci untuk detail implementasi di API Kunci, dan Perangkat untuk detail implementasi di Perangkat.