기능 및 설정

Konfigurasi Plugin Updater

Lihat Readme Github untuk informasi lebih lanjut

CapacitorUpdater dapat dikonfigurasi dengan opsi berikut:

Prop	Type	Deskripsi	Default	Sejak
appReadyTimeout	number	Mengatur jumlah milidetik plugin native harus menunggu sebelum menganggap pembaruan ‘gagal’ Hanya tersedia untuk Android dan iOS	10000 // (10 detik)
responseTimeout	number	Mengatur jumlah milidetik plugin native harus menunggu sebelum menganggap API timeout Hanya tersedia untuk Android dan iOS	20 // (20 detik)
autoDeleteFailed	boolean	Mengatur apakah plugin harus secara otomatis menghapus bundle yang gagal Hanya tersedia untuk Android dan iOS	true
autoDeletePrevious	boolean	Mengatur apakah plugin harus secara otomatis menghapus bundle sebelumnya setelah pembaruan berhasil Hanya tersedia untuk Android dan iOS	true
autoUpdate	boolean	Mengatur apakah plugin harus menggunakan Pembaruan Otomatis melalui server pembaruan Hanya tersedia untuk Android dan iOS	true
resetWhenUpdate	boolean	Secara otomatis menghapus bundle yang telah diunduh sebelumnya ketika bundle aplikasi native yang lebih baru diinstal ke perangkat Hanya tersedia untuk Android dan iOS	true
updateUrl	string	Mengatur URL / endpoint ke mana pemeriksaan pembaruan dikirim Hanya tersedia untuk Android dan iOS	https://plugincapgoapp/updates
channelUrl	string	Mengatur URL / endpoint untuk operasi channel Hanya tersedia untuk Android dan iOS	https://plugincapgoapp/channel_self
statsUrl	string	Mengatur URL / endpoint ke mana statistik pembaruan dikirim Hanya tersedia untuk Android dan iOS Atur ke "" untuk menonaktifkan pelaporan statistik	https://plugincapgoapp/stats
privateKey	string	Mengatur kunci pribadi untuk enkripsi pembaruan langsung end to end Hanya tersedia untuk Android dan iOS Tidak digunakan lagi di versi 620 akan dihapus di versi 700	undefined
publicKey	string	Mengatur kunci publik untuk enkripsi pembaruan langsung end to end Versi 2 Hanya tersedia untuk Android dan iOS	undefined	620
version	string	Mengatur versi saat ini dari aplikasi Ini akan digunakan untuk permintaan pembaruan pertama Jika tidak diatur, plugin akan mendapatkan versi dari kode native Hanya untuk Android dan iOS	undefined	41748
directUpdate	boolean	Membuat plugin langsung menginstal pembaruan ketika aplikasi baru saja diperbarui/diinstal Hanya untuk mode autoUpdate Hanya tersedia untuk Android dan iOS	undefined	510
periodCheckDelay	number	Mengatur delay periode untuk pemeriksaan pembaruan berkala dalam satuan detik Hanya tersedia untuk Android dan iOS Tidak boleh kurang dari 600 detik (10 menit)	600 // (10 menit)
localS3	boolean	Mengatur CLI untuk menggunakan server lokal untuk pengujian atau server pembaruan self-hosted	undefined	41748
localHost	string	Mengatur CLI untuk menggunakan server lokal untuk pengujian atau server pembaruan self-hosted	undefined	41748
localWebHost	string	Mengatur CLI untuk menggunakan server lokal untuk pengujian atau server pembaruan self-hosted	undefined	41748
localSupa	string	Mengatur CLI untuk menggunakan server lokal untuk pengujian atau server pembaruan self-hosted	undefined	41748
localSupaAnon	string	Mengatur CLI untuk menggunakan server lokal untuk pengujian	undefined	41748
localApi	string	Mengatur CLI untuk menggunakan api lokal untuk pengujian	undefined	633
localApiFiles	string	Mengatur CLI untuk menggunakan api file lokal untuk pengujian	undefined	633
allowModifyUrl	boolean	Mengizinkan plugin untuk memodifikasi updateUrl, statsUrl dan channelUrl secara dinamis dari sisi JavaScript	false	540
defaultChannel	string	Mengatur channel default untuk aplikasi dalam konfigurasi	undefined	550
appId	string	Mengkonfigurasi id aplikasi untuk aplikasi dalam konfigurasi	undefined	600
keepUrlPathAfterReload	boolean	Mengkonfigurasi plugin untuk mempertahankan path URL setelah reload PERINGATAN: Ketika reload dipicu, ‘windowhistory’ akan dihapus	false	680

Contoh

Dalam capacitorconfigjson:

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000 // (1 detik),
      "responseTimeout": 10 // (10 detik),
      "autoDeleteFailed": false,
      "autoDeletePrevious": false,
      "autoUpdate": false,
      "resetWhenUpdate": false,
      "updateUrl": https://examplecom/api/auto_update,
      "channelUrl": https://examplecom/api/channel,
      "statsUrl": https://examplecom/api/stats,
      "privateKey": undefined,
      "publicKey": undefined,
      "version": undefined,
      "directUpdate": 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
    }
  }
}

Dalam capacitorconfigts:

/// <reference types="@capgo/capacitor-updater" />

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      appReadyTimeout: 1000 // (1 detik),
      responseTimeout: 10 // (10 detik),
      autoDeleteFailed: false,
      autoDeletePrevious: false,
      autoUpdate: false,
      resetWhenUpdate: false,
      updateUrl: https://examplecom/api/auto_update,
      channelUrl: https://examplecom/api/channel,
      statsUrl: https://examplecom/api/stats,
      privateKey: undefined,
      publicKey: undefined,
      version: undefined,
      directUpdate: 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,
    },
  },
};

export default config;

• notifyAppReady()
• setUpdateUrl()
• setStatsUrl()
• setChannelUrl()
• download()
• next()
• set()
• delete()
• list()
• reset()
• current()
• reload()
• setMultiDelay()
• cancelDelay()
• getLatest()
• setChannel()
• unsetChannel()
• getChannel()
• 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()
• Interfaces
• Type Aliases

Methods

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Memberi tahu Capacitor Updater bahwa bundle saat ini berjalan (rollback 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}

Returns: Promise<AppReadyResult>

---

setUpdateUrl()

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

Mengatur updateUrl untuk aplikasi, ini akan digunakan untuk memeriksa pembaruan

Param	Type	Description
options	UpdateUrl	berisi URL yang digunakan untuk memeriksa pembaruan

Since: 540

---

setStatsUrl()

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

Mengatur statsUrl untuk aplikasi, ini akan digunakan untuk mengirim statistik. Memberikan string kosong akan menonaktifkan pengumpulan statistik

Param	Type	Description
options	StatsUrl	berisi URL yang digunakan untuk mengirim statistik

Since: 540

---

setChannelUrl()

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

Mengatur channelUrl untuk aplikasi, ini akan digunakan untuk mengatur channel

Param	Type	Description
options	ChannelUrl	berisi URL yang digunakan untuk mengatur channel

Since: 540

---

download()

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

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

Param	Type	Description
options	DownloadOptions	The {@link DownloadOptions} untuk mengunduh zip bundle baru

Returns: Promise<BundleInfo>

---

next()

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

Mengatur bundle berikutnya yang akan digunakan ketika aplikasi dimuat ulang| Param | Type | Description | | ------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | | options | BundleId | Berisi ID Bundle berikutnya untuk diatur pada peluncuran aplikasi selanjutnya {@link BundleInfoid} |

Returns: Promise<BundleInfo>

---

set()

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

Mengatur bundle saat ini dan segera memuat ulang aplikasi

Param	Type	Description
options	BundleId	Objek {@link BundleId} berisi id bundle baru yang akan diatur sebagai saat ini

---

delete()

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

Menghapus bundle yang ditentukan dari penyimpanan aplikasi native. Gunakan bersama {@link list} untuk mendapatkan ID Bundle yang tersimpan

Param	Type	Description
options	BundleId	Objek {@link BundleId} berisi ID bundle yang akan dihapus (catatan, ini adalah id bundle, BUKAN nama versi)

---

list()

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

Dapatkan semua bundle yang telah diunduh secara lokal di aplikasi Anda

Param	Type	Description
options	ListOptions	{@link ListOptions} untuk daftar bundle

Returns: Promise<BundleListResult>

---

reset()

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

Mengatur ulang aplikasi ke bundle ‘builtin’ (yang dikirim ke Apple App Store / Google Play Store) atau bundle yang terakhir berhasil dimuat

Param	Type	Description
options	ResetOptions	Berisi {@link ResetOptionstoLastSuccessful}, ‘true’ mengatur ulang ke bundle builtin dan ‘false’ akan mengatur ulang ke bundle terakhir yang berhasil dimuat

---

current()

current() => Promise<CurrentBundleResult>

Dapatkan bundle saat ini, jika tidak ada yang diatur maka akan mengembalikan ‘builtin’ currentNative adalah bundle asli yang diinstal pada perangkat

Returns: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Memuat ulang tampilan

---

setMultiDelay()

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

Mengatur array {@link DelayCondition} yang berisi kondisi yang akan digunakan Plugin untuk menunda pembaruan Setelah semua kondisi terpenuhi, proses pembaruan akan berjalan kembali seperti biasa, jadi pembaruan akan diinstal setelah aplikasi masuk ke background atau dimatikan Untuk jenis ‘date’, nilai harus berupa string tanggal iso8601 Untuk jenis ‘background’, nilai harus berupa angka dalam milidetik Untuk jenis ‘nativeVersion’, nilai harus berupa nomor versi Untuk jenis ‘kill’, nilai tidak digunakan Fungsi ini memiliki perilaku yang tidak konsisten, opsi kill memicu pembaruan setelah kill pertama dan tidak setelah background berikutnya seperti opsi lainnya. Ini akan diperbaiki dalam rilis utama mendatang

Param	Type	Description
options	MultiDelayConditions	Berisi array {@link MultiDelayConditions} kondisi yang akan diatur

Since: 430

---

cancelDelay()

cancelDelay() => Promise<void>

Membatalkan {@link DelayCondition} untuk memproses pembaruan segera

Since: 400

---

getLatest()

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

Dapatkan bundle terbaru yang tersedia dari URL pembaruan

Param	Type
options	GetLatestOptions

Returns: Promise<LatestVersion>

Since: 400

---

setChannel()

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

Mengatur channel untuk perangkat ini. Channel harus mengizinkan pengaturan sendiri agar ini berfungsi Jangan gunakan metode ini untuk mengatur channel saat boot ketika ‘autoUpdate’ diaktifkan di {@link PluginsConfig} Metode ini untuk mengatur channel setelah aplikasi siap Metode ini mengirim permintaan ke backend Capgo untuk menghubungkan ID perangkat ke channel. Capgo dapat menerima atau menolak tergantung pengaturan channel Anda

Param	Type	Description
options	SetChannelOptions	Adalah {@link SetChannelOptions} channel yang akan diatur

Returns: Promise<ChannelRes>

Since: 470

---

unsetChannel()

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

Menghapus pengaturan channel untuk perangkat iniPerangkat akan kembali ke channel default

Param	Type
options	UnsetChannelOptions

Since: 470

---

getChannel()

getChannel() => Promise<GetChannelRes>

Dapatkan channel untuk perangkat ini

Returns: Promise<GetChannelRes>

Since: 480

---

setCustomId()

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

Atur ID kustom untuk perangkat ini

Param	Type	Description
options	SetCustomIdOptions	adalah {@link SetCustomIdOptions} customId untuk diatur

Since: 490

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Dapatkan versi aplikasi native atau versi builtin jika diatur dalam konfigurasi

Returns: Promise<BuiltinVersion>

Since: 520

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

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

Returns: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

Returns: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Dapatkan status konfigurasi pembaruan otomatis

Returns: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Hapus semua listener untuk plugin ini

Since: 100

---

addListener(‘download’, )

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

Mendengarkan event pengunduhan bundle dalam Aplikasi. Aktif saat pengunduhan dimulai, selama mengunduh dan saat selesai

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

Returns: Promise<PluginListenerHandle>

Since: 2011

---

addListener(‘noNeedUpdate’, )

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

Mendengarkan event tidak perlu pembaruan, berguna ketika Anda ingin memaksa pemeriksaan setiap kali aplikasi diluncurkan

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

Returns: Promise<PluginListenerHandle>

Since: 400

---

addListener(‘updateAvailable’, )

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

Mendengarkan event pembaruan tersedia, berguna ketika Anda ingin memaksa pemeriksaan setiap kali aplikasi diluncurkan

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

Returns: Promise<PluginListenerHandle>

Since: 400

---

addListener(‘downloadComplete’, )

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

Mendengarkan event downloadComplete

Param	Type
eventName	’downloadComplete’
listenerFunc	(state: DownloadCompleteEvent) => void

Returns: Promise<PluginListenerHandle>

Since: 400

---

addListener(‘majorAvailable’, )

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

Mendengarkan event pembaruan Major dalam Aplikasi, memberi tahu Anda ketika pembaruan major diblokir oleh pengaturan disableAutoUpdateBreaking

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

Returns: Promise<PluginListenerHandle>

Since: 230

---

addListener(‘updateFailed’, )

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

Mendengarkan event kegagalan pembaruan dalam Aplikasi, memberi tahu Anda ketika pembaruan gagal diinstal saat aplikasi berikutnya dimulai

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

Returns: Promise<PluginListenerHandle>

Since: 230

---

addListener(‘downloadFailed’,)

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

Dengarkan event kegagalan unduhan di App, memberi tahu Anda ketika unduhan bundle gagal

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

Returns: Promise<PluginListenerHandle>

Since: 400

---

addListener(‘appReloaded’, )

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

Dengarkan event reload di App, memberi tahu Anda ketika reload terjadi

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

Returns: Promise<PluginListenerHandle>

Since: 430

---

addListener(‘appReady’, )

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

Dengarkan event app ready di App, memberi tahu Anda ketika app siap digunakan

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

Returns: Promise<PluginListenerHandle>

Since: 510

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Dapatkan apakah pembaruan otomatis tersedia (tidak dinonaktifkan oleh serverUrl)

Returns: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Dapatkan bundle selanjutnya yang akan digunakan ketika aplikasi dimuat ulang Mengembalikan null jika tidak ada bundle selanjutnya yang diatur

Returns: Promise<BundleInfo | null>

Since: 680

---

Interfaces

AppReadyResult

Prop	Type
bundle	BundleInfo

BundleInfo

Prop	Type
id	string
version	string
downloaded	string
checksum	string
status	BundleStatus

UpdateUrl

Prop	Type
url	string

StatsUrl

Prop	Type
url	string

ChannelUrl

Prop	Type
url	string

DownloadOptions

Prop	Type	Deskripsi	Default	Since
url	string	URL file zip bundle (misalnya: distzip) yang akan diunduh (Ini bisa berupa URL apa saja Misalnya: Amazon S3, tag GitHub, tempat lain dimana Anda meng-host bundle Anda)
version	string	Kode/nama versi dari bundle/versi ini
sessionKey	string	Kunci sesi untuk pembaruan	undefined	400
checksum	string	Checksum untuk pembaruan	undefined	400

BundleId

Prop	Type
id	string

BundleListResult

Prop	Type
bundles	BundleInfo[]

ListOptions

Prop	Type	Deskripsi	Default	Since
raw	boolean	Apakah akan mengembalikan daftar bundle mentah atau manifest Jika benar, daftar akan mencoba membaca database internal alih-alih file di disk	false	6140

ResetOptions

Prop	Type
toLastSuccessful	boolean

CurrentBundleResult

Prop	Type
bundle	BundleInfo
native	string

MultiDelayConditions

Prop	Type
delayConditions	DelayCondition[]

DelayCondition

Prop	Type	Deskripsi
kind	DelayUntilNext	Atur kondisi delay di setMultiDelay
value	string

LatestVersion

Prop	Type	Deskripsi	Since
version	string	Hasil dari metode getLatest	400
checksum	string		6
major	boolean
message	string
sessionKey	string
error	string
old	string
url	string
manifest	ManifestEntry[]		61

ManifestEntry

Prop	Type
file_name	string | null
file_hash	string | null
download_url	string | null

GetLatestOptions

Prop	Type	Deskripsi	Default	Sejak
channel	string	Channel untuk mendapatkan versi terbaru. Channel harus mengizinkan ‘self_assign’ agar ini berfungsi	undefined	680

ChannelRes

Prop	Type	Deskripsi	Sejak
status	string	Status saat ini dari channel yang diatur	470
error	string
message	string

SetChannelOptions

Prop	Type
channel	string
triggerAutoUpdate	boolean

UnsetChannelOptions

Prop	Type
triggerAutoUpdate	boolean

GetChannelRes

Prop	Type	Deskripsi	Sejak
channel	string	Status saat ini dari channel yang didapat	480
error	string
message	string
status	string
allowSet	boolean

SetCustomIdOptions

Prop	Type
customId	string

BuiltinVersion

Prop	Type
version	string

DeviceId

Prop	Type
deviceId	string

PluginVersion

Prop	Type
version	string

AutoUpdateEnabled

Prop	Type
enabled	boolean

PluginListenerHandle

Prop	Type
remove	() => Promise<void>

DownloadEvent

Prop	Type	Deskripsi	Sejak
percent	number	Status unduhan saat ini, antara 0 dan 100	400
bundle	BundleInfo

NoNeedEvent

Prop	Type	Deskripsi	Sejak
bundle	BundleInfo	Status unduhan saat ini, antara 0 dan 100	400

UpdateAvailableEvent

Prop	Type	Deskripsi	Sejak
bundle	BundleInfo	Status unduhan saat ini, antara 0 dan 100	400

DownloadCompleteEvent

Prop	Type	Deskripsi	Sejak
bundle	BundleInfo	Muncul ketika pembaruan baru tersedia	400

MajorAvailableEvent

Prop	Type	Deskripsi	Sejak
version	string	Muncul ketika bundle major baru tersedia	400

UpdateFailedEvent

Prop	Type	Deskripsi	Sejak
bundle	BundleInfo	Muncul ketika pembaruan gagal diinstal	400

DownloadFailedEvent

Prop	Type	Deskripsi	Sejak
version	string	Muncul ketika unduhan gagal	400

AppReadyEvent

Prop	Type	Deskripsi	Sejak
bundle	BundleInfo	Muncul ketika aplikasi siap digunakan	520
status	string

AutoUpdateAvailable

Prop	Type
available	boolean

Type Aliases

BundleStatus

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

DelayUntilNext

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