Fungsi dan pengaturan

Konfigurasi Plugin Pembaru

Lihat Github Readme untuk informasi lebih lanjut.

CapacitorUpdater dapat dikonfigurasi dengan opsi berikut:| Prop | Ketik | Deskripsi | Bawaan | Sejak | | ---------------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------- | ------- | | appReadyTimeout | nomor | Konfigurasikan jumlah milidetik yang harus ditunggu oleh plugin asli sebelum mempertimbangkan pembaruan ‘gagal’. Tersedia di Android, iOS, dan Elektron. | 10000 // (10 detik) | | | responseTimeout | nomor | Konfigurasikan jumlah milidetik yang harus ditunggu oleh plugin asli sebelum mempertimbangkan batas waktu API. Tersedia di Android, iOS, dan Elektron. | 20000 // (20 detik) | | | autoDeleteFailed | boolean | Konfigurasikan apakah plugin harus menggunakan penghapusan bundel yang gagal secara otomatis. Tersedia di Android, iOS, dan Eelektron. | benar | | | autoDeletePrevious | boolean | Konfigurasikan apakah plugin harus menggunakan penghapusan otomatis bundel sebelumnya setelah pembaruan berhasil. Tersedia di Android, iOS, dan Elektron. | benar | | | autoUpdate | boolean | Konfigurasikan apakah plugin harus menggunakan Pembaruan Otomatis melalui server pembaruan. Tersedia di Android, iOS, dan Elektron. | benar | | | resetWhenUpdate | boolean | Hapus paket yang diunduh sebelumnya secara otomatis saat paket aplikasi asli yang lebih baru diinstal ke perangkat. Tersedia di Android, iOS, dan Elektron. | benar | | | updateUrl | string | Konfigurasikan URL/titik akhir yang menjadi tujuan pengiriman pemeriksaan pembaruan. Tersedia di Android, iOS, dan Elektron.| https://plugin.capgo.app/updates | | | channelUrl | string | Konfigurasikan URL/titik akhir untuk operasi saluran. Tersedia di Android, iOS, dan Elektron. | https://plugin.capgo.app/channel_self | | | statsUrl | string | Konfigurasikan URL/titik akhir yang menjadi tujuan pengiriman statistik pembaruan. Tersedia di Android, iOS, dan Elektron. Setel ke "" untuk menonaktifkan pelaporan statistik. | https://plugin.capgo.app/stats | | | publicKey | string | Konfigurasikan kunci publik untuk enkripsi pembaruan langsung ujung ke ujung Versi 2. Tersedia di Android, iOS, dan Electron. | tidak terdefinisi | 6.2.0 | | version | string | Konfigurasikan versi aplikasi saat ini. Ini akan digunakan untuk permintaan pembaruan pertama. Jika tidak disetel, plugin akan mendapatkan versi dari kode asli. Tersedia di Android, iOS, dan Elektron.| tidak terdefinisi | 4.17.48 | | directUpdate | boolean | ‘selalu’ | ‘di Instal’ | ‘saat Peluncuran’ | Konfigurasikan kapan plugin harus mengarahkan pembaruan instalasi. Hanya untuk mode pembaruan otomatis. Berfungsi dengan baik untuk aplikasi kurang dari 10MB dan dengan unggahan dilakukan menggunakan tanda —delta. Zip atau aplikasi yang lebih besar dari 10 MB akan relatif lambat bagi pengguna untuk memperbaruinya. - false: Jangan pernah melakukan pembaruan langsung (gunakan perilaku default: unduh di awal, atur saat di latar belakang) - atInstall: Pembaruan langsung hanya ketika aplikasi diinstal, diperbarui dari toko, jika tidak bertindak sebagai directUpdate = false - onLaunch: Pembaruan langsung hanya pada aplikasi yang diinstal, diperbarui dari toko atau setelah aplikasi dimatikan, jika tidak bertindak sebagai directUpdate = false - selalu: Pembaruan langsung dalam semua kasus sebelumnya (aplikasi diinstal, diperbarui dari toko, setelah aplikasi dimatikan atau aplikasi dilanjutkan), tidak pernah bertindak sebagai directUpdate = false - true: (tidak digunakan lagi) Sama seperti “selalu” untuk kompatibilitas mundur Tersedia di Android, iOS, dan Electron. | false | 5.1.0 | | autoSplashscreen | boolean | Secara otomatis menangani penyembunyian splashscreen saat menggunakan directUpdate. Saat diaktifkan, plugin akan secara otomatis menyembunyikan splashscreen setelah pembaruan diterapkan atau ketika tidak diperlukan pembaruan. Hal ini menghilangkan kebutuhan untuk mendengarkan peristiwa appReady secara manual dan memanggil SplashScreen.hide(). Hanya berfungsi jika directUpdate disetel ke “atInstall”, “always”, atau true. Memerlukan plugin @capacitor/splash-screen untuk diinstal dan dikonfigurasi dengan launchAutoHide: false. Memerlukan autoUpdate dan directUpdate untuk diaktifkan. Tersedia di Android dan iOS. | false | 7.6.0 | | periodCheckDelay | nomor | Konfigurasikan periode penundaan untuk pemeriksaan pembaruan periode. unitnya dalam hitungan detik. Tersedia di Android, iOS, dan Elektron. Tidak boleh kurang dari 600 detik (10 menit). | 600 // (10 menit) | | | localS3 | boolean | Konfigurasikan CLI untuk menggunakan server lokal untuk pengujian atau server pembaruan yang dihosting sendiri.| tidak terdefinisi | 4.17.48 | | localHost | string | Konfigurasikan CLI untuk menggunakan server lokal untuk pengujian atau server pembaruan yang dihosting sendiri. | tidak terdefinisi | 4.17.48 | | localWebHost | string | Konfigurasikan CLI untuk menggunakan server lokal untuk pengujian atau server pembaruan yang dihosting sendiri. | tidak terdefinisi | 4.17.48 | | localSupa | string | Konfigurasikan CLI untuk menggunakan server lokal untuk pengujian atau server pembaruan yang dihosting sendiri. | tidak terdefinisi | 4.17.48 | | localSupaAnon | string | Konfigurasikan CLI untuk menggunakan server lokal untuk pengujian.| tidak terdefinisi | 4.17.48 | | localApi | string | Konfigurasikan CLI untuk menggunakan api lokal untuk pengujian. | tidak terdefinisi | 6.3.3 | | localApiFiles | string | Konfigurasikan CLI untuk menggunakan api file lokal untuk pengujian. | tidak terdefinisi | 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. Peka huruf besar-kecil. Pengaturan ini akan mengesampingkan saluran default yang diatur di cloud, namun tetap menghormati penggantian yang dilakukan di cloud. | tidak terdefinisi | 5.5.0 | | appId | string | Konfigurasikan id aplikasi untuk aplikasi di konfigurasi. | tidak terdefinisi | 6.0.0 | | keepUrlPathAfterReload | boolean | Konfigurasikan plugin untuk mempertahankan jalur URL setelah memuat ulang. PERINGATAN: Saat memuat ulang dipicu, ‘window.history’ akan dihapus. | false | 6.8.0 | | disableJSLogging | boolean | Nonaktifkan pencatatan JavaScript pada plugin. jika benar, plugin tidak akan masuk ke konsol JavaScript. hanya log asli yang akan dilakukan | false | 7.3.0 | | shakeMenu | boolean | Aktifkan gerakan goyang untuk menampilkan menu pembaruan untuk tujuan debugging/pengujian | 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(...)](#setel ulang)
• [current()](#saat ini)
• [reload()](#muat ulang)
• setMultiDelay(...)
• [cancelDelay()](#batalkan penundaan)
• getLatest(...)
• setChannel(...)
• [unsetChannel(...)](#saluran tidak disetel)
• getChannel()
• listChannels()
• setCustomId(...)
• getBuiltinVersion()
• getDeviceId()
• getPluginVersion()
• isAutoUpdateEnabled()
• [removeAllListeners()](#hapus semua pendengar)
• addListener('download', ...)
• addListener('noNeedUpdate', ...)
• addListener('updateAvailable', ...)
• addListener('downloadComplete', ...)
• addListener('majorAvailable', ...)
• addListener('updateFailed', ...)
• addListener('downloadFailed', ...)
• addListener('appReloaded', ...)
• addListener('appReady', ...)
• isAutoUpdateAvailable()
• [getNextBundle()](#dapatkanbundel berikutnya)
• setShakeMenu(...)
• isShakeMenuEnabled()
• Antarmuka
• Ketik Alias

Metode

beri tahuAppReady()

notifyAppReady() => Promise<AppReadyResult>

Beri tahu Capacitor Pembaru bahwa paket saat ini berfungsi (pengembalian akan terjadi jika metode ini tidak dipanggil pada setiap peluncuran aplikasi) Secara default, metode ini harus dipanggil dalam 10 detik pertama setelah peluncuran aplikasi, jika tidak, rollback akan terjadi. Ubah perilaku ini dengan {@link appReadyTimeout}

Pengembalian: Janji<AppReadyResult>

---

setUpdateUrl(…)

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

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

Param	Ketik	Deskripsi
options	PerbaruiUrl	berisi URL yang digunakan untuk memeriksa pembaruan.

Sejak: 5.4.0

---

setStatsUrl(…)

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

Atur statsUrl untuk aplikasi, ini akan digunakan untuk mengirim statistik. Melewati string kosong akan menonaktifkan pengumpulan statistik.| Param | Ketik | Deskripsi | | ------------- | --------------------------------------------- | ----------------------------------------------- | | options | StatsUrl | berisi URL yang digunakan untuk mengirim statistik. |

Sejak: 5.4.0

---

setChannelUrl(…)

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

Atur channelUrl untuk aplikasi, ini akan digunakan untuk mengatur saluran.

Param	Ketik	Deskripsi
options	SaluranUrl	berisi URL yang akan digunakan untuk menyetel saluran.

Sejak: 5.4.0

---

unduh(…)

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

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

Param	Ketik	Deskripsi
options	UnduhOpsi	{@link DownloadOptions} untuk mendownload zip paket baru.

Pengembalian: Janji<BundleInfo>

---

selanjutnya(…)

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

Atur paket berikutnya untuk digunakan saat aplikasi dimuat ulang.

Param	Ketik	Deskripsi
options	BundleId	Berisi ID Bundel berikutnya yang akan ditetapkan pada peluncuran aplikasi berikutnya. {@link BundleInfo.id}

Pengembalian: Janji<BundleInfo>

---

mengatur(…)

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

Atur paket saat ini dan segera muat ulang aplikasi.| Param | Ketik | Deskripsi | | ------------- | --------------------------------------------- | ---------------------------------------------------------------------------------- | | options | BundleId | Objek {@link BundleId} yang berisi id paket baru untuk ditetapkan sebagai yang terbaru. |

---

hapus(…)

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

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

Param	Ketik	Deskripsi
options	BundleId	Objek {@link BundleId} berisi ID paket yang akan dihapus (perhatikan, ini adalah id paket, BUKAN nama versi)

---

daftar(…)

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

Dapatkan semua bundel yang diunduh secara lokal di aplikasi Anda

Param	Ketik	Deskripsi
options	Opsi Daftar	{@link ListOptions} untuk mencantumkan paket

Pengembalian: Janji<BundleListResult>

---

setel ulang(…)

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

Setel ulang aplikasi ke paket builtin (yang dikirim ke Apple App Store / Google Play Store ) atau paket terakhir yang berhasil dimuat.

Param	Ketik	Deskripsi
options	ResetOptions	Berisi {@link ResetOptions.toLastSuccessful}, true disetel ulang ke paket bawaan dan false akan disetel ulang ke paket terakhir yang berhasil dimuat.

---

saat ini()

current() => Promise<CurrentBundleResult>
```Dapatkan bundel saat ini, jika tidak ada yang disetel, ia akan mengembalikan `builtin`. currentNative adalah bundel asli yang diinstal pada perangkat

**Pengembalian:** <code>Janji<<a href="#currentbundleresult">CurrentBundleResult</a>></code>

--------------------


## muat ulang()

```typescript
reload() => Promise<void>

Muat ulang tampilan

---

setMultiDelay(…)

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

Menyetel array {@link DelayCondition} yang berisi ketentuan yang akan digunakan Plugin untuk menunda pembaruan. Setelah semua kondisi terpenuhi, proses update akan berjalan kembali seperti biasa, sehingga update akan diinstal setelah aplikasi di-background atau dimatikan. Untuk jenis date, nilainya harus berupa string tanggal iso8601. Untuk jenis background, nilainya harus berupa angka dalam milidetik. Untuk jenis nativeVersion, nilainya harus berupa nomor versi. Untuk jenis kill, nilainya tidak digunakan. Fungsi ini memiliki perilaku yang tidak konsisten, opsi kill memicu pembaruan setelah kill pertama dan bukan setelah latar belakang berikutnya seperti opsi lainnya. Ini akan diperbaiki dalam rilis besar mendatang.

Param	Ketik	Deskripsi
options	Kondisi MultiDelay	Berisi rangkaian kondisi {@link MultiDelayConditions} yang akan disetel

Sejak: 4.3.0

---

batalkan Penundaan()

cancelDelay() => Promise<void>

Membatalkan {@link DelayCondition} untuk segera memproses pembaruan.

Sejak: 4.0.0

---

dapatkanTerbaru(…)

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

Dapatkan bundel terbaru yang tersedia dari URL pembaruan

Param	Ketik
options	DapatkanOpsi Terbaru

Pengembalian: Janji<Versi Terbaru>

Sejak: 4.0.0

---

setSaluran(…)

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

Menyetel saluran untuk perangkat ini. Saluran harus mengaktifkan allow_device_self_set agar dapat berfungsi.Catatan penting:

• Jangan gunakan metode ini untuk mengatur saluran saat boot. Gunakan defaultChannel di konfigurasi Capacitor Anda.
• Metode ini dimaksudkan untuk digunakan setelah aplikasi siap dan pengguna berinteraksi (misalnya, ikut serta dalam program beta).
• Saluran publik tidak dapat ditetapkan sendiri. Jika saluran ditandai sebagai public, memanggil setChannel() akan menghasilkan kesalahan. Untuk menggunakan saluran publik, hubungi unsetChannel() - perangkat akan otomatis kembali ke saluran publik yang cocok.
• Gunakan listChannels() untuk mengetahui saluran mana yang tersedia dan apakah saluran tersebut mengizinkan penetapan mandiri.

Param	Ketik	Deskripsi
options	Set ChannelOptions	Apakah saluran {@link SetChannelOptions} disetel

Pengembalian: Janji<ChannelRes>

Sejak: 4.7.0

---

tidak disetelSaluran(…)

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

Batalkan setelan penggantian saluran untuk perangkat ini. Setelah memanggil metode ini, perangkat akan otomatis menerima pembaruan dari saluran publik yang sesuai dengan kondisinya (platform, jenis perangkat, jenis build).

Ini berguna ketika:

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

Param	Ketik
options	Batalkan Opsi Saluran

Sejak: 4.7.0

---

dapatkanSaluran()

getChannel() => Promise<GetChannelRes>

Dapatkan saluran untuk perangkat ini

Pengembalian: Janji<GetChannelRes>

Sejak: 4.8.0

---

daftarSaluran()

listChannels() => Promise<ListChannelsResult>

Daftar semua saluran yang tersedia untuk perangkat ini. Mengembalikan saluran yang kompatibel dengan lingkungan perangkat saat ini (platform, emulator/perangkat nyata, build dev/prod) dan bersifat publik atau mengizinkan penetapan mandiri.

Setiap saluran dalam hasilnya meliputi:

• public: Jika true, ini adalah saluran default. Anda tidak dapat menetapkannya sendiri menggunakan setChannel(). Sebaliknya, jika Anda menghapus penetapan saluran menggunakan unsetChannel(), perangkat akan otomatis menerima pembaruan dari saluran publik ini.
• allow_self_set: Jika true, ini adalah saluran yang dapat ditetapkan sendiri. Anda dapat secara eksplisit menetapkan perangkat ke saluran ini menggunakan setChannel().

Pengembalian: Janji<ListChannelsResult>

Sejak: 7.5.0

---

setCustomId(…)

setCustomId(options: SetCustomIdOptions) => Promise<void>
```Tetapkan ID khusus untuk perangkat ini

| Param | Ketik | Deskripsi |
| ------------- | -------------------------------------------------- | ----------------------------------------------------------------------------------- |
| **`options`** | <code><a href="#setcustomidoptions">SetCustomIdOptions</a></code> | apakah {@link <a href="#setcustomidoptions">SetCustomIdOptions</a>} customId akan disetel |

**Sejak:** 4.9.0

--------------------


## getBuiltinVersion()

```typescript
getBuiltinVersion() => Promise<BuiltinVersion>

Dapatkan versi aplikasi asli atau versi bawaan jika disetel di konfigurasi

Pengembalian: Janji<BuiltinVersion>

Sejak: 5.2.0

---

dapatkanIdPerangkat()

getDeviceId() => Promise<DeviceId>

Dapatkan ID unik yang digunakan untuk mengidentifikasi perangkat (dikirim ke server pembaruan otomatis)

Pengembalian: Janji<DeviceId>

---

dapatkanVersi Plugin()

getPluginVersion() => Promise<PluginVersion>

Dapatkan versi plugin Updater Capacitor asli (dikirim ke server pembaruan otomatis)

Pengembalian: Janji<Versi Plugin>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Dapatkan status konfigurasi pembaruan otomatis.

Pengembalian: Janji<AutoUpdateEnabled>

---

hapusSemua Pendengar()

removeAllListeners() => Promise<void>

Hapus semua pendengar untuk plugin ini.

Sejak: 1.0.0

---

addListener(‘unduh’, …)

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

Dengarkan acara pengunduhan bundel di Aplikasi. Diaktifkan setelah pengunduhan dimulai, selama pengunduhan, dan setelah selesai. Ini akan mengembalikan Anda semua persentase unduhan selama pengunduhan

Param	Ketik
eventName	’unduh’
listenerFunc	(negara bagian: DownloadEvent) => void

Pengembalian: Janji<PluginListenerHandle>

Sejak: 2.0.11

---

addListener(‘tidak Perlu Pembaruan’, …)

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

Dengarkan tanpa perlu memperbarui acara, berguna saat Anda ingin memeriksa paksa setiap kali aplikasi diluncurkan

Param	Ketik
eventName	’tidak Perlu Pembaruan’
listenerFunc	(negara bagian: NoNeedEvent) => void

Sejak: 4.0.0

---

addListener(‘updateTersedia’, …)

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

Dengarkan acara pembaruan yang tersedia, berguna ketika Anda ingin memaksa pemeriksaan setiap kali aplikasi diluncurkan

Param	Ketik
eventName	’pembaruanTersedia’
listenerFunc	(negara bagian: UpdateAvailableEvent) => void

Pengembalian: Janji<PluginListenerHandle>

Sejak: 4.0.0

---

addListener(‘unduhSelesai’, …)

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

Dengarkan untuk mengunduh acara Lengkap.

Param	Ketik
eventName	’unduhSelesai’
listenerFunc	(negara bagian: DownloadCompleteEvent) => void

Pengembalian: Janji<PluginListenerHandle>

Sejak: 4.0.0

---

addListener(‘MajorAvailable’, …)

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

Dengarkan acara pembaruan besar di Aplikasi, beri tahu Anda ketika pembaruan besar diblokir dengan mengatur nonaktifkanAutoUpdateBreaking

Param	Ketik
eventName	’majorAvailable’
listenerFunc	(negara bagian: MajorAvailableEvent) => void

Pengembalian: Janji<PluginListenerHandle>

Sejak: 2.3.0

---

addListener(‘updateGagal’, …)

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

Dengarkan peristiwa kegagalan pembaruan di Aplikasi, beri tahu Anda ketika pembaruan gagal dipasang pada permulaan aplikasi berikutnya

Param	Ketik
eventName	’pembaruanGagal’
listenerFunc	(negara bagian: UpdateFailedEvent) => void

Sejak: 2.3.0

---

addListener(‘unduhGagal’, …)

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

Dengarkan peristiwa kegagalan pengunduhan di Aplikasi, beri tahu Anda ketika pengunduhan bundel gagal

Param	Ketik
eventName	’unduhGagal’
listenerFunc	(negara bagian: DownloadFailedEvent) => void

Pengembalian: Janji<PluginListenerHandle>

Sejak: 4.0.0

---

addListener(‘aplikasiDimuat Ulang’, …)

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

Dengarkan acara muat ulang di Aplikasi, beri tahu Anda saat memuat ulang telah terjadi

Param	Ketik
eventName	’aplikasi Dimuat Ulang’
listenerFunc	() => batal

Pengembalian: Janji<PluginListenerHandle>

Sejak: 4.3.0

---

addListener(‘aplikasiSiap’, …)

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

Dengarkan acara aplikasi siap di Aplikasi, beri tahu Anda saat aplikasi siap digunakan

Param	Ketik
eventName	’aplikasiSiap’
listenerFunc	(negara bagian: AppReadyEvent) => void

Pengembalian: Janji<PluginListenerHandle>

Sejak: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Dapatkan jika pembaruan otomatis tersedia (tidak dinonaktifkan oleh serverUrl).

Pengembalian: Janji<Pembaruan OtomatisTersedia>

---

dapatkanBundleBerikutnya()

getNextBundle() => Promise<BundleInfo | null>

Dapatkan bundel berikutnya yang akan digunakan saat aplikasi dimuat ulang. Mengembalikan null jika tidak ada bundel berikutnya yang disetel.

Pengembalian: Janji<BundleInfo | batal>

Sejak: 6.8.0

---

setShakeMenu(…)

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

Mengaktifkan atau menonaktifkan menu goyang untuk tujuan debugging/pengujian| Param | Ketik | Deskripsi | | ------------- | ------------------------------------------------------------------- | -------------------------------------------------------- | | options | SetShakeMenuOptions | Berisi boolean yang diaktifkan untuk mengaktifkan atau menonaktifkan menu goyang |

Sejak: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Dapatkan status menu goyang saat ini

Pengembalian: Janji<ShakeMenuEnabled>

Sejak: 7.5.0

---

Antarmuka

Hasil AppReady

Prop	Ketik
bundle	Info Paket

Info Paket

Prop	Ketik
id	string
version	string
downloaded	string
checksum	string
status	Status Paket

PerbaruiUrl

Prop	Ketik
url	string

StatistikUrl

Prop	Ketik
url	string

SaluranUrl

Prop	Ketik
url	string

Opsi Unduhan

URL dan versi ini digunakan untuk mengunduh bundel dari server, Jika Anda menggunakan backend semua informasi akan diberikan melalui metode getLatest. Jika Anda tidak menggunakan backend, Anda perlu memberikan URL dan versi paket. Checksum dan sessionKey diperlukan jika Anda mengenkripsi bundel dengan perintah CLI mengenkripsi, Anda akan menerimanya sebagai hasil dari perintah tersebut.| Prop | Ketik | Deskripsi | Bawaan | Sejak | | ---------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | ----- | | url | string | URL file zip bundel (misalnya: dist.zip) yang akan diunduh. (Ini bisa berupa URL apa pun. Misalnya: Amazon S3, tag GitHub, tempat lain tempat Anda menghosting paket Anda.) | | | | version | string | Kode versi/nama bundel/versi ini | | | | sessionKey | string | Kunci sesi untuk pembaruan, ketika bundel dienkripsi dengan kunci sesi | tidak terdefinisi | 4.0.0 | | checksum | string | Checksum untuk pembaruan, harus dalam sha256 dan dienkripsi dengan kunci pribadi jika bundel dienkripsi | tidak terdefinisi | 4.0.0 | | manifest | ManifestEntry[] | Manifes untuk unduhan multi-file Delta (manifest) | tidak terdefinisi | 6.1.0 |

Entri Manifes

Prop	Ketik
file_name	string | null
file_hash	string | null
download_url	string | null

BundelId

Prop	Ketik
id	string

Hasil Daftar Bundel

Prop	Ketik
bundles	Info Paket[]

Opsi Daftar| Prop | Ketik | Deskripsi | Bawaan | Sejak |

| --------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ---- | ------ | | raw | boolean | Apakah akan mengembalikan daftar paket mentah atau manifes. Jika benar, daftar tersebut akan mencoba membaca database internal, bukan file di disk. | false | 6.14.0 |

Opsi Reset

Prop	Ketik
toLastSuccessful	boolean

Hasil Bundel Saat Ini

Prop	Ketik
bundle	Info Paket
native	string

Kondisi MultiDelay

Prop	Ketik
delayConditions	Kondisi Penundaan[]

Kondisi Penundaan

Prop	Ketik	Deskripsi
kind	Tunda Hingga Berikutnya	Atur kondisi penundaan di setMultiDelay
value	string

Versi Terbaru| Prop | Ketik | 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 | ManifestEntri[] | | 6.1 |

Dapatkan Opsi Terbaru

Prop	Ketik	Deskripsi	Bawaan	Sejak
channel	string	Saluran untuk mendapatkan versi terbaru Saluran harus mengizinkan ‘self_assign’ agar ini berfungsi	tidak terdefinisi	6.8.0

Res Saluran

Prop	Ketik	Deskripsi	Sejak
status	string	Status saluran yang disetel saat ini	4.7.0
error	string
message	string

Setel Opsi Saluran

Prop	Ketik
channel	string
triggerAutoUpdate	boolean

Batalkan Penyetelan Opsi Saluran

Prop	Ketik
triggerAutoUpdate	boolean

Dapatkan ChannelRes| Prop | Ketik | Deskripsi | Sejak |

| -------------- | -------------------- | ----------------------------- | ----- | | channel | string | Status saluran dapatkan saat ini | 4.8.0 | | error | string | | | | message | string | | | | status | string | | | | allowSet | boolean | | |

DaftarSaluranHasil

Prop	Ketik	Deskripsi	Sejak
channels	Info Saluran[]	Daftar saluran yang tersedia	7.5.0

Info Saluran

Prop	Ketik	Deskripsi	Sejak
id	string	ID saluran	7.5.0
name	string	Nama saluran	7.5.0
public	boolean	Jika benar, ini adalah saluran default/fallback. Perangkat tidak dapat menetapkan sendiri ke saluran publik. Sebaliknya, ketika perangkat menghapus penggantian salurannya (menggunakan unsetChannel()), perangkat akan secara otomatis menerima pembaruan dari saluran publik yang cocok.	7.5.0
allow_self_set	boolean	Jika benar, perangkat dapat secara eksplisit menetapkan sendiri saluran ini menggunakan setChannel(). Ini biasanya digunakan untuk pengujian beta, pengujian A/B, atau jalur pembaruan keikutsertaan.	7.5.0

SetelOpsiIdKustom

Prop	Ketik
customId	string

Versi Bawaan

Prop	Ketik
version	string

ID Perangkat

Prop	Ketik
deviceId	string

Versi Plugin

Prop	Ketik
version	string

Pembaruan Otomatis Diaktifkan

Prop	Ketik
enabled	boolean

PluginListenerHandle

Prop	Ketik
remove	() => Janji

Unduh Acara| Prop | Ketik | Deskripsi | Sejak |

| ------------ | ---------------------------------- | ------------------------------------- | ----- | | bundle | Info Paket | Dipancarkan saat aplikasi siap digunakan. | 5.2.0 | | status | string | | |

Pembaruan Otomatis Tersedia

Prop	Ketik
available	boolean

SetelShakeMenuOptions

Prop	Ketik
enabled	boolean

ShakeMenu Diaktifkan

Prop	Ketik
enabled	boolean

Ketik Alias

Status Paket

tertunda: Paket tertunda untuk dijadikan SET sebagai paket berikutnya. mengunduh: Bundel sedang diunduh. sukses: Bundel telah diunduh dan siap SET sebagai bundel berikutnya. kesalahan: Bundel gagal diunduh.

‘sukses’ | ‘kesalahan’ | ‘menunggu keputusan’ | ‘mengunduh’

Tunda Hingga Berikutnya

‘latar belakang’ | ‘membunuh’ | ‘Versi asli’ | ‘tanggal’