Methods

notifyAppReady()

notifyAppReady() => Promise<{ bundle: BundleInfo; }>

Notify Capacitor Updater that the current bundle is working (a rollback will occur if this method is not called on every app launch) By default this method should be called in the first 10 sec after the app launch, otherwise, a rollback will occur. Change this behavior with {@link appReadyTimeout}

Returns: Promise<{ bundle: BundleInfo; }>

download(…)

download(options: { url: string; version: string; sessionKey?: string; checksum?: string; }) => Promise<BundleInfo>

Download a new bundle from the provided URL, it should be a zip file, with files inside or with a unique id inside with all your files

Returns: Promise<BundleInfo>

next(…)

next(options: { id: string; }) => Promise<BundleInfo>

Set the next bundle to be used when the app is reloaded.

Returns: Promise<BundleInfo>

set(…)

set(options: { id: string; }) => Promise<void>

Set the current bundle and immediately reload the app.

delete(…)

delete(options: { id: string; }) => Promise<void>

Delete bundle in storage

list()

list() => Promise<{ bundles: BundleInfo[]; }>

Get all locally downloaded bundles in your app

Returns: Promise<{ bundles: BundleInfo[]; }>

reset(…)

reset(options?: { toLastSuccessful?: boolean | undefined; } | undefined) => Promise<void>

Set the builtin bundle (the one sent to Apple store / Google play store ) as a current bundle

current()

current() => Promise<{ bundle: BundleInfo; native: string; }>

Get the current bundle, if none are set it returns builtin, currentNative is the original bundle installed on the device

Returns: Promise<{ bundle: BundleInfo; native: string; }>

reload()

reload() => Promise<void>

Reload the view

setMultiDelay(…)

setMultiDelay(options: { delayConditions: DelayCondition[]; }) => Promise<void>

Set DelayCondition, skip updates until one of the conditions is met

Since: 4.3.0

cancelDelay()

cancelDelay() => Promise<void>

Cancel delay to updates as usual

Since: 4.0.0

getLatest()

getLatest() => Promise<latestVersion>

Get Latest bundle available from update Url

Returns: Promise<latestVersion>

Since: 4.0.0

setChannel(…)

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

Set Channel for this device, the channel has to allow self assignment to make this work

Returns: Promise<channelRes>

Since: 4.7.0

unsetChannel(…)

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

Unset Channel for this device, the device will return to the default channel

Since: 4.7.0

getChannel()

getChannel() => Promise<getChannelRes>

get Channel for this device

Returns: Promise<getChannelRes>

Since: 4.8.0

setCustomId(…)

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

Set Channel for this device

Since: 4.9.0

addListener(‘download’, …)

addListener(eventName: "download", listenerFunc: DownloadChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for download event in the App, let you know when the download is started, loading, and finished, with a percent value

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 2.0.11

addListener(‘noNeedUpdate’, …)

addListener(eventName: "noNeedUpdate", listenerFunc: NoNeedListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for no need to update event, usefull when you want force check every time the app is launched

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 4.0.0

addListener(‘updateAvailable’, …)

addListener(eventName: "updateAvailable", listenerFunc: UpdateAvailabledListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for availbale update event, usefull when you want to force check every time the app is launched

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 4.0.0

addListener(‘downloadComplete’, …)

addListener(eventName: "downloadComplete", listenerFunc: DownloadCompleteListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for download event in the App, let you know when the download is started, loading, and finished

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 4.0.0

addListener(‘majorAvailable’, …)

addListener(eventName: "majorAvailable", listenerFunc: MajorAvailableListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for Major update event in the App, and let you know when a major update is blocked by setting disableAutoUpdateBreaking

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 2.3.0

addListener(‘updateFailed’, …)

addListener(eventName: "updateFailed", listenerFunc: UpdateFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for update fail event in the App, and let you know when the update has failed to install at the next app start

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 2.3.0

addListener(‘downloadFailed’, …)

addListener(eventName: "downloadFailed", listenerFunc: DownloadFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for download fail event in the App, and let you know when the download has failed finished

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 4.0.0

addListener(‘appReloaded’, …)

addListener(eventName: "appReloaded", listenerFunc: AppReloadedListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for reload event in the App, and let you know when the reload has happened

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 4.3.0

addListener(‘appReady’, …)

addListener(eventName: "appReady", listenerFunc: AppReadyListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for app ready event in the App, and let you know when the app is ready to use

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 5.1.0

getBuiltinVersion()

getBuiltinVersion() => Promise<{ version: string; }>

Get the native app version or the builtin version if set in the config

Returns: Promise<{ version: string; }>

Since: 5.2.0

getDeviceId()

getDeviceId() => Promise<{ deviceId: string; }>

Get a unique ID used to identify the device (sent to auto-update server)

Returns: Promise<{ deviceId: string; }>

getPluginVersion()

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor Updater plugin version (sent to auto update server)

Returns: Promise<{ version: string; }>

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<{ enabled: boolean; }>

Get the state of auto update config. This will return false in manual mode.

Returns: Promise<{ enabled: boolean; }>

removeAllListeners()

removeAllListeners() => Promise<void>

Remove all listeners for this plugin.

Since: 1.0.0

Interfaces

BundleInfo

DelayCondition

latestVersion

channelRes

SetChannelOptions

UnsetChannelOptions

getChannelRes

SetCustomIdOptions

PluginListenerHandle

DownloadEvent

noNeedEvent

updateAvailableEvent

DownloadCompleteEvent

MajorAvailableEvent

UpdateFailedEvent

DownloadFailedEvent

AppReadyEvent

Type Aliases

BundleStatus

“success” | “error” | “pending” | “downloading”

DelayUntilNext

“background” | “kill” | “nativeVersion” | “date”

DownloadChangeListener

(state: DownloadEvent): void

NoNeedListener

(state: noNeedEvent): void

UpdateAvailabledListener

(state: updateAvailableEvent): void

DownloadCompleteListener

(state: DownloadCompleteEvent): void

MajorAvailableListener

(state: MajorAvailableEvent): void

UpdateFailedListener

(state: UpdateFailedEvent): void

DownloadFailedListener

(state: DownloadFailedEvent): void

AppReloadedListener

(state: void): void

AppReadyListener

(state: AppReadyEvent): void