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 mempertimbangkan pembaruan ‘gagal’. Tersedia pada Android, iOS, dan Electron.	10000 // (10 seconds)
responseTimeout	number	Konfigurasi jumlah milisecond plugin native harus menunggu sebelum mempertimbangkan API 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 bagaimana 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, lainnya gunakan atBackground - onLaunch: Terapkan segera pada saat aplikasi diluncurkan, lainnya gunakan atBackground setelah pengecekan peluncuran - selalu: Terapkan segera ketika Auto Update berjalan - hanyaDownload: 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 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 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 menghentikan laporan 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 yang lebih baru: “atInstall”, “onLaunch”, atau “always”. 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	Mengatur otomatis untuk menyembunyikan layar splashscreen ketika menggunakan mode aplikasi instant. Ketika diaktifkan, plugin akan secara otomatis menyembunyikan 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	Mengatur periode waktu untuk memeriksa pembaruan secara berkala. Satuan waktu dalam detik. Tersedia pada Android, iOS, dan Electron. Tidak dapat kurang dari 600 detik (10 menit).	600 // (10 minutes)
localS3	boolean	Mengatur CLI untuk menggunakan server lokal untuk pengujian atau server pembaruan self-hosted.	undefined	4.17.48
localHost	string	Mengatur CLI untuk menggunakan server lokal untuk pengujian atau server pembaruan self-hosted.	undefined	4.17.48
localWebHost	string	Mengatur CLI untuk menggunakan server lokal untuk pengujian atau server pembaruan self-hosted.	undefined	4.17.48
localSupa	string	Mengatur CLI untuk menggunakan server lokal untuk pengujian atau server pembaruan self-hosted.	undefined	4.17.48
localSupaAnon	string	Mengatur CLI untuk menggunakan server lokal untuk pengujian.	undefined	4.17.48
localApi	string	Mengatur CLI untuk menggunakan server lokal api untuk pengujian.	undefined	6.3.3
localApiFiles	string	Mengatur CLI untuk menggunakan file lokal api untuk pengujian.	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	Set konfigurasi default untuk saluran aplikasi. 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	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
• Jenis Alias

Metode

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Peringatkan Capacitor Pembarui 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 akan terjadi rollback. Ubah perilaku ini dengan {@link appReadyTimeout}

Kembali: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

Tetapkan 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>

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

Param	Jenis	Deskripsi
options	ChannelUrl	mengandung URL untuk digunakan untuk menetapkan channel.

Sejak: 5.4.0

---

download(…)

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

Mengunduh 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	Jenis	Deskripsi
options	DownloadOptions	Opsi pengunduhan {@link DownloadOptions} untuk mengunduh sebuah bundle zip.

Hasil pengembalian: Promise<BundleInfo>

---

next (…)

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

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

Param	Jenis	Deskripsi
options	BundleId	Mengandung ID bundle berikutnya yang akan 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	Jenis	Deskripsi
options	BundleId	Sebuah {@link} ID Paket}

---

…

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

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

Parameter	Jenis	Deskripsi
options	BundleId	A {@link} BundleId} object 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	Jenis	Deskripsi
options	ListOptions	The {@link} ListOption} untuk menampilkan bundle

Kembali: 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 berhasil 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 kali.

---

current()

current() => Promise<CurrentBundleResult>

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

Hasil Pengembalian: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Muat ulang tampilan

---

setMultiDelay(…)

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

Mengatur array {@link} Kondisi Tunda} date Mengatur array Kondisi Tunda yang digunakan oleh Plugin untuk menunda pembaruan. Setelah semua kondisi terpenuhi, proses pembaruan akan berjalan lagi seperti biasa, sehingga pembaruan akan diinstal setelah aplikasi di background atau dibunuh. Untuk background nilai harus berupa string tanggal iso8601. Untuk nativeVersion nilai harus berupa bilangan bulat dalam milidetik. Untuk kill nilai harus berupa nomor versi. Untuk

nilai tidak digunakan. Fungsi ini memiliki perilaku tidak konsisten dengan opsi kill yang akan menimbulkan pembaruan setelah pembunuhan pertama dan tidak setelah pembunuhan berikutnya seperti opsi lainnya. Ini akan diperbaiki dalam rilis mayor masa depan.	Menggunakan	Deskripsi
options	MultiDelayConditions	Mengandung array kondisi {@link MultiDelayConditions} untuk menetapkan

Menggunakan 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 dari URL Perbarui

Param	Jenis
options	GetLatestOptions

Mengembalikan: Promise<LatestVersion>

Sejak: 4.0.0

---

setChannel(…)

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

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

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, memilih program beta).
• Saluran publik tidak dapat ditetapkan sendiri. Jika saluran telah public, memanggil setChannel() akan mengembalikan kesalahan. Untuk menggunakan saluran publik, panggil unsetChannel() sebaliknya - perangkat akan secara otomatis kembali ke saluran publik yang sesuai.
• Menggunakan listChannels() untuk mengetahui mana saja saluran yang tersedia dan apakah mereka memungkinkan pengaturan sendiri.

Merekan	Tipe	Deskripsi
options	SetChannelOptions	Apakah channel {@link} Mengatur channel dengan menggunakan Mengembalikan:

Mulai dari: Promise<ChannelRes>

unsetChannel(…) 4.7.0

---

Bagian berjudul “unsetChannel(…)

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

Batalkan saluran lokal yang diatur oleh plugin untuk perangkat ini. Ini hanya menghapus saluran yang disimpan secara lokal oleh setChannel(); it does not delete Dashboard or Public API Device Override records.

After calling this method, normal channel precedence applies: an existing Dashboard or Public API Device Override still wins; otherwise the device can fall back to the matching public/default channel for its conditions (platform, device type, build type).

Sejak:

• getChannel()
• Bab berjudul “getChannel()” setChannel())

Setelah memanggil metode ini, urutan saluran normal berlaku: saluran Dashboard atau Publik yang ada masih menang; jika tidak, perangkat dapat kembali ke saluran publik/default yang sesuai dengan kondisinya (platform, jenis perangkat, jenis konstruksi).	Metode ini berguna ketika:
options	UnsetChannelOptions

Ini berguna ketika Anda ingin memindahkan perangkat ke jalur pembaruan default 4.7.0

---

Ini berguna ketika Anda ingin menggunakan saluran publik (karena saluran publik tidak dapat ditetapkan sendiri melalui

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. 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 bawaan __CAPGO_KEEP_0__. 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>

Since: 7.5.0

---

setCustomId(…)

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

Set ID khusus untuk perangkat ini

Param	Jenis	Deskripsi
options	SetCustomIdOptions	adalah {@link} SetCustomIdOptions} ID khusus untuk diatur

Sejak: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

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

Mengembalikan: Promise<BuiltinVersion>

Sejak: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

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

Mengembalikan: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

Mengembalikan: Promise<PluginVersion>

---

Mengaktifkan Otonomi Perbarui()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Mendapatkan status konfigurasi perbarui otomatis.

Mengembalikan: Promise<AutoUpdateEnabled>

---

Menghapus semua pendengar.

removeAllListeners() => Promise<void>

Menghapus semua pendengar untuk plugin ini.

Sejak: 1.0.0

---

Mengaktifkan pendengar(‘download’, …)

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

Dengarkan event unduh bundle di Aplikasi. Mengeluarkan panggilan sekali ketika unduh dimulai, selama proses unduh dan ketika selesai. Fungsi ini akan mengembalikan persentase unduh selama proses unduh

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

Kembali: Promise<PluginListenerHandle>

Sejak: 2.0.11

---

addListener(‘tidakPerluUpdate’, …)

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

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

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

Mengembalikan: 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	Jenis
eventName	’updateAvailable’
listenerFunc	(state: UpdateAvailableEvent) => void

Mengembalikan: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

addListener(‘downloadComplete’, …)

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

Dengarkan event download selesai.

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>

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

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

Mengembalikan: Promise<PluginListenerHandle>

Sejak: 2.3.0

---

addListener(‘gagal_update’, …)

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

Dengarkan event gagal update di Aplikasi, memungkinkan Anda mengetahui ketika update gagal terpasang di aplikasi selanjutnya

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

Mengembalikan: Promise<PluginListenerHandle>

Sejak: 2.3.0

---

addListener(‘gagal_download’, …)

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

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

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

Kembali: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

Tambahkan pengguna (‘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

Mengembalikan: Promise<PluginListenerHandle>

Sejak: 4.3.0

---

addListener(‘appReady’, …)

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

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

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

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

Mengaktifkan atau menonaktifkan menu goncang untuk tujuan debugging/pengujian

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

Sejak: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Mendapatkan status saat ini dari menu goncang

Mengembalikan: Promise<ShakeMenuEnabled>

Sejak: 7.5.0

---

Antarmuka

Hasil Siap Aplikasi

Properti	Jenis
bundle	BundleInfo

Info Paket

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

URL Perbarui

Properti	Jenis
url	string

URL Statistik

Properti	Jenis
url	string

URL Saluran

Properti	Jenis
url	string

Pilihan 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 menyediakan URL dan versi bundle. SessionKey diperlukan jika Anda mengenkripsi bundle dengan perintah CLI encrypt, Anda harus menerima mereka sebagai hasil perintah.

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

ManifestEntry

Properti	Jenis
file_name	string | null
file_hash	string | null
download_url	string | null

ID Paket

Properti	Jenis
id	string

Hasil Daftar Paket

Jenis	Opsi Daftar
bundles	BundleInfo[]

Paket

Properti	Tipe	Deskripsi	Nilai 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

Hasil Bundle Saat Ini

Properti	Jenis
bundle	BundleInfo
native	string

KondisiTundaMulti

Properti	Jenis
delayConditions	DelayCondition[]

KondisiTunda

Properti	Jenis	Deskripsi
kind	DelayUntilNext	Atur kondisi penundaan 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

GetLatestOptions

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

ChannelRes

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

SetChannelOptions

Properti	Tipe
channel	string
triggerAutoUpdate	boolean

MelepaskanChannelOptions

Properti	Tipe
triggerAutoUpdate	boolean

ResponChannel

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

ListChannelsResult

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

ChannelInfo

Prop	Tipe	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 pengaturan saluran yang ditetapkan sendiri (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 angka id.

Opsi Pengaturan ID Kustom

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

Penanganan Plugin

Tipe	Event Download
remove	() => Promise<void>

Event Pengunduhan

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

Judul Bagian berjudul “NoNeedEvent”

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

UpdateAvailableEvent

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 pembaruan baru tersedia.	4.0.0

MajorAvailableEvent

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

UpdateFailedEvent

Properti	Tipe	Deskripsi	Sejak
bundle	BundleInfo	Dikirim ketika update gagal terpasang.	4.0.0

DownloadFailedEvent

Properti	Tipe	Deskripsi	Sejak
version	string	Dikirim ketika download gagal.	4.0.0

Event Siap Aplikasi

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

Tersedia Perbarui Otomatis

Properti	Tipe
available	boolean

SetOpsi Menu Guncang

Prop	Tipe
enabled	boolean

ShakeMenuEnabled

Prop	Tipe
enabled	boolean

Alias Tipe

Status Paket

menunggu: Paket menunggu untuk di- ATUR menjadi bundle berikutnya. mengunduh: Bundle sedang diunduh. sukses: Bundle telah diunduh dan siap untuk di

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

ATUR

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

Tunggu Sampai Berikutnya

Lanjutkan dari Fungsi dan Pengaturan Judul Bagian “Lanjutkan dari Fungsi dan Pengaturan” to plan dashboard and API operations, connect it with Fungsi dan Pengaturan untuk merencanakan dashboard dan capgo operasi, hubungkan dengan menggunakan @capgo/capacitor-updater untuk kemampuan asli di Menggunakan @capgo/capacitor-pembarui, API Ringkasan untuk detail implementasi di API Ringkasan, Pendahuluan untuk detail implementasi di Pendahuluan, API Kunci untuk detail implementasi di API Kunci, dan Perangkat untuk detail implementasi di Perangkat.