Fungsi dan Pengaturan

Bagian berjudul “Konfigurasi Plugin Pembarui”

See the Github Panduan 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 update gagal. Tersedia pada Android, iOS, dan Electron.	10000 // (10 seconds)
responseTimeout	number	Configure the number of milliseconds the native plugin should wait before considering API timeout. Available on Android, iOS, and Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Konfigurasi apakah plugin harus menggunakan otomatis menghapus bundle 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 terapkan ketika aplikasi berpindah ke latar belakang - atInstall: Terapkan secara langsung setelah instalasi baru atau update aplikasi native, kecuali menggunakan atBackground - onLaunch: Terapkan secara langsung pada saat aplikasi dibuka, kecuali menggunakan atBackground setelah periksa - always: Terapkan secara langsung ketika Auto Update berjalan - onlyDownload: Periksa dan download secara otomatis, emit updateAvailable, dan tidak menetapkan bundle berikut secara otomatis. Tersedia pada Android, iOS, dan Electron.	”atBackground” // true is still accepted
resetWhenUpdate	boolean	Membersihkan bundle yang telah diunduh sebelumnya secara otomatis ketika bundle aplikasi native yang lebih baru diinstal ke perangkat. Tersedia pada Android, iOS, dan Electron.	true
updateUrl	string	Konfigurasi URL / endpoint ke mana periksa update 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 update dikirimkan. Tersedia pada Android, iOS, dan Electron. Atur ke "" untuk menghentikan pelaporan statistik.	https://plugin.capgo.app/stats
publicKey	string	Konfigurasi kunci publik untuk enkripsi update hidup akhir-ke-akhir. Versi 2. Tersedia pada Android, iOS, dan Electron.	undefined	6.2.0
version	string	Konfigurasi versi aplikasi saat ini. Ini akan digunakan untuk permintaan update pertama. Jika tidak diatur, plugin akan mendapatkan versi dari native code. Tersedia pada Android, iOS, dan Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Depreciasi. Gunakan mode string autoUpdate: “atInstall”, “onLaunch”, atau “always” saja. Opsi ini tetap mendukung untuk aplikasi yang sudah ada. - false: Tidak pernah melakukan update langsung - atInstall: Sama seperti autoUpdate: “atInstall” - onLaunch: Sama seperti autoUpdate: “onLaunch” - always: Sama seperti autoUpdate: “always” - true: Sama seperti “always” untuk konsistensi ke belakang. Tersedia pada Android, iOS, dan Electron.	false	5.1.0
autoSplashscreen	boolean	Mengaktifkan otomatis menyembunyikan layar splashscreen ketika menggunakan mode aplikasi instan. 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 berlaku 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 cek 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 tes atau server pembaruan self-hosted.	undefined	4.17.48
localHost	string	Mengatur CLI untuk menggunakan server lokal untuk tes atau server pembaruan self-hosted.	undefined	4.17.48
localWebHost	string	Mengatur CLI untuk menggunakan server lokal untuk tes atau server pembaruan self-hosted.	undefined	4.17.48
localSupa	string	Mengatur CLI untuk menggunakan server lokal untuk tes atau server pembaruan self-hosted.	undefined	4.17.48
localSupaAnon	string	Mengatur CLI untuk menggunakan server lokal untuk tes.	undefined	4.17.48
localApi	string	Mengatur CLI untuk menggunakan server lokal api untuk tes.	undefined	6.3.3
localApiFiles	string	Mengatur 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	Set konfigurasi default untuk aplikasi di dalam konfigurasi. Case sensitive. Pengaturan ini akan menggantikan saluran default yang telah ditetapkan di awan, tetapi masih akan menghormati pengaturan yang telah dibuat di awan.	undefined	5.5.0
appId	string	Konfigurasi ID aplikasi untuk aplikasi di dalam konfigurasi.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Konfigurasi plugin untuk menjaga URL path setelah reload. PERINGATAN: Ketika reload diaktifkan, ‘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

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()
• Antarmuka
• Jenis Alias

Metode

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

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

Kembali: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

Tetapkan URL pembarui untuk aplikasi, URL ini akan digunakan untuk memeriksa pembarui.

Parameter	Tipe	Deskripsi
options	UpdateUrl	mengandung URL untuk memeriksa pembaruan.

Sejak: 5.4.0

---

setStatsUrl(…)

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

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

Parameter	Tipe	Deskripsi
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 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 download {@link} DownloadOptions} untuk mengunduh bundle zip baru.

Hasil pengembalian: Promise<BundleInfo>

---

next(…)

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

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

Param	Tipe	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	Tipe	Deskripsi
options	BundleId	Sebuah {@link} BundleId} object yang berisi ID paket baru untuk ditetapkan sebagai paket saat ini.

---

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.

Parameter	Tipe	Deskripsi
options	BundleId	A {@link} ID Paket} object yang berisi ID dari sebuah paket untuk dihapus (perlu diingat, ini adalah ID paket, BUKAN nama versi)

---

list(…)

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

Dapatkan semua paket yang telah diunduh secara lokal di aplikasi Anda

Param	Tipe	Deskripsi
options	ListOptions	The {@link} Opsi Daftar} untuk menampilkan paket

Kembali: Promise<BundleListResult>

---

reset(…)

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

Mengatur ulang aplikasi ke builtin Paket (paket yang dikirim ke Apple App Store / Google Play Store ) atau paket 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.

---

current()

current() => Promise<CurrentBundleResult>

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

Kembali: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Muat ulang tampilan

---

setMultiDelay(…)

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

Mengatur array {@link} Kondisi Tunda} date Mengatur array Kondisi Tunda yang akan digunakan 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 kind, nilai harus berupa string tanggal iso8601. Untuk nativeVersion kind, nilai harus berupa bilangan bulat dalam milidetik. Untuk kill kind, nilai harus berupa nomor versi. Untuk

kind, nilai tidak digunakan. Fungsi ini memiliki perilaku tidak konsisten dengan opsi kill yang akan memicu pembaruan setelah pembunuhan pertama dan tidak setelah pembunuhan berikutnya seperti opsi lainnya. Hal 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 kondisi {@link DelayCondition} untuk memproses pembaruan segera.

Sejak: 4.0.0

---

getLatest(…)

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

Dapatkan bundle terbaru yang tersedia dari URL update

Param	Jenis
options	GetLatestOptions

Mengembalikan: Promise<LatestVersion>

Sejak: 4.0.0

---

setChannel(…)

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

Menetapkan saluran lokal yang diatur oleh plugin untuk perangkat ini. Saluran harus allow_device_self_set harus diaktifkan agar 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 in your Capacitor config instead.
• Saluran publik tidak dapat ditetapkan secara mandiri.
• Jika saluran ditandai sebagai panggil publicakan mengembalikan kesalahan. Untuk menggunakan saluran publik, panggil setChannel() sebaliknya - perangkat akan secara otomatis kembali ke saluran publik yang sesuai. unsetChannel() sebaliknya - perangkat akan secara otomatis kembali ke saluran publik yang sesuai.
• Menggunakan listChannels() untuk mengetahui mana-mana saluran yang tersedia dan apakah mereka memungkinkan pengaturan sendiri.

Param	Tipe	Deskripsi
options	SetChannelOptions	Apakah saluran {@link} SetChannelOptions} untuk mengatur saluran

Kembali: Promise<ChannelRes>

Sejak: 4.7.0

---

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()tidak menghapus catatan pengaturan perangkat untuk Dashboard atau Publik API.

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

Berikut ini beberapa contoh penggunaan:

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

Parameter	Jenis
options	UnsetChannelOptions

Sejak: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Get the channel for this device

Dikembalikan: Promise<GetChannelRes>

Sejak: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

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

Masing-masing channel dalam hasilnya termasuk:

• public: Jika true, ini adalah channel defaultKamu tidak dapat menetapkan diri sendiri ke dalamnya menggunakan setChannel()Namun, jika kamu menghapus penugasan kanal kamu menggunakan unsetChannel(), perangkat akan secara otomatis menerima pembaruan dari kanal publik ini.
• allow_self_set, jika true, ini adalah salah satu kanal yang dapat ditetapkan sendiriKamu dapat menetapkan perangkat secara eksplisit ke dalam kanal ini menggunakan setChannel().

Mengembalikan: Promise<ListChannelsResult>

Sejak: 7.5.0

---

setCustomId(…)

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

Set ID khusus untuk perangkat ini

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

Sejak: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

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

Mengembalikan: Promise<BuiltinVersion>

Sejak: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

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

Mengembalikan: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Peroleh 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 proses unduh dimulai, selama proses unduh berlangsung 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

---

Tambahkan Listener(‘tidak Perlu Update’, …)

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

Hasil pengembalian: Promise<PluginListenerHandle>

Mulai dari: 4.0.0

---

Tambahkan penggunaan (‘majorAvailable’, …)

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

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

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

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 telah gagal

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

Kembali: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

Tambahkan penggunaan: (‘appReloaded’, …)

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

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

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

Mengembalikan: Promise<PluginListenerHandle>

Sejak: 4.3.0

---

tambahkanPengguna('siap', …)

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

---

isiAutoUpdateTersedia()

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 keperluan debugging/testng

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

Sejak: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

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

Properti	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 yang Anda host 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[]

Pilihan Daftar

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

Kondisi Pengunduran

Properti	Jenis
delayConditions	DelayCondition[]

Kondisi Pengunduran

Jenis	Deskripsi	Kondisi Pengunduran Berulang
kind	DelayUntilNext	Konfigurasi 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 bekerja	undefined	6.8.0

ChannelRes

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

Melepaskan Opsi Channel

Properti	Tipe
triggerAutoUpdate	boolean

Respon Channel

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 penetapan saluran override (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()Saluran ini. Hal ini biasanya digunakan untuk tes beta, tes A/B, atau jalur pembaruan opt-in.	7.5.0

Komando saluran menggunakan saluran nameID Saluran Angka id.

SetCustomIdOptions

Properti	Jenis
customId	string

Versi Bawaan

Properti	Jenis
version	string

ID Perangkat

Properti	Jenis
deviceId	string

Versi Plugin

Properti	Jenis
version	string

Perbarui Otomatis Aktif

Properti	Jenis
enabled	boolean

Handle Pengguna Plugin

Properti	Jenis
remove	() => Promise<void>

Event Download

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

Judul Bagian “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	Terjadi ketika ada update baru tersedia.	4.0.0

MajorAvailableEvent

Prop	Jenis	Deskripsi	Sejak
version	string	Terjadi ketika ada bundle baru tersedia.	4.0.0

UpdateFailedEvent

Properti	Jenis	Deskripsi	Sejak
bundle	BundleInfo	Keluaran ketika pembaruan gagal terpasang.	4.0.0

DownloadFailedEvent

Properti	Jenis	Deskripsi	Sejak
version	string	Keluaran 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

Properti	Jenis
enabled	boolean

ShakeMenuDiperbolehkan

Properti	Jenis
enabled	boolean

Alias Jenis

Status Paket

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

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

ATUR

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

error: Bundle gagal untuk diunduh.

Bab berjudul “Mundur Sampai Berikutnya” Teruskan dari Fungsi dan Pengaturan to plan dashboard and API operations, connect it with Jika Anda menggunakan Fungsi dan Pengaturan untuk merencanakan dashboard dan capgo operasi, hubungkannya dengan Fungsi dan Pengaturan @capgo/capacitor-updater untuk kemampuan kemampuan asli dalam Menggunakan @capgo/capacitor-updater, API Ringkasan untuk detail implementasi dalam API Ringkasan, Pendahuluan untuk detail implementasi dalam Pendahuluan, API Kunci untuk detail implementasi dalam API Kunci, dan Perangkat untuk detail implementasi dalam Perangkat.