Reference

API Reference

• reload()
• syncOne(...)
• syncAll(...)
• syncSome(...)
• Interfaces
• Type Aliases

reload()

export const reload = (): Promise<void>

Reload the webview

---

syncOne(...)

export const syncOne = async (options: SyncOneOptions): Promise<SyncResult>

Sync One

Param	Type
options	SyncOneOptions

Returns: Promise<SyncResult>

---

syncAll(...)

export const syncAll = (callback: SyncCallback): void

Sync All

Param	Type
callback	SyncCallback)

---

syncSome(...)

export const syncSome(options: SyncSomeOptions, callback: SyncCallback): void

Sync Some

Param	Type
options	SyncSomeOptions
callback	SyncCallback)

---

Interfaces

SyncResult

Prop	Type
name	string
activeApplicationPathChanged	boolean
source	'download' | 'cache' | undefined
liveUpdate	LiveUpdate | undefined
snapshot	Snapshot | null | undefined
metadata	{ [key: string]: any } | undefined

source, liveUpdate, and snapshot are only populated for an Appflow-backed (liveUpdateConfig) sync. metadata is only populated for a provider-backed (liveUpdateProvider) sync, and only if the provider returns any. See Using a Live Update Provider.

LiveUpdateConfig

Prop	Type
appId	string
channel	string
autoUpdateMethod	AutoUpdateMethod | undefined
maxVersions	number
strategy	'zip' | 'differential'

LiveUpdateProviderConfig

Prop	Type
pluginName	string
config	{ [key: string]: any } | undefined
autoUpdateMethod	AutoUpdateMethod | undefined

See Using a Live Update Provider for how this is used.

LiveUpdateError

Prop	Type
name	string | undefined
failStep	'CHECK' | 'DOWNLOAD' | 'COPY' | 'UNPACK' | 'VERIFY' | 'UPDATE' | 'CANCEL' | 'SYNC'
message	string

Snapshot

Prop	Type
id	string
buildId	string

SyncCallback

Prop	Type
onError	(error: LiveUpdateError) => void
onAppComplete	(result: SyncResult) => void
onSyncComplete	() => void

SyncOneOptions

Prop	Type
name	string

SyncSomeOptions

Prop	Type
names	string[]

Type Aliases

LiveUpdate

Pick<LiveUpdateConfig, 'appId' | 'channel'>

AutoUpdateMethod

'none' | 'background'