Functions and Paramètres

Updater Plugin Config

See the Github Readme for more Information.

CapacitorUpdater can be configured with these Options:

Prop	Type	Description	Default	Since
appReadyTimeout	number	Configure the number of milliseconds the native plugin should wait before considering an update ‘failed’. Only available for Android and iOS.	10000 // (10 seconds)
responseTimeout	number	Configure the number of milliseconds the native plugin should wait before considering API timeout. Only available for Android and iOS.	20 // (20 second)
autoDeleteFailed	boolean	Configure whether the plugin should use automatically delete failed bundles. Only available for Android and iOS.	true
autoDeletePrevious	boolean	Configure whether the plugin should use automatically delete previous bundles after a successful update. Only available for Android and iOS.	true
autoUpdate	boolean	Configure whether the plugin should use Auto Update via an update server. Only available for Android and iOS.	true
resetWhenUpdate	boolean	Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device. Only available for Android and iOS.	true
updateUrl	string	Configure the URL / endpoint to which update checks are sent. Only available for Android and iOS.	https://plugin.capgo.app/updates
channelUrl	string	Configure the URL / endpoint for channel operations. Only available for Android and iOS.	https://plugin.capgo.app/channel_self
statsUrl	string	Configure the URL / endpoint to which update statistics are sent. Only available for Android and iOS. Set to "" to disable stats reporting.	https://plugin.capgo.app/stats
publicKey	string	Configure the public key for end to end live update encryption Version 2 Only available for Android and iOS.	undefined	6.2.0
version	string	Configure 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.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Configure when the plugin should direct install updates. Only for autoUpdate mode. Works well for apps less than 10MB and with uploads done using —partial flag. Zip or apps more than 10MB will be relatively slow for users to update. - false: Never do direct updates (use default behavior: download at start, set when backgrounded) - atInstall: Direct update only when app is installed, updated from store, otherwise act as directUpdate = false - onLaunch: Direct update only on app installed, updated from store or after app kill, otherwise act as directUpdate = false - always: Direct update in all previous cases (app installed, updated from store, after app kill or app resume), never act as directUpdate = false - true: (deprecated) Same as “always” for backward compatibility Only available for Android and iOS.	false	5.1.0
autoSplashscreen	boolean	Automatically handle splashscreen hiding when using directUpdate. When enabled, the plugin will automatically hide the splashscreen after updates are applied or when no update is needed. This removes the need to manually listen for appReady events and call SplashScreen.hide(). Only works when directUpdate is set to “atInstall”, “always”, or true. Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false. Requires autoUpdate and directUpdate to be enabled. Only available for Android and iOS.	false	7.6.0
periodCheckDelay	number	Configure 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)
localS3	boolean	Configure the CLI to use a local server for testing or self-hosted update server.	undefined	4.17.48
localHost	string	Configure the CLI to use a local server for testing or self-hosted update server.	undefined	4.17.48
localWebHost	string	Configure the CLI to use a local server for testing or self-hosted update server.	undefined	4.17.48
localSupa	string	Configure the CLI to use a local server for testing or self-hosted update server.	undefined	4.17.48
localSupaAnon	string	Configure the CLI to use a local server for testing.	undefined	4.17.48
localApi	string	Configure the CLI to use a local api for testing.	undefined	6.3.3
localApiFiles	string	Configure the CLI to use a local file api for testing.	undefined	6.3.3
allowModifyUrl	boolean	Allow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side.	false	5.4.0
defaultChannel	string	Set the default channel for the app in the config. Case sensitive. This will setting will override the default channel set in the cloud, but will still respect overrides made in the cloud.	undefined	5.5.0
appId	string	Configure the app id for the app in the config.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Configure the plugin to keep the URL path after a reload. WARNING: When a reload is triggered, ‘window.history’ will be cleared.	false	6.8.0
disableJSLogging	boolean	Disable the JavaScript logging of the plugin. if true, the plugin will not log to the JavaScript console. only the native log will be done	false	7.3.0
shakeMenu	boolean	Enable shake gesture to show update menu for debugging/testing purposes	false	7.5.0

Exemples

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

In 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(...)
• current()
• reload()
• setMultiDelay(...)
• cancelDelay()
• getLatest(...)
• setChannel(...)
• unsetChannel(...)
• getChannel()
• listChannels()
• 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()
• setShakeMenu(...)
• isShakeMenuEnabled()
• Interfaces
• Type Aliases

Methods

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

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

Returns: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

Set the updateUrl for the Application, this will be used to Vérifier for Mises à jour.

Param	Type	Description
options	UpdateUrl	contains the URL to use for checking for updates.

Since: 5.4.0

---

setStatsUrl(…)

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

Set the statsUrl for the Application, this will be used to send Statistiques. Passing an empty string will Désactiver Statistiques gathering.

Param	Type	Description
options	StatsUrl	contains the URL to use for sending statistics.

Since: 5.4.0

---

setChannelUrl(…)

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

Set the channelUrl for the Application, this will be used to set the Canal.

Param	Type	Description
options	ChannelUrl	contains the URL to use for setting the channel.

Since: 5.4.0

---

Télécharger(…)

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

Télécharger a Nouveau Bundle from the provided URL, it should be a zip file, with files inside or with a unique id inside with all your files

Param	Type	Description
options	DownloadOptions	The {@link DownloadOptions} for downloading a new bundle zip.

Returns: Promise<BundleInfo>

---

Suivant(…)

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

Set the Suivant Bundle to be used when the Application is reloaded.

Param	Type	Description
options	BundleId	Contains 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 Application.

Param	Type	Description
options	BundleId	A {@link BundleId} object containing the new bundle id to set as current.

---

Supprimer(…)

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

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

Param	Type	Description
options	BundleId	A {@link BundleId} object containing the ID of a bundle to delete (note, this is the bundle id, NOT the version name)

---

list(…)

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

Get all locally downloaded Bundles in your Application

Param	Type	Description
options	ListOptions	The {@link ListOptions} for listing bundles

Returns: Promise<BundleListResult>

---

Réinitialiser(…)

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.

Param	Type	Description
options	ResetOptions	Containing {@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 Mise à jour process will run Démarrer again as usual, so Mise à jour will be installed after a backgrounding or killing the Application. 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 inconsistent behavior the Option kill do trigger the Mise à jour after the first kill and not after the Suivant background like other Options. This will be fixed in a future major Libération.

Param	Type	Description
options	MultiDelayConditions	Containing 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(options?: GetLatestOptions | undefined) => Promise<LatestVersion>

Get Latest Bundle Disponible from Mise à jour Url

Param	Type
options	GetLatestOptions

Returns: Promise<LatestVersion>

Since: 4.0.0

---

setChannel(…)

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

Sets the Canal for this Appareil. The Canal has to allow for self assignment for this to work. Do not use this method to set the Canal at boot. This method is to set the Canal after the Application is ready, and Utilisateur interacted. If you want to set the channel at boot, use the {@link PluginsConfig} to set the default channel. This methods send to Capgo backend a request to link the Appareil ID to the Canal. Capgo can accept or refuse depending of the setting of your Canal.

Param	Type	Description
options	SetChannelOptions	Is the {@link SetChannelOptions} channel to set

Returns: Promise<ChannelRes>

Since: 4.7.0

---

unsetChannel(…)

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

Unset the Canal for this Appareil. The Appareil will then return to the default Canal

Param	Type
options	UnsetChannelOptions

Since: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Get the Canal for this Appareil

Returns: Promise<GetChannelRes>

Since: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

List all Canaux Disponible for this Appareil that allow self-assignment

Returns: Promise<ListChannelsResult>

Since: 7.5.0

---

setCustomId(…)

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

Set a custom ID for this Appareil

Param	Type	Description
options	SetCustomIdOptions	is the {@link SetCustomIdOptions} customId to set

Since: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Get the Natif Application 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 Appareil (sent to auto Mise à jour server)

Returns: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Get the Natif Capacitor Updater plugin Version (sent to auto Mise à jour server)

Returns: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Get the state of auto Mise à jour config.

Returns: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Retirer all listeners for this plugin.

Since: 1.0.0

---

addListener(‘Télécharger’, …)

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

Listen for Bundle Télécharger event in the Application. Fires once a Télécharger has started, during downloading and when finished. This will return you all Télécharger percent during the Télécharger

Param	Type
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 Mise à jour event, useful when you want force Vérifier every time the Application is launched

Param	Type
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 Disponible Mise à jour event, useful when you want to force Vérifier every time the Application is launched

Param	Type
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.

Param	Type
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 Mise à jour event in the Application, let you know when major Mise à jour is blocked by setting disableAutoUpdateBreaking

Param	Type
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 Mise à jour fail event in the Application, let you know when Mise à jour has fail to Installer at Suivant Application Démarrer

Param	Type
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 Télécharger fail event in the Application, let you know when a Bundle Télécharger has Échoué

Param	Type
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 Application, let you know when reload has happened

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

Returns: Promise<PluginListenerHandle>

Since: 4.3.0

---

addListener(‘appReady’, …)

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

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

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

Returns: Promise<PluginListenerHandle>

Since: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Get if auto Mise à jour is Disponible (not disabled by serverUrl).

Returns: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Get the Suivant Bundle that will be used when the Application reloads. Retourne null if no Suivant Bundle is set.

Returns: Promise<BundleInfo | null>

Since: 6.8.0

---

setShakeMenu(…)

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

Activer or Désactiver the shake menu for Débogage/Test purposes

Param	Type	Description
options	SetShakeMenuOptions	Contains enabled boolean to enable or disable shake menu

Since: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Get the current state of the shake menu

Returns: Promise<ShakeMenuEnabled>

Since: 7.5.0

---

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

This URL and versions are used to Télécharger the Bundle from the server, If you use backend all Information will be given by the method getLatest. If you don’t use backend, you need to provide the URL and Version of the Bundle. Checksum and sessionKey are required if you Chiffré the Bundle with the CLI Commande encrypt, you should receive them as result of the Commande.

Prop	Type	Description	Default	Since
url	string	The 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.)
version	string	The version code/name of this bundle/version
sessionKey	string	The session key for the update, when the bundle is encrypted with a session key	undefined	4.0.0
checksum	string	The checksum for the update, it should be in sha256 and encrypted with private key if the bundle is encrypted	undefined	4.0.0
manifest	ManifestEntry[]	The manifest for multi-file downloads	undefined	6.1.0

ManifestEntry

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

BundleId

Prop	Type
id	string

BundleListResult

Prop	Type
bundles	BundleInfo[]

ListOptions

Prop	Type	Description	Default	Since
raw	boolean	Whether to return the raw bundle list or the manifest. If true, the list will attempt to read the internal database instead of files on disk.	false	6.14.0

ResetOptions

Prop	Type
toLastSuccessful	boolean

CurrentBundleResult

Prop	Type
bundle	BundleInfo
native	string

MultiDelayConditions

Prop	Type
delayConditions	DelayCondition[]

DelayCondition

Prop	Type	Description
kind	DelayUntilNext	Set up delay conditions in setMultiDelay
value	string

LatestVersion

Prop	Type	Description	Since
version	string	Result of getLatest method	4.0.0
checksum	string		6
major	boolean
message	string
sessionKey	string
error	string
old	string
url	string
manifest	ManifestEntry[]		6.1

GetLatestOptions

Prop	Type	Description	Default	Since
channel	string	The channel to get the latest version for The channel must allow ‘self_assign’ for this to work	undefined	6.8.0

ChannelRes

Prop	Type	Description	Since
status	string	Current status of set channel	4.7.0
error	string
message	string

SetChannelOptions

Prop	Type
channel	string
triggerAutoUpdate	boolean

UnsetChannelOptions

Prop	Type
triggerAutoUpdate	boolean

GetChannelRes

Prop	Type	Description	Since
channel	string	Current status of get channel	4.8.0
error	string
message	string
status	string
allowSet	boolean

ListChannelsResult

Prop	Type	Description	Since
channels	ChannelInfo[]	List of available channels	7.5.0

ChannelInfo

Prop	Type	Description	Since
id	string	The channel ID	7.5.0
name	string	The channel name	7.5.0
public	boolean	Whether this is a public channel	7.5.0
allow_self_set	boolean	Whether devices can self-assign to this channel	7.5.0

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	Description	Since
percent	number	Current status of download, between 0 and 100.	4.0.0
bundle	BundleInfo

NoNeedEvent

Prop	Type	Description	Since
bundle	BundleInfo	Current status of download, between 0 and 100.	4.0.0

UpdateAvailableEvent

Prop	Type	Description	Since
bundle	BundleInfo	Current status of download, between 0 and 100.	4.0.0

DownloadCompleteEvent

Prop	Type	Description	Since
bundle	BundleInfo	Emit when a new update is available.	4.0.0

MajorAvailableEvent

Prop	Type	Description	Since
version	string	Emit when a new major bundle is available.	4.0.0

UpdateFailedEvent

Prop	Type	Description	Since
bundle	BundleInfo	Emit when a update failed to install.	4.0.0

DownloadFailedEvent

Prop	Type	Description	Since
version	string	Emit when a download fail.	4.0.0

AppReadyEvent

Prop	Type	Description	Since
bundle	BundleInfo	Emitted when the app is ready to use.	5.2.0
status	string

AutoUpdateAvailable

Prop	Type
available	boolean

SetShakeMenuOptions

Prop	Type
enabled	boolean

ShakeMenuEnabled

Prop	Type
enabled	boolean

Type Aliases

BundleStatus

En attente: The Bundle is En attente to be SET as the Suivant Bundle. downloading: The Bundle is being downloaded. Succès: The Bundle has been downloaded and is ready to be SET as the Suivant Bundle. Erreur: The Bundle has Échoué to Télécharger.

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

DelayUntilNext

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