Fungsi dan Pengaturan

Konfigurasi Plugin Pengatur Perbarui

Lihat Github Dokumen Readme untuk informasi lebih lanjut.

CapacitorUpdater dapat dikonfigurasi dengan pilihan-pilihan berikut:

Properti	Tipe	Deskripsi	Default	Sejak
appReadyTimeout	number	Konfigurasi jumlah milidetik plugin native harus menunggu sebelum memandang pembaruan ‘gagal’. Tersedia pada Android, iOS, dan Electron.	10000 // (10 seconds)
responseTimeout	number	Konfigurasi jumlah milidetik plugin native harus menunggu sebelum memandang 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 update sukses. Tersedia pada Android, iOS, dan Electron.	true
autoUpdate	boolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’	Konfigurasi bagaimana plugin harus 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 segera setelah instalasi baru atau update aplikasi native, kecuali gunakan atBackground - onLaunch: Terapkan segera pada saat aplikasi dibuka, kecuali gunakan atBackground setelah periksa - always: Terapkan 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 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 kanal. 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 menghapus laporan statistik.	https://plugin.capgo.app/stats
publicKey	string	Konfigurasi kunci publik untuk enkripsi pembaruan hidup ke akhir ke 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”. Opsi ini tetap mendukung untuk 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	Atur otomatis menyembunyikan layar splashscreen ketika menggunakan mode aplikasi instant. Ketika diaktifkan, plugin akan menyembunyikan layar splashscreen secara otomatis setelah pembaruan diterapkan atau ketika tidak ada pembaruan yang diperlukan. Ini menghilangkan kebutuhan untuk mendengarkan event appReady dan memanggil SplashScreen.hide(). Hanya berlaku ketika autoUpdate diatur ke “atInstall”, “onLaunch”, atau “always”. Nilai lama directUpdate masih mendukung untuk konsistensi ke belakang. Memerlukan plugin @capacitor/splash-screen yang sudah terinstal 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 pembaruan periodik. Satuan waktu dalam detik. Tidak dapat kurang dari 600 detik (10 menit). Tersedia pada Android, iOS, dan Electron.	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	Configure the CLI to use a local api for testing.	undefined	6.3.3
localApiFiles	string	Konfigurasi CLI untuk menggunakan file lokal api untuk tes.	undefined	6.3.3
allowModifyUrl	boolean	Izinkan plugin untuk mengubah updateUrl, statsUrl, dan channelUrl secara dinamis dari sisi JavaScript.	false	5.4.0
defaultChannel	string	Tetapkan saluran default untuk aplikasi di konfigurasi. Case sensitive. Pengaturan ini akan menggantikan saluran default yang ditetapkan di awan, tetapi akan tetap 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 dilakukan, ‘window.history’ akan dihapus.	false	6.8.0
disableJSLogging	boolean	Nonaktifkan logging JavaScript plugin. Jika true, plugin tidak akan mencetak ke konsol JavaScript. Hanya log native yang akan dilakukan.	false	7.3.0
shakeMenu	boolean	Aktifkan gerakan goncangan 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>

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

Kembali: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

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

Param	Jenis	Pengertian
options	UpdateUrl	mengandung URL yang digunakan untuk memeriksa pembarui.

Sejak: 5.4.0

---

setStatsUrl(…)

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

Atur URL statistik untuk aplikasi, URL ini akan digunakan untuk mengirimkan statistik. Mengirimkan string kosong akan mengaktifkan pengumpulan statistik.

Param	Tipe	Deskripsi
options	StatsUrl	berisi URL yang digunakan untuk mengirimkan statistik.

Sejak: 5.4.0

---

setChannelUrl(…)

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

Atur channelUrl 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 diberikan, harus berupa file zip, dengan file di dalamnya atau dengan id unik di dalamnya dengan semua file Anda

Param	Tipe	Deskripsi
options	DownloadOptions	The {@link DownloadOptions} untuk mengunduh sebuah zip bundle baru.

Kembali: Promise<BundleInfo>

---

next(…)

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

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

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

Kembali: Promise<BundleInfo>

---

set(…)

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

Atur bundle saat ini dan muat ulang aplikasi secara langsung.

Param	Tipe	Deskripsi
options	BundleId	A {@link ID PaketObjek { } 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.

Param	Jenis	Pengertian
options	BundleId	Objek { @link ID Paket} yang berisi ID paket untuk dihapus (perlu diingat, ini adalah ID paket, BUKAN nama versi)

---

Daftar (…)

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

Dapatkan semua bundle yang diunduh secara lokal di aplikasi Anda

Param	Tipe	Deskripsi
options	ListOptions	Opsi untuk menampilkan daftar bundle Kembali:reset(…)

Opsi untuk menampilkan daftar bundle Promise<BundleListResult>

---

Opsi untuk menampilkan daftar bundle

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

Reset 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 mengatur ulang ke bundle bawaan dan false akan mengatur ulang ke bundle terakhir yang berhasil dimuat.

---

current()

current() => Promise<CurrentBundleResult>

Ambil 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

---

setMultiDelay(…)

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

Mengatur sebuah array {@link DelayCondition} yang 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 dihentikan. Untuk jenis, nilai harus berupa string tanggal iso8601. Untuk jenis, nilai harus berupa angka dalam satuan milisecond. Untuk jenis, nilai harus berupa nomor versi. Untuk jenis, nilai tidak digunakan. Fungsi ini memiliki perilaku tidak konsisten, option kill akan memicu pembaruan setelah kill pertama dan tidak setelah background berikutnya seperti option lainnya. Ini akan diperbaiki di rilis mayor masa depan. ParamTipe date Deskripsi background Mengandung {@link MultiDelayConditions} nativeVersion DelayCondition kill MultiDelayConditions

kind	kind	kind
options	MultiDelayConditions	kind kindarray dari kondisi untuk menetapkan

Sejak: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Membatalkan sebuah {@link Kondisi Delay} untuk memproses pembaruan segera.

Sejak: 4.0.0

---

getLatest(…)

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

Dapatkan Bundle Terbaru tersedia dari URL update

Param	Tipe
options	GetLatestOptions

Dikembalikan: Promise<LatestVersion>

Sejak: 4.0.0

---

setChannel(…)

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

Menetapkan saluran untuk perangkat ini. Saluran harus allow_device_self_set dijalankan untuk ini dapat berfungsi.

Catatan penting:

• Jangan gunakan metode ini untuk menetapkan saluran pada boot. Gunakan defaultChannel dalam konfigurasi Capacitor Anda sebaliknya.
• Metode ini dimaksudkan untuk digunakan setelah aplikasi siap dan pengguna telah berinteraksi (misalnya, memilih program beta).
• Saluran publik tidak dapat ditugaskan sendiri. Jika saluran ditandai sebagai public, panggilan setChannel() akan mengembalikan kesalahan. Untuk menggunakan saluran publik, panggil unsetChannel() sebaliknya - perangkat akan secara otomatis bergabung ke saluran publik yang sesuai.
• Gunakan listChannels() untuk menemukan saluran mana yang tersedia dan apakah mereka memungkinkan penugasan sendiri.

Param	Tipe	Deskripsi
options	SetChannelOptions	Apakah channel {@link SetChannelOptions} untuk diatur

Kembali: Promise<ChannelRes>

Sejak: 4.7.0

---

unsetChannel(…)

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

, , ,

,

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

Param	Tipe
options	UnsetChannelOptions

Sejak: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

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 hasil termasuk:

• public: Jika true, ini adalah saluran default. Anda tidak dapat menugaskan sendiri ke saluran ini menggunakan setChannel(). Sebaliknya, jika Anda menghapus penugasan 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().

Mengembalikan: Promise<ListChannelsResult>

Sejak: 7.5.0

---

setCustomId(…)

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

Set ID kustom untuk perangkat ini

Param	Tipe	Deskripsi
options	SetCustomIdOptions	adalah {@link} SetCustomIdOptions} ID kustom untuk diatur

Since: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Dapatkan versi aplikasi asli atau versi bawaan jika diatur di konfigurasi

Returns: Promise<BuiltinVersion>

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

Kembali: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Dapatkan status konfigurasi auto update

Kembali: Promise<AutoUpdateEnabled>

---

Hapus semua pendengar()

removeAllListeners() => Promise<void>

Hapus semua pendengar untuk plugin ini.

Sejak: 1.0.0

---

Tambahkan pendengar(‘download’, …)

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

Dengarkan event unduh bundle di Aplikasi. Meledak sekali saat unduh dimulai, selama mengunduh dan ketika selesai. Hal ini akan kembali Anda semua persentase unduh selama unduh

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

Kembali: Promise<PluginListenerHandle>

Sejak: 2.0.11

---

addListener(‘noNeedUpdate’, …)

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

---

addListener(‘updateAvailable’, …)

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

Dengarkan event update yang 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>

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

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

Param	Jenis
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 pada aplikasi berikutnya

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

Kembali: Promise<PluginListenerHandle>

Sejak: 2.3.0

---

tambahkanPengguna(‘downloadFailed’, …)

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

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

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

Kembali: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

addListener(‘appReloaded’, …)

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

Tunggu event reload aplikasi, Anda akan tahu ketika reload telah 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. Mengembalikan null jika tidak ada bundle berikutnya yang ditetapkan.

Dikembalikan: Promise<BundleInfo | null>

Sejak: 6.8.0

---

setShakeMenu(…)

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

Aktifkan atau nonaktifkan menu guncang untuk keperluan debugging/testing

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

Sejak: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Dapatkan keadaan saat ini dari menu guncang

Mengembalikan: Promise<ShakeMenuEnabled>

Sejak: 7.5.0

---

Interface

Hasil Siap Aplikasi

Sifat	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

ChannelUrl

Properti	Tipe
url	string

Opsi Download

URL ini dan versi digunakan untuk mengunduh bundle dari server. Jika Anda menggunakan backend, semua informasi akan diberikan oleh metode getLatest. Jika Anda tidak menggunakan backend, Anda perlu 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	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 telah menghosting bundle Anda.)
version	string	Versi code/nama dari bundle ini/versi
sessionKey	string	Kunci sesi untuk update, ketika bundle dienkripsi dengan kunci sesi	undefined	4.0.0
checksum	string	Checksum untuk update, harus dalam sha256 dan dienkripsi dengan kunci pribadi jika bundle dienkripsi	undefined	4.0.0
manifest	ManifestEntry[]	Manifest untuk Delta (manifest) download berkas multi-file	undefined	6.1.0

ManifestEntry

Prop	Tipe
file_name	string | null
file_hash	string | null
download_url	string | null

BundleId

Prop	Tipe
id	string

BundleListResult

Prop	Tipe
bundles	BundleInfo[]

ListOptions

Prop	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

Pulihkan Opsi

Properti	Tipe
toLastSuccessful	boolean

Hasil Bundle Saat Ini

Properti	Tipe
bundle	BundleInfo
native	string

Kondisi Pengunduran Berulang

Properti	Jenis
delayConditions	DelayCondition[]

Syarat Retardi

Properti	Jenis	Deskripsi
kind	DelayUntilNext	Konfigurasi syarat retardi dalam setMultiDelay
value	string

Versi Terbaru

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

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	Tipe	Deskripsi	Sejak
status	string	Status saat ini setel channel	4.7.0
error	string
message	string

SetChannelOptions

Prop	Tipe
channel	string
triggerAutoUpdate	boolean

UnsetChannelOptions

Properti	Tipe
triggerAutoUpdate	boolean

GetChannelRes

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

ListChannelsResult

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

Info Saluran

Prop	Jenis	Deskripsi	Sejak
id	number	ID Saluran (Nomor)	7.5.0
name	string	Nama Saluran	7.5.0
public	boolean	If true, ini adalah saluran default/fallback. Perangkat tidak dapat menetapkan saluran sendiri ke saluran publik. Sebaliknya, ketika perangkat menghapus pengaturan saluran override-nya (menggunakan unsetChannel()), perangkat akan secara otomatis menerima update dari saluran publik yang sesuai.	7.5.0
allow_self_set	boolean	If true, perangkat dapat menetapkan saluran ini secara eksplisit menggunakan setChannel(). Ini biasanya digunakan untuk tes beta, tes A/B, atau jalur update opt-in.	7.5.0

Saluran perintah menggunakan saluran name, not this numeric id.

, bukan angka

SetCustomIdOptions	Bagian berjudul “SetCustomIdOptions”
customId	string

Prop

Properti	Tipe
version	string

Id Perangkat

Properti	Tipe
deviceId	string

Versi Plugin

Aktifkan Perbarui Otomatis	Bagian berjudul “Aktifkan Perbarui Otomatis”
version	string

__CAPGO_KEEP_0__

Prop	Prop
enabled	boolean

Penanganan Plugin

Prop	Prop
remove	() => Promise<void>

Event Pengunduhan

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

NoNeedEvent

Prop	Type	Deskripsi	Sejak
bundle	BundleInfo	Status download saat ini, antara 0 dan 100.	4.0.0

UpdateAvailableEvent

Prop	Type	Deskripsi	Sejak
bundle	BundleInfo	Status saat ini download, antara 0 dan 100.	4.0.0

DownloadCompleteEvent

Prop	Tipe	Deskripsi	Sejak
bundle	BundleInfo	Keluar ketika ada update baru tersedia.	4.0.0

MajorAvailableEvent

Properti	Tipe	Deskripsi	Sejak
version	string	Dikirimkan ketika sebuah bundle utama baru tersedia.	4.0.0

UpdateFailedEvent

Properti	Tipe	Deskripsi	Sejak
bundle	BundleInfo	Dikirimkan ketika sebuah update gagal untuk diinstal.	4.0.0

Download Failed Event

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

App Ready Event

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

Tersedia Perbarui Otomatis

Properti	Tipe
available	boolean

SetShakeMenuOptions

Properti	Tipe
enabled	boolean

ShakeMenuDiperbolehkan

Prop	Tipe
enabled	boolean

Tipe Alias

Status Paket

menunggu: Paket sedang menunggu untuk di SET sebagai paket selanjutnya. downloading: Paket sedang diunduh. success: Paket telah diunduh dan siap untuk di SET sebagai paket selanjutnya. error: Paket gagal diunduh.

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

Tunda Sampai Paket Selanjutnya

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

Teruskan dari Fungsi dan Pengaturan

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