コンテンツにスキップ

Functions and settings

このコンテンツはまだ日本語訳がありません。

Updater Plugin Config

See the Github Readme for more information.

CapacitorUpdater can be configured with these options:

PropTypeDescriptionDefaultSince
appReadyTimeoutnumberConfigure the number of milliseconds the native plugin should wait before considering an update ‘failed’. Only available for Android and iOS.10000 // (10 seconds)
responseTimeoutnumberConfigure the number of milliseconds the native plugin should wait before considering API timeout. Only available for Android and iOS.20 // (20 second)
autoDeleteFailedbooleanConfigure whether the plugin should use automatically delete failed bundles. Only available for Android and iOS.true
autoDeletePreviousbooleanConfigure whether the plugin should use automatically delete previous bundles after a successful update. Only available for Android and iOS.true
autoUpdatebooleanConfigure whether the plugin should use Auto Update via an update server. Only available for Android and iOS.true
resetWhenUpdatebooleanAutomatically delete previous downloaded bundles when a newer native app bundle is installed to the device. Only available for Android and iOS.true
updateUrlstringConfigure the URL / endpoint to which update checks are sent. Only available for Android and iOS.https://api.capgo.app/updates
channelUrlstringConfigure the URL / endpoint for channel operations. Only available for Android and iOS.https://api.capgo.app/channel_self
statsUrlstringConfigure the URL / endpoint to which update statistics are sent. Only available for Android and iOS. Set to "" to disable stats reporting.https://api.capgo.app/stats
privateKeystringConfigure the private key for end to end live update encryption. Only available for Android and iOS.undefined
publicKeystringConfigure the public key for end to end live update encryption Version 2 Only available for Android and iOS.undefined6.2.0
versionstringConfigure the current version of the app. This will be used for the first update request. If not set, the plugin will get the version from the native code. Only available for Android and iOS.undefined4.17.48
directUpdatebooleanMake the plugin direct install the update when the app what just updated/installed. Only for autoUpdate mode. Only available for Android and iOS.undefined5.1.0
periodCheckDelaynumberConfigure the delay period for period update check. the unit is in seconds. Only available for Android and iOS. Cannot be less than 600 seconds (10 minutes).600 // (10 minutes)
localS3booleanConfigure the CLI to use a local server for testing or self-hosted update server.undefined4.17.48
localHoststringConfigure the CLI to use a local server for testing or self-hosted update server.undefined4.17.48
localWebHoststringConfigure the CLI to use a local server for testing or self-hosted update server.undefined4.17.48
localSupastringConfigure the CLI to use a local server for testing or self-hosted update server.undefined4.17.48
localSupaAnonstringConfigure the CLI to use a local server for testing.undefined4.17.48
localApistringConfigure the CLI to use a local api for testing.undefined6.3.3
localApiFilesstringConfigure the CLI to use a local file api for testing.undefined6.3.3
allowModifyUrlbooleanAllow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side.false5.4.0
defaultChannelstringSet the default channel for the app in the config.undefined5.5.0
appIdstringConfigure the app id for the app in the config.undefined6.0.0

Examples

In 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,
"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
}
}
}

In capacitor.config.ts:

/// <reference types="@capgo/capacitor-updater" />
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,
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,
},
},
};
export default config;

Methods

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

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 app launch, otherwise a rollback will occur. Change this behaviour with {@link appReadyTimeout}

Returns: Promise<AppReadyResult>


setUpdateUrl(…)

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

Set the updateUrl for the app, this will be used to check for updates.

ParamTypeDescription
optionsUpdateUrlcontains the URL to use for checking for updates.

Since: 5.4.0


setStatsUrl(…)

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

Set the statsUrl for the app, this will be used to send statistics. Passing an empty string will disable statistics gathering.

ParamTypeDescription
optionsStatsUrlcontains the URL to use for sending statistics.

Since: 5.4.0


setChannelUrl(…)

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

Set the channelUrl for the app, this will be used to set the channel.

ParamTypeDescription
optionsChannelUrlcontains the URL to use for setting the channel.

Since: 5.4.0


download(…)

download(options: DownloadOptions) => 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

ParamTypeDescription
optionsDownloadOptionsThe {@link DownloadOptions} for downloading a new bundle zip.

Returns: Promise<BundleInfo>


next(…)

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

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

ParamTypeDescription
optionsBundleIdContains the ID of the next Bundle to set on next app launch. {@link BundleInfo.id}

Returns: Promise<BundleInfo>


set(…)

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

Set the current bundle and immediately reloads the app.

ParamTypeDescription
optionsBundleIdA {@link BundleId} object containing the new bundle id to set as current.

delete(…)

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

Deletes the specified bundle from the native app storage. Use with {@link list} to get the stored Bundle IDs.

ParamTypeDescription
optionsBundleIdA {@link BundleId} object containing the ID of a bundle to delete (note, this is the bundle id, NOT the version name)

list()

list() => Promise<BundleListResult>

Get all locally downloaded bundles in your app

Returns: Promise<BundleListResult>


reset(…)

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

Reset the app to the builtin bundle (the one sent to Apple App Store / Google Play Store ) or the last successfully loaded bundle.

ParamTypeDescription
optionsResetOptionsContaining {@link ResetOptions.toLastSuccessful}, true resets to the builtin bundle and false will reset to the last successfully loaded bundle.

current()

current() => Promise<CurrentBundleResult>

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

Returns: Promise<CurrentBundleResult>


reload()

reload() => Promise<void>

Reload the view


setMultiDelay(…)

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

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 date kind, the value should be an iso8601 date string. For the background kind, the value should be a number in milliseconds. For the nativeVersion kind, the value should be the version number. For the kill kind, the value is not used. The function has unconsistent 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.

ParamTypeDescription
optionsMultiDelayConditionsContaining the {@link MultiDelayConditions} array of conditions to set

Since: 4.3.0


cancelDelay()

cancelDelay() => Promise<void>

Cancels a {@link DelayCondition} to process an update immediately.

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>

Sets the channel for this device. The channel has to allow for self assignment for this to work. Do not use this method to set the channel at boot when autoUpdate is enabled in the {@link PluginsConfig}. This method is to set the channel after the app is ready.

ParamTypeDescription
optionsSetChannelOptionsIs the {@link SetChannelOptions} channel to set

Returns: Promise<ChannelRes>

Since: 4.7.0


unsetChannel(…)

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

Unset the channel for this device. The device will then return to the default channel

ParamType
optionsUnsetChannelOptions

Since: 4.7.0


getChannel()

getChannel() => Promise<GetChannelRes>

Get the channel for this device

Returns: Promise<GetChannelRes>

Since: 4.8.0


setCustomId(…)

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

Set a custom ID for this device

ParamTypeDescription
optionsSetCustomIdOptionsis the {@link SetCustomIdOptions} customId to set

Since: 4.9.0


getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

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

Returns: Promise<BuiltinVersion>

Since: 5.2.0


getDeviceId()

getDeviceId() => Promise<DeviceId>

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

Returns: Promise<DeviceId>


getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

Returns: Promise<PluginVersion>


isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Get the state of auto update config.

Returns: Promise<AutoUpdateEnabled>


removeAllListeners()

removeAllListeners() => Promise<void>

Remove all listeners for this plugin.

Since: 1.0.0


addListener(‘download’, …)

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

Listen for bundle download event in the App. Fires once a download has started, during downloading and when finished.

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

Returns: Promise<PluginListenerHandle>

Since: 2.0.11


addListener(‘noNeedUpdate’, …)

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

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

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

Returns: Promise<PluginListenerHandle>

Since: 4.0.0


addListener(‘updateAvailable’, …)

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

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

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

Returns: Promise<PluginListenerHandle>

Since: 4.0.0


addListener(‘downloadComplete’, …)

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

Listen for downloadComplete events.

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

Returns: Promise<PluginListenerHandle>

Since: 4.0.0


addListener(‘majorAvailable’, …)

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

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

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

Returns: Promise<PluginListenerHandle>

Since: 2.3.0


addListener(‘updateFailed’, …)

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

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

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

Returns: Promise<PluginListenerHandle>

Since: 2.3.0


addListener(‘downloadFailed’, …)

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

Listen for download fail event in the App, let you know when a bundle download has failed

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

Returns: Promise<PluginListenerHandle>

Since: 4.0.0


addListener(‘appReloaded’, …)

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

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

ParamType
eventName’appReloaded’
listenerFunc() => void

Returns: Promise<PluginListenerHandle>

Since: 4.3.0


addListener(‘appReady’, …)

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

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

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

Returns: Promise<PluginListenerHandle>

Since: 5.1.0


Interfaces

AppReadyResult

PropType
bundleBundleInfo

BundleInfo

PropType
idstring
versionstring
downloadedstring
checksumstring
statusBundleStatus

UpdateUrl

PropType
urlstring

StatsUrl

PropType
urlstring

ChannelUrl

PropType
urlstring

DownloadOptions

PropTypeDescriptionDefaultSince
urlstringThe URL of the bundle zip file (e.g: dist.zip) to be downloaded. (This can be any URL. E.g: Amazon S3, a GitHub tag, any other place you’ve hosted your bundle.)
versionstringThe version code/name of this bundle/version
sessionKeystringThe session key for the updateundefined4.0.0
checksumstringThe checksum for the updateundefined4.0.0

BundleId

PropType
idstring

BundleListResult

PropType
bundlesBundleInfo[]

ResetOptions

PropType
toLastSuccessfulboolean

CurrentBundleResult

PropType
bundleBundleInfo
nativestring

MultiDelayConditions

PropType
delayConditionsDelayCondition[]

DelayCondition

PropTypeDescription
kindDelayUntilNextSet up delay conditions in setMultiDelay
valuestring

LatestVersion

PropTypeDescriptionSince
versionstringResult of getLatest method4.0.0
checksumstring6
majorboolean
messagestring
sessionKeystring
errorstring
oldstring
urlstring
manifestManifestEntry[]6.1

ManifestEntry

PropType
file_namestring | null
file_hashstring | null
download_urlstring | null

ChannelRes

PropTypeDescriptionSince
statusstringCurrent status of set channel4.7.0
errorany
messageany

SetChannelOptions

PropType
channelstring
triggerAutoUpdateboolean

UnsetChannelOptions

PropType
triggerAutoUpdateboolean

GetChannelRes

PropTypeDescriptionSince
channelstringCurrent status of get channel4.8.0
errorany
messageany
statusstring
allowSetboolean

SetCustomIdOptions

PropType
customIdstring

BuiltinVersion

PropType
versionstring

DeviceId

PropType
deviceIdstring

PluginVersion

PropType
versionstring

AutoUpdateEnabled

PropType
enabledboolean

PluginListenerHandle

PropType
remove() => Promise<void>

DownloadEvent

PropTypeDescriptionSince
percentnumberCurrent status of download, between 0 and 100.4.0.0
bundleBundleInfo

NoNeedEvent

PropTypeDescriptionSince
bundleBundleInfoCurrent status of download, between 0 and 100.4.0.0

UpdateAvailableEvent

PropTypeDescriptionSince
bundleBundleInfoCurrent status of download, between 0 and 100.4.0.0

DownloadCompleteEvent

PropTypeDescriptionSince
bundleBundleInfoEmit when a new update is available.4.0.0

MajorAvailableEvent

PropTypeDescriptionSince
versionstringEmit when a new major bundle is available.4.0.0

UpdateFailedEvent

PropTypeDescriptionSince
bundleBundleInfoEmit when a update failed to install.4.0.0

DownloadFailedEvent

PropTypeDescriptionSince
versionstringEmit when a download fail.4.0.0

AppReadyEvent

PropTypeDescriptionSince
bundleBundleInfoEmitted when the app is ready to use.5.2.0
statusstring

Type Aliases

BundleStatus

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

DelayUntilNext

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