Fungsi dan Pengaturan

Konfigurasi Plugin Pembaruan

Lihat Github Baca untuk informasi lebih lanjut. CapacitorUpdater dapat dikonfigurasi dengan pilihan-pilihan berikut:

__CAPGO_KEEP_0__

Prop	Tipe	Deskripsi	Default	Sejak
appReadyTimeout	number	Konfigurasi jumlah milisecond plugin native harus menunggu sebelum menganggap pembaruan ‘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 pembaruan sukses. Tersedia pada Android, iOS, dan Electron.	true
autoUpdate	boolean	Konfigurasi apakah plugin harus menggunakan Auto Update melalui server pembaruan. Tersedia pada Android, iOS, dan Electron.	true
resetWhenUpdate	boolean	Menghapus otomatis bundle sebelumnya yang diunduh ketika bundle aplikasi native yang lebih baru diinstal ke perangkat. Tersedia pada Android, iOS, dan Electron.	true
updateUrl	string	Konfigurasi URL / endpoint ke mana periksa pembaruan dikirim. Tersedia pada Android, iOS, dan Electron.	https://plugin.capgo.app/updates
channelUrl	string	Konfigurasi URL / endpoint untuk operasi saluran. Tersedia pada Android, iOS, dan Electron.	https://plugin.capgo.app/channel_self
statsUrl	string	Konfigurasi URL / endpoint ke mana statistik update dikirim. Tersedia pada Android, iOS, dan Electron. Atur ke "" untuk menonaktifkan 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 diset, plugin akan mendapatkan versi dari native code. Tersedia pada Android, iOS, dan Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Konfigurasi kapan plugin harus mengarahkan update langsung. Hanya untuk mode autoUpdate. Cocok untuk aplikasi kurang dari 10MB dan dengan unggahan dilakukan menggunakan flag —delta. Zip atau aplikasi lebih dari 10MB akan relatif lambat untuk pengguna untuk mengupdate. - false: Tidak pernah melakukan update langsung (gunakan perilaku default: download pada awal, set ketika backgrounded) - atInstall: Lakukan update langsung hanya ketika aplikasi diinstal, diperbarui dari toko, lainnya bertindak seperti directUpdate = false - onLaunch: Lakukan update langsung hanya ketika aplikasi diinstal, diperbarui dari toko atau setelah aplikasi dimatikan, lainnya bertindak seperti directUpdate = false - selalu: Lakukan update langsung dalam kasus sebelumnya (aplikasi diinstal, diperbarui dari toko, setelah aplikasi dimatikan atau aplikasi diaktifkan kembali), tidak pernah bertindak seperti directUpdate = false - true: (depreciated) Sama seperti “selalu” untuk konsistensi ke belakang Tersedia pada Android, iOS, dan Electron.	false	5.1.0
autoSplashscreen	boolean	Mengaktifkan otomatis untuk menyembunyikan layar splashscreen ketika menggunakan directUpdate. 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 directUpdate diatur ke “atInstall”, “always”, atau true. Memerlukan plugin @capacitor/splash-screen yang diinstal dan dikonfigurasi dengan launchAutoHide: false. Memerlukan autoUpdate dan directUpdate untuk diaktifkan. Tersedia pada Android dan iOS.	false	7.6.0
periodCheckDelay	number	Konfigurasi periode menunggu untuk cek pembaruan 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 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.	undefined	4.17.48
localSupaAnon	string	Konfigurasi CLI untuk menggunakan server lokal __CAPGO_KEEP_1__ untuk tes.	undefined	4.17.48
localApi	string	Konfigurasi CLI untuk menggunakan file lokal api untuk tes.	undefined	6.3.3
localApiFiles	string	Configure the CLI to use a local file api for testing.	undefined	6.3.3
allowModifyUrl	boolean	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.	false	5.4.0
defaultChannel	string	__CAPGO_KEEP_0__ untuk penggunaan server lokal untuk tes atau server pembaruan self-hosted.	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 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 keperluan debugging/test.	false	7.5.0

Contoh

Dalam capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000 // (1 second),
      "responseTimeout": 10 // (10 second),
      "autoDeleteFailed": false,
      "autoDeletePrevious": false,
      "autoUpdate": false,
      "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: false,
      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
• Pengenal Tipe

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

Kembali: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

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

Param	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 mengaktifkan pengumpulan statistik.

Param	Tipe	Deskripsi
options	StatsUrl	Mengandung URL untuk mengirimkan statistik.

Sejak: 5.4.0

---

setChannelUrl(…)

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

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

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

Sejak: 5.4.0

---

download(…)

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

Unduh bundle baru dari URL yang disediakan, harus berupa file zip, dengan file di dalamnya atau dengan id unik di dalamnya dengan semua file Anda

Param	Tipe	Deskripsi
options	DownloadOptions	Opsi untuk mengunduh bundle zip baru. Kembali:next(…)

Judul bagian “next(…)” Promise<BundleInfo>

---

Salin ke clipboard

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 yang akan diatur pada aplikasi launch berikutnya. {@link BundleInfo.id}

Kembali: Promise<BundleInfo>

---

set(…)

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

Atur bundle saat ini dan reload aplikasi secara langsung.

Param	Hanya Tipe	Deskripsi
options	BundleId	A {@link BundleId} objek 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 paket yang disimpan.

Param	Hanya Tipe	Deskripsi
options	BundleId	Objek {@link BundleId} yang berisi ID dari sebuah bundle untuk dihapus (perlu diingat, ini adalah ID bundle, BUKAN nama versi) BundleIdObjek yang berisi ID dari sebuah bundle untuk dihapus

---

Daftar (…)

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

Dapatkan semua bundle yang telah diunduh secara lokal di aplikasi Anda

Param	Tipe	Deskripsi
options	ListOptions	Objek {@link ListOptions} list(…)Untuk daftar bundle

Returns: Promise<BundleListResult>

---

reset(…)

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

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

Param	Tipe	Deskripsi
options	ResetOptions	Mengandung {@link ResetOptions.toLastSuccessful}, true kembali ke bundle bawaan dan false akan kembali ke bundle yang berhasil dimuat terakhir kali.

---

current()

current() => Promise<CurrentBundleResult>

Dapatkan 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 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 dibackgrounding atau dihentikan. Untuk kind, nilai harus berupa string tanggal iso8601. Untukkind, nilai harus berupa bilangan bulat dalam satuan milidetik. Untuk date kind, nilai harus berupa nomor versi. Untuk background kind, nilai tidak digunakan. Fungsi ini memiliki perilaku tidak konsisten ketika option kill diaktifkan, sehingga pembaruan akan dijalankan setelah pertama kali aplikasi dihentikan, bukan setelah aplikasi dibackgrounding seperti option lainnya. Hal ini akan diperbaiki dalam rilis mayor berikutnya. nativeVersion Param kill Tipe

Copy to clipboard	Sets a {@link DelayCondition} array containing conditions that the Plugin will use to delay the update. After all conditions are met, the update process will run start again as usual, so update will be installed after a backgrounding or killing the app. For the "kind" field, the value should be an iso8601 date string. For the "kind" field, the value should be a number in milliseconds. For the "kind" field, the value should be the version number. For the "kind" field, the value is not used. The function has inconsistent behavior the option kill do trigger the update after the first kill and not after the next background like other options. This will be fixed in a future major release.	Deskripsi
options	MultiDelayConditions	Mengandung array kondisi {@link MultiDelayConditions} untuk menetapkan

Sejak: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

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

Sejak: 4.0.0

---

Dapatkan Versi Terbaru (…)

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

Dapatkan Bundle Terbaru yang Tersedia dari URL Perbarui

Parameter	Tipe
options	GetLatestOptions

Kembali: Promise<LatestVersion>

Sejak: 4.0.0

---

setChannel(…)

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

Mengatur Saluran untuk Perangkat Ini. Saluran yang diminta harus allow_device_self_set diperlukan untuk ini berfungsi.

Catatan penting:

• Jangan menggunakan metode ini untuk menetapkan saluran pada boot. Gunakan defaultChannel in your Capacitor config instead.
• Saluran publik tidak dapat ditetapkan sendiri.
• Jika saluran ditandai sebagai , panggilan publicakan mengembalikan kesalahan. Untuk menggunakan saluran publik, panggil setChannel() untuk mengetahui saluran mana yang tersedia dan apakah mereka memungkinkan penetapan sendiri. unsetChannel() Gunakan
• untuk mengetahui saluran mana yang tersedia dan apakah mereka memungkinkan penetapan sendiri. listChannels() Jangan gunakan metode ini untuk menetapkan saluran pada boot. Gunakan __CAPGO_KEEP_0__ config

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

Kembali: Promise<ChannelRes>

Sejak: 4.7.0

---

unsetChannel(…)

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

Menghapus pengaturan channel override untuk perangkat ini. Setelah memanggil metode ini, perangkat akan secara otomatis menerima update dari server. saluran publik yang sesuai dengan kondisinya (platform, jenis perangkat, jenis build).

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 setChannel())

Param	Tipe
options	UnsetChannelOptions

Sejak: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Dapatkan saluran untuk perangkat ini

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

• publicJika true, ini adalah saluran default. Anda tidak dapat menugaskan diri sendiri ke saluran ini menggunakan setChannel(). Sebaliknya, jika Anda menghapus penugasan saluran Anda menggunakan unsetChannel()Perangkat akan secara otomatis menerima pembaruan dari saluran publik ini.
• allow_self_set: Jika truesaluran ini dapat diassign secara otomatis. Anda dapat mengassign perangkat secara eksplisit ke saluran ini menggunakanReturns: setChannel().

Sejak: Promise<ListChannelsResult>

setCustomId(…) 7.5.0

---

Judul bagian “setCustomId(…)

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

Param

protectedTokens	Tipe	Deskripsi
options	SetCustomIdOptions	adalah {@link SetCustomIdOptions} ID kustom untuk pengaturan

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>

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

Returns: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

Returns: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Dapatkan status konfigurasi auto update.

Kembali: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Hapus semua listener untuk plugin ini.

Sejak: 1.0.0

---

addListener(‘download’, …)

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

Tetapkan untuk mendengarkan acara unduh bundle di Aplikasi. Mengeluarkan peringatan ketika unduh dimulai, selama proses unduh dan ketika selesai. Mengembalikan semua persentase unduh selama proses unduh

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

Dikembalikan: Promise<PluginListenerHandle>

Sejak: 2.0.11

---

Tambahkan pemanggilan ke ‘tidak perlu diperbarui’, …

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

Dengarkan event tidak perlu diperbarui, berguna ketika Anda ingin memeriksa setiap kali aplikasi diluncurkan

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

Dikembalikan: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

Tambahkan Pemangku Jawab (…)

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

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

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

Kembali: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

Tambahkan Pemangku Jawab (…)

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

Dengarkan event downloadComplete.

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

Dikembalikan: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

Tambahkan pemanggilan ke ‘majorAvailable’, …)

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

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

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

Dikembalikan: Promise<PluginListenerHandle>

Sejak: 2.3.0

---

Tambahkan Pemangku Jawab (…)

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

Dengarkan Event Gagal Update di Aplikasi, Anda akan tahu ketika update gagal diinstal pada aplikasi selanjutnya

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

Mengembalikan: Promise<PluginListenerHandle>

Sejak: 2.3.0

---

Tambahkan Pemangku Jawab (…)

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

Dengarkan Event Gagal Download di Aplikasi, Anda akan tahu ketika pengunduhan bundle gagal

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

Dikembalikan: Promise<PluginListenerHandle>

Sejak: 4.0.0

---

Tambahkan pemanggilan ke ‘appReloaded’, …)

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

Dengarkan event reload aplikasi, biarkan Anda tahu ketika reload telah terjadi

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

Dikembalikan: Promise<PluginListenerHandle>

Sejak: 4.3.0

---

Tambahkan Pemangku Wacana (‘appReady’, …)

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

Dengarkan event siap aplikasi di Aplikasi, biarkan Anda tahu ketika aplikasi siap digunakan

Param	Jenis
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)

Returns: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Dapatkan bundle berikut yang akan digunakan ketika aplikasi di-reload. Returns null jika tidak ada bundle berikut yang ditetapkan.

Returns: 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 goncang

Sejak: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Dapatkan keadaan saat ini dari menu goncang

Kembali: Promise<ShakeMenuEnabled>

Sejak: 7.5.0

---

Interface

HasilSiapAplikasi

Properti	Tipe
bundle	BundleInfo

Informasi Paket

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

URL Perbaruan

Properti	Tipe
url	string

StatsUrl

Prop	Tipe
url	string

ChannelUrl

Prop	Tipe
url	string

DownloadOptions

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

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

Properti	Tipe
id	string

Hasil Daftar Bundle

Properti	Tipe
bundles	BundleInfo[]

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

Prop	Tipe
toLastSuccessful	boolean

Hasil Bundle Saat Ini

Prop	Tipe
bundle	BundleInfo
native	string

__CAPGO_KEEP_0__

Prop	Tipe
delayConditions	DelayCondition[]

Keterlambatan

Prop	Tipe	Deskripsi
kind	DelayUntilNext	Atur kondisi keterlambatan 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

Opsi GetLatest

Properti	Tipe	Deskripsi	Default	Sejak
channel	string	Salah satu saluran untuk mendapatkan versi terbaru untuk Saluran ini harus memungkinkan ‘self_assign’ agar ini dapat berfungsi	undefined	6.8.0

ChannelRes

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

SetChannelOptions

Prop	Tipe
channel	string
triggerAutoUpdate	boolean

__CAPGO_KEEP_0__

Properti	Tipe
triggerAutoUpdate	boolean

Dapatkan Saluran

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

Hasil Daftar Saluran

Properti	Tipe	Deskripsi	Sejak
channels	ChannelInfo[]	Daftar Saluran yang Tersedia	7.5.0

Informasi Saluran

Properti	Tipe	Deskripsi	Sejak
id	string	__CAPGO_KEEP_0__	7.5.0
name	string	__CAPGO_KEEP_0__	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 update dari saluran publik yang sesuai.	7.5.0
allow_self_set	boolean	Jika benar, perangkat dapat menetapkan saluran sendiri secara eksplisit menggunakan setChannel(). Hal ini biasanya digunakan untuk tes beta, tes A/B, atau jalur update opt-in.	7.5.0

__CAPGO_KEEP_0__

__CAPGO_KEEP_1__	__CAPGO_KEEP_2__
customId	string

__CAPGO_KEEP_3__

Properti	Tipe
version	string

ID Perangkat

Properti	Tipe
deviceId	string

Versi Plugin

Tipe	Versi Plugin
version	string

Properti Tipe Aktifkan Perbarui Otomatis

Prop	Tipe
enabled	boolean

Penanganan Plugin

Prop	Tipe
remove	() => Promise<void>

Event Download

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

NoNeedEvent

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

UpdateAvailableEvent

Prop	Tipe	Deskripsi	Sejak
bundle	BundleInfo	__CAPGO_KEEP_0__	4.0.0

Event Pengunduhan Selesai

Properti	Tipe	Deskripsi	Sejak
bundle	BundleInfo	__CAPGO_KEEP_0__	4.0.0

Mengeluarkan peringatan ketika ada update baru tersedia

Prop	Tipe	Deskripsi	Sejak
version	string	Keluar ketika bundel baru utama tersedia.	4.0.0

UpdateFailedEvent

Prop	Tipe	Deskripsi	Sejak
bundle	BundleInfo	Ditampilkan ketika update gagal terinstal.	4.0.0

DownloadFailedEvent

Properti	Tipe	Deskripsi	Sejak
version	string	Ditampilkan ketika download gagal.	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

SetShakeMenuOptions

Properti	Tipe
enabled	boolean

ShakeMenuAktif

Properti	Tipe
enabled	boolean

Alias Tipe

Status Paket

menunggu: Paket sedang menunggu untuk diunduh. downloading: Paket sedang diunduh. success: Paket telah diunduh dan siap untuk dijadikan paket berikutnya. error: Paket gagal diunduh. SET SET as the next bundle. as the next bundle.

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

Tunda Sampai Berikutnya

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