{"id":14985786,"url":"https://github.com/cap-go/capacitor-updater","last_synced_at":"2026-05-07T01:18:07.716Z","repository":{"id":37850098,"uuid":"420741081","full_name":"Cap-go/capacitor-updater","owner":"Cap-go","description":"Capacitor plugin for Instant updates: Ship updates, fixes, changes, and features within minutes","archived":false,"fork":false,"pushed_at":"2025-11-25T04:18:15.000Z","size":6316,"stargazers_count":649,"open_issues_count":10,"forks_count":135,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-11-28T03:55:33.362Z","etag":null,"topics":["android","capacitor","capacitor-plugin","cordova","hot-reload","ionic","ios","typescript"],"latest_commit_sha":null,"homepage":"https://capgo.app","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cap-go.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"Cap-go","patreon":null,"open_collective":"capgo","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2021-10-24T16:49:48.000Z","updated_at":"2025-11-26T21:31:32.000Z","dependencies_parsed_at":"2022-06-22T22:45:25.426Z","dependency_job_id":"c0082efc-86dc-43d5-94cb-d4144491d6bf","html_url":"https://github.com/Cap-go/capacitor-updater","commit_stats":{"total_commits":1884,"total_committers":36,"mean_commits":"52.333333333333336","dds":0.5801486199575372,"last_synced_commit":"85918cb9d0df95cd789e6d569e766a2d365297d9"},"previous_names":[],"tags_count":728,"template":false,"template_full_name":null,"purl":"pkg:github/Cap-go/capacitor-updater","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-updater","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-updater/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-updater/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-updater/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cap-go","download_url":"https://codeload.github.com/Cap-go/capacitor-updater/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-updater/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27424850,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-01T02:00:06.371Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","capacitor","capacitor-plugin","cordova","hot-reload","ionic","ios","typescript"],"created_at":"2024-09-24T14:11:40.205Z","updated_at":"2026-05-07T01:18:07.702Z","avatar_url":"https://github.com/Cap-go.png","language":"Java","funding_links":["https://github.com/sponsors/Cap-go","https://opencollective.com/capgo"],"categories":[],"sub_categories":[],"readme":"# Capacitor updater\n \u003ca href=\"https://capgo.app/\"\u003e\u003cimg src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/\u003e\u003c/a\u003e\n[![Discord](https://badgen.net/badge/icon/discord?icon=discord\u0026label)](https://discord.com/invite/VnYRvBfgA6)\n\u003ca href=\"https://discord.com/invite/VnYRvBfgA6\"\u003e\u003cimg src=\"https://img.shields.io/discord/912707985829163099?color=%237289DA\u0026label=Discord\" alt=\"Discord\"\u003e\n[![npm](https://img.shields.io/npm/dm/@capgo/capacitor-updater)](https://www.npmjs.com/package/@capgo/capacitor-updater)\n[![GitHub latest commit](https://badgen.net/github/last-commit/Cap-go/capacitor-updater/main)](https://GitHub.com/Cap-go/capacitor-updater/commit/)\n[![https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg](https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg)](https://good-labs.github.io/greater-good-affirmation)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capacitor-updater\u0026metric=security_rating)](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)\n[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capacitor-updater\u0026metric=bugs)](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capacitor-updater\u0026metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)\n[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capacitor-updater\u0026metric=code_smells)](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)\n[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capacitor-updater\u0026metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capacitor-updater\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)\n[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capacitor-updater\u0026metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)\n[![Open Bounties](https://img.shields.io/endpoint?url=https%3A%2F%2Fconsole.algora.io%2Fapi%2Fshields%2FCapgo%2Fbounties%3Fstatus%3Dopen)](https://console.algora.io/org/Capgo/bounties?status=open)\n[![Rewarded Bounties](https://img.shields.io/endpoint?url=https%3A%2F%2Fconsole.algora.io%2Fapi%2Fshields%2FCapgo%2Fbounties%3Fstatus%3Dcompleted)](https://console.algora.io/org/Capgo/bounties?status=completed)\n\n\u003cdiv align=\"center\"\u003e\n \u003ch2\u003e\u003ca href=\"https://capgo.app/?ref=plugin_updater_v7\"\u003e ➡️ Get Instant updates for your App with Capgo\u003c/a\u003e\u003c/h2\u003e\n \u003ch2\u003e\u003ca href=\"https://capgo.app/consulting/?ref=plugin_updater_v7\"\u003e Missing a feature? We’ll build the plugin for you 💪\u003c/a\u003e\u003c/h2\u003e\n\u003c/div\u003e\n\nCapacitor plugin to update your app remotely in real-time.\n\nOpen-source Alternative to Appflow, Codepush or Capawesome\n\n## Why Capacitor Updater?\n\nApp store review processes can take days or weeks, blocking critical bug fixes and updates from reaching your users. Capacitor Updater solves this by:\n\n- **Instant updates** - Push JavaScript/HTML/CSS updates directly to users without app store review\n- **Delta updates** - Only download changed files, making updates ultra-fast\n- **Rollback protection** - Automatically revert broken updates to keep your app stable\n- **Open source** - Self-host or use Capgo Cloud, with full control over your update infrastructure\n- **Battle-tested** - Used by 3000+ production apps with proven reliability\n- **Most stared** - Capacitor updater is the most stared Capacitor plugin on GitHub\n\nPerfect for fixing bugs immediately, A/B testing features, and maintaining control over your release schedule.\n\n## Features\n\n- ☁️ Cloud / Self hosted Support: Use our [Cloud](https://capgo.app/) to manage your app updates or yours.\n- 📦 Bundle Management: Download, assign to channel, rollback.\n- 📺 Channel Support: Use channels to manage different environments.\n- 🎯 Set Channel to specific device to do QA or debug one user.\n- 🔄 Auto Update: Automatically download and set the latest bundle for the app.\n- 🛟 Rollback: Reset the app to last working bundle if an incompatible bundle has been set.\n- 🔁 **Delta Updates**: Make instant updates by only downloading changed files.\n- 🔒 **Security**: Encrypt and sign each updates with best in class security standards.\n- ⚔️ **Battle-Tested**: Used in more than 3000 projects.\n- 📊 View your deployment statistics\n- 🔋 Supports Android and iOS\n- ⚡️ Capacitor 4/5/6/7/8 support\n- 🌐 **Open Source**: Licensed under the Mozilla Public License 2.0\n- 🌐 **Open Source Backend**: Self install [our backend](https://github.com/Cap-go/capgo) in your infra\n\n\nYou have 3 ways possible :\n- Use [capgo.app](https://capgo.app) a full featured auto-update system in 5 min Setup, to manage version, update, revert and see stats.\n- Use your own server update with auto-update system\n- Use manual methods to zip, upload, download, from JS to do it when you want.\n\n## Documentation\nThe most complete [documentation here](https://capgo.app/docs/).\n\n## Community\nJoin the [discord](https://discord.gg/VnYRvBfgA6) to get help.\n\n## Migration to v8\n\nThis major version is here to follow Capacitor major version 8\n\nFirst follow the migration guide of Capacitor:\n\n[https://capacitorjs.com/docs/updating/8-0](https://capacitorjs.com/docs/updating/8-0/)\n\n## Migration to v7.34\n\n- **Channel storage change**: `setChannel()` now stores channel assignments locally on the device instead of in the cloud. This provides better offline support and reduces backend load.\n - Channel assignments persist between app restarts\n - Use `unsetChannel()` to clear the local assignment and revert to `defaultChannel`\n - Old devices (\u003c v7.34.0) will continue using cloud-based storage\n- **New event**: Listen to the `channelPrivate` event to handle cases where a user tries to assign themselves to a private channel (one that doesn't allow self-assignment). See example in the `setChannel()` documentation above.\n\n## Migration to v7\n\nThe minimum iOS version is now **15.0** to match Capacitor 7/8 requirements.\n\nStarting from v8, the plugin uses [ZIPFoundation](https://github.com/weichsel/ZIPFoundation) instead of SSZipArchive/ZipArchive for ZIP extraction. ZIPFoundation uses Apple's native `libcompression` framework, which removes the previous zlib dependency and its associated security constraints.\n\n## Compatibility\n\n| Plugin version | Capacitor compatibility | Maintained |\n| -------------- | ----------------------- | ----------------- |\n| v8.\\*.\\* | v8.\\*.\\* | ✅ |\n| v7.\\*.\\* | v7.\\*.\\* | ✅ |\n| v6.\\*.\\* | v6.\\*.\\* | ✅ |\n| v5.\\*.\\* | v5.\\*.\\* | ✅ |\n| v4.\\*.\\* | v4.\\*.\\* | ✅ |\n| v3.\\*.\\* | v3.\\*.\\* | ⚠️ Deprecated |\n| \u003e 7 | v4.\\*.\\* | ⚠️ Deprecated, our CI got crazy and bumped too much version |\n\n\u003e **Note:** Versions 4, 5, 6, 7, and 8 all share the same features. The major version simply follows your Capacitor version. You can safely use any of these versions that matches your Capacitor installation.\n\n### iOS\n\n#### Privacy manifest\n\nAdd the `NSPrivacyAccessedAPICategoryUserDefaults` dictionary key to your [Privacy Manifest](https://capacitorjs.com/docs/ios/privacy-manifest) (usually `ios/App/PrivacyInfo.xcprivacy`):\n\n```xml\n\u003c?xml version=\"1.0\" encoding=\"UTF-8\"?\u003e\n\u003c!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\"\u003e\n\u003cplist version=\"1.0\"\u003e\n \u003cdict\u003e\n \u003ckey\u003eNSPrivacyAccessedAPITypes\u003c/key\u003e\n \u003carray\u003e\n \u003c!-- Add this dict entry to the array if the file already exists. --\u003e\n \u003cdict\u003e\n \u003ckey\u003eNSPrivacyAccessedAPIType\u003c/key\u003e\n \u003cstring\u003eNSPrivacyAccessedAPICategoryUserDefaults\u003c/string\u003e\n \u003ckey\u003eNSPrivacyAccessedAPITypeReasons\u003c/key\u003e\n \u003carray\u003e\n \u003cstring\u003eCA92.1\u003c/string\u003e\n \u003c/array\u003e\n \u003c/dict\u003e\n \u003c/array\u003e\n \u003c/dict\u003e\n\u003c/plist\u003e\n```\n\nWe recommend to declare [`CA92.1`](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_use_of_required_reason_api#4278401) as the reason for accessing the [`UserDefaults`](https://developer.apple.com/documentation/foundation/userdefaults) API.\n\n## Installation\n\nStep by step here: [Getting started](https://capgo.app/docs/getting-started/add-an-app/)\n\nOr\n\n```bash\nnpm install @capgo/capacitor-updater\nnpx cap sync\n```\n\n### Install a specific version\n\nUse npm tags to install the version matching your Capacitor version:\n\n```bash\n# For Capacitor 8 (latest)\nnpm install @capgo/capacitor-updater@latest\n\n# For Capacitor 7\nnpm install @capgo/capacitor-updater@lts-v7\n\n# For Capacitor 6\nnpm install @capgo/capacitor-updater@lts-v6\n\n# For Capacitor 5\nnpm install @capgo/capacitor-updater@lts-v5\n\n# For Capacitor 4\nnpm install @capgo/capacitor-updater@lts-v4\n```\n\n## Auto-update setup\n\nCreate your account in [capgo.app](https://capgo.app) and get your [API key](https://console.capgo.app/dashboard/apikeys)\n- Login to CLI `npx @capgo/cli@latest init API_KEY`\nAnd follow the steps by step to setup your app.\n\nFor detailed instructions on the auto-update setup, refer to the [Auto update documentation](https://capgo.app/docs/plugin/cloud-mode/getting-started/).\n\n\n## No Cloud setup\n\nDownload update distribution zipfiles from a custom URL. Manually control the entire update process.\n\n- Edit your `capacitor.config.json` like below, set `autoUpdate` to false.\n```json\n// capacitor.config.json\n{\n\t\"appId\": \"**.***.**\",\n\t\"appName\": \"Name\",\n\t\"plugins\": {\n\t\t\"CapacitorUpdater\": {\n\t\t\t\"autoUpdate\": false,\n\t\t}\n\t}\n}\n```\n- Add to your main code\n```javascript\n import { CapacitorUpdater } from '@capgo/capacitor-updater'\n CapacitorUpdater.notifyAppReady()\n```\nThis informs Capacitor Updater that the current update bundle has loaded successfully. Failing to call this method will cause your application to be rolled back to the previously successful version (or built-in bundle).\n- Add this to your application.\n```javascript\n const version = await CapacitorUpdater.download({\n version: '0.0.4',\n url: 'https://github.com/Cap-go/demo-app/releases/download/0.0.4/dist.zip',\n })\n await CapacitorUpdater.set(version); // sets the new version, and reloads the app\n```\n- Failed updates will automatically roll back to the last successful version.\n- Example: Using App-state to control updates, with SplashScreen:\nYou might also consider performing auto-update when application state changes, and using the Splash Screen to improve user experience.\n```javascript\n import { CapacitorUpdater, VersionInfo } from '@capgo/capacitor-updater'\n import { SplashScreen } from '@capacitor/splash-screen'\n import { App } from '@capacitor/app'\n\n let version: VersionInfo;\n App.addListener('appStateChange', async (state) =\u003e {\n if (state.isActive) {\n // Ensure download occurs while the app is active, or download may fail\n version = await CapacitorUpdater.download({\n version: '0.0.4',\n url: 'https://github.com/Cap-go/demo-app/releases/download/0.0.4/dist.zip',\n })\n }\n\n if (!state.isActive \u0026\u0026 version) {\n // Activate the update when the application is sent to background\n SplashScreen.show()\n try {\n await CapacitorUpdater.set(version);\n // At this point, the new version should be active, and will need to hide the splash screen\n } catch () {\n SplashScreen.hide() // Hide the splash screen again if something went wrong\n }\n }\n })\n\n```\n\nTIP: If you prefer a secure and automated way to update your app, you can use [capgo.app](https://capgo.app) - a full-featured, auto-update system.\n\n### Store Guideline Compliance\n\nAndroid Google Play and iOS App Store have corresponding guidelines that have rules you should be aware of before integrating the Capacitor-updater solution within your application.\n\n#### Google play\n\nThird paragraph of [Device and Network Abuse](https://support.google.com/googleplay/android-developer/answer/9888379?hl=en) topic describe that updating source code by any method besides Google Play's update mechanism is restricted. But this restriction does not apply to updating JavaScript bundles.\n\u003e This restriction does not apply to code that runs in a virtual machine and has limited access to Android APIs (such as JavaScript in a web view or browser).\n\nThat fully allow Capacitor-updater as it updates just JS bundles and can't update native code part.\n\n#### App Store\n\nParagraph **3.3.2**, since back in 2015's [Apple Developer Program License Agreement](https://developer.apple.com/programs/ios/information/) fully allowed performing over-the-air updates of JavaScript and assets.\n\nAnd in its latest version (20170605) [downloadable here](https://developer.apple.com/terms/) this ruling is even broader:\n\n\u003e Interpreted code may be downloaded to an Application, but only so long as such code:\n- (a) does not change the primary purpose of the Application by providing features or functionality that are inconsistent with the intended and advertised purpose of the Application as submitted to the App Store\n- (b) does not create a store or storefront for other code or applications\n- (c) does not bypass signing, sandbox, or other security features of the OS.\n\nCapacitor-updater allows you to respect these rules in full compliance, so long as the update you push does not significantly deviate your product from its original App Store approved intent.\n\nTo further remain in compliance with Apple's guidelines, we suggest that App Store-distributed apps don't enable the `Force update` scenario, since in the [App Store Review Guidelines](https://developer.apple.com/app-store/review/guidelines/) it is written that:\n\n\u003e Apps must not force users to rate the app, review the app, download other apps, or other similar actions to access functionality, content, or use of the app.\n\nThis is not a problem for the default behavior of background update, since it won't force the user to apply the new version until the next app close, but at least you should be aware of that ruling if you decide to show it.\n\n### Packaging `dist.zip` update bundles\n\nCapacitor Updater works by unzipping a compiled app bundle to the native device filesystem. Whatever you choose to name the file you upload/download from your release/update server URL (via either manual or automatic updating), this `.zip` bundle must meet the following requirements:\n\n- The zip file should contain the full contents of your production Capacitor build output folder, usually `{project directory}/dist/` or `{project directory}/www/`. This is where `index.html` will be located, and it should also contain all bundled JavaScript, CSS, and web resources necessary for your app to run.\n- Do not password encrypt the bundle zip file, or it will fail to unpack.\n- Make sure the bundle does not contain any extra hidden files or folders, or it may fail to unpack.\n\n### Downgrading to a previous version of the updater plugin\n\nDowngrading to a previous version of the updater plugin is not supported.\n\n## Updater Plugin Config\n\n\u003cdocgen-config\u003e\n\u003c!--Update the source file JSDoc comments and rerun docgen to update the docs below--\u003e\n\nCapacitorUpdater can be configured with these options:\n\n| Prop | Type | Description | Default | Since |\n| ------------------------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ------- |\n| **`appReadyTimeout`** | \u003ccode\u003enumber\u003c/code\u003e | Configure the number of milliseconds the native plugin should wait before considering an update 'failed'. Only available for Android and iOS. | \u003ccode\u003e10000 // (10 seconds)\u003c/code\u003e | |\n| **`responseTimeout`** | \u003ccode\u003enumber\u003c/code\u003e | Configure the number of seconds the native plugin should wait before considering API timeout. Only available for Android and iOS. | \u003ccode\u003e20 // (20 second)\u003c/code\u003e | |\n| **`autoDeleteFailed`** | \u003ccode\u003eboolean\u003c/code\u003e | Configure whether the plugin should use automatically delete failed bundles. Only available for Android and iOS. | \u003ccode\u003etrue\u003c/code\u003e | |\n| **`autoDeletePrevious`** | \u003ccode\u003eboolean\u003c/code\u003e | Configure whether the plugin should use automatically delete previous bundles after a successful update. Only available for Android and iOS. | \u003ccode\u003etrue\u003c/code\u003e | |\n| **`autoUpdate`** | \u003ccode\u003eboolean\u003c/code\u003e | Configure whether the plugin should use Auto Update via an update server. Only available for Android and iOS. | \u003ccode\u003etrue\u003c/code\u003e | |\n| **`resetWhenUpdate`** | \u003ccode\u003eboolean\u003c/code\u003e | Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device. Setting this to false can broke the auto update flow if the user download from the store a native app bundle that is older than the current downloaded bundle. Upload will be prevented by channel setting downgrade_under_native. Only available for Android and iOS. | \u003ccode\u003etrue\u003c/code\u003e | |\n| **`updateUrl`** | \u003ccode\u003estring\u003c/code\u003e | Configure the URL / endpoint to which update checks are sent. Only available for Android and iOS. | \u003ccode\u003ehttps://plugin.capgo.app/updates\u003c/code\u003e | |\n| **`channelUrl`** | \u003ccode\u003estring\u003c/code\u003e | Configure the URL / endpoint for channel operations. Only available for Android and iOS. | \u003ccode\u003ehttps://plugin.capgo.app/channel_self\u003c/code\u003e | |\n| **`statsUrl`** | \u003ccode\u003estring\u003c/code\u003e | Configure the URL / endpoint to which update statistics are sent. Only available for Android and iOS. Set to \"\" to disable stats reporting. | \u003ccode\u003ehttps://plugin.capgo.app/stats\u003c/code\u003e | |\n| **`publicKey`** | \u003ccode\u003estring\u003c/code\u003e | Configure the public key for end to end live update encryption Version 2 Only available for Android and iOS. | \u003ccode\u003eundefined\u003c/code\u003e | 6.2.0 |\n| **`version`** | \u003ccode\u003estring\u003c/code\u003e | 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. | \u003ccode\u003eundefined\u003c/code\u003e | 4.17.48 |\n| **`directUpdate`** | \u003ccode\u003eboolean \\| 'always' \\| 'atInstall' \\| 'onLaunch'\u003c/code\u003e | Configure when the plugin should direct install updates. Only for autoUpdate mode. Works well for apps less than 10MB and with uploads done using --delta 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 Activate this flag will automatically make the CLI upload delta in CICD envs and will ask for confirmation in local uploads. Only available for Android and iOS. | \u003ccode\u003efalse\u003c/code\u003e | 5.1.0 |\n| **`autoSplashscreen`** | \u003ccode\u003eboolean\u003c/code\u003e | 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\", \"onLaunch\", 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. | \u003ccode\u003efalse\u003c/code\u003e | 7.6.0 |\n| **`autoSplashscreenLoader`** | \u003ccode\u003eboolean\u003c/code\u003e | Display a native loading indicator on top of the splashscreen while automatic direct updates are running. Only takes effect when {@link autoSplashscreen} is enabled. Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false. Only available for Android and iOS. | \u003ccode\u003efalse\u003c/code\u003e | 7.19.0 |\n| **`autoSplashscreenTimeout`** | \u003ccode\u003enumber\u003c/code\u003e | Automatically hide the splashscreen after the specified number of milliseconds when using automatic direct updates. If the timeout elapses, the update continues to download in the background while the splashscreen is dismissed. Set to `0` (zero) to disable the timeout. When the timeout fires, the direct update flow is skipped and the downloaded bundle is installed on the next background/launch. Requires {@link autoSplashscreen} to be enabled. Only available for Android and iOS. | \u003ccode\u003e10000 // (10 seconds)\u003c/code\u003e | 7.19.0 |\n| **`periodCheckDelay`** | \u003ccode\u003enumber\u003c/code\u003e | 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). | \u003ccode\u003e0 (disabled)\u003c/code\u003e | |\n| **`localS3`** | \u003ccode\u003eboolean\u003c/code\u003e | Configure the CLI to use a local server for testing or self-hosted update server. | \u003ccode\u003eundefined\u003c/code\u003e | 4.17.48 |\n| **`localHost`** | \u003ccode\u003estring\u003c/code\u003e | Configure the CLI to use a local server for testing or self-hosted update server. | \u003ccode\u003eundefined\u003c/code\u003e | 4.17.48 |\n| **`localWebHost`** | \u003ccode\u003estring\u003c/code\u003e | Configure the CLI to use a local server for testing or self-hosted update server. | \u003ccode\u003eundefined\u003c/code\u003e | 4.17.48 |\n| **`localSupa`** | \u003ccode\u003estring\u003c/code\u003e | Configure the CLI to use a local server for testing or self-hosted update server. | \u003ccode\u003eundefined\u003c/code\u003e | 4.17.48 |\n| **`localSupaAnon`** | \u003ccode\u003estring\u003c/code\u003e | Configure the CLI to use a local server for testing. | \u003ccode\u003eundefined\u003c/code\u003e | 4.17.48 |\n| **`localApi`** | \u003ccode\u003estring\u003c/code\u003e | Configure the CLI to use a local api for testing. | \u003ccode\u003eundefined\u003c/code\u003e | 6.3.3 |\n| **`localApiFiles`** | \u003ccode\u003estring\u003c/code\u003e | Configure the CLI to use a local file api for testing. | \u003ccode\u003eundefined\u003c/code\u003e | 6.3.3 |\n| **`allowModifyUrl`** | \u003ccode\u003eboolean\u003c/code\u003e | Allow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side. | \u003ccode\u003efalse\u003c/code\u003e | 5.4.0 |\n| **`allowModifyAppId`** | \u003ccode\u003eboolean\u003c/code\u003e | Allow the plugin to modify the appId dynamically from the JavaScript side. | \u003ccode\u003efalse\u003c/code\u003e | 7.14.0 |\n| **`allowManualBundleError`** | \u003ccode\u003eboolean\u003c/code\u003e | Allow marking bundles as errored from JavaScript while using manual update flows. When enabled, {@link CapacitorUpdaterPlugin.setBundleError} can change a bundle status to `error`. | \u003ccode\u003efalse\u003c/code\u003e | 7.20.0 |\n| **`persistCustomId`** | \u003ccode\u003eboolean\u003c/code\u003e | Persist the customId set through {@link CapacitorUpdaterPlugin.setCustomId} across app restarts. Only available for Android and iOS. | \u003ccode\u003efalse (will be true by default in a future major release v8.x.x)\u003c/code\u003e | 7.17.3 |\n| **`persistModifyUrl`** | \u003ccode\u003eboolean\u003c/code\u003e | Persist the updateUrl, statsUrl and channelUrl set through {@link CapacitorUpdaterPlugin.setUpdateUrl}, {@link CapacitorUpdaterPlugin.setStatsUrl} and {@link CapacitorUpdaterPlugin.setChannelUrl} across app restarts. Only available for Android and iOS. | \u003ccode\u003efalse\u003c/code\u003e | 7.20.0 |\n| **`allowSetDefaultChannel`** | \u003ccode\u003eboolean\u003c/code\u003e | Allow or disallow the {@link CapacitorUpdaterPlugin.setChannel} method to modify the defaultChannel. When set to `false`, calling `setChannel()` will return an error with code `disabled_by_config`. | \u003ccode\u003etrue\u003c/code\u003e | 7.34.0 |\n| **`defaultChannel`** | \u003ccode\u003estring\u003c/code\u003e | 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. This requires the channel to allow devices to self dissociate/associate in the channel settings. https://capgo.app/docs/public-api/channels/#channel-configuration-options | \u003ccode\u003eundefined\u003c/code\u003e | 5.5.0 |\n| **`appId`** | \u003ccode\u003estring\u003c/code\u003e | Configure the app id for the app in the config. | \u003ccode\u003eundefined\u003c/code\u003e | 6.0.0 |\n| **`keepUrlPathAfterReload`** | \u003ccode\u003eboolean\u003c/code\u003e | Configure the plugin to keep the URL path after a reload. WARNING: When a reload is triggered, 'window.history' will be cleared. | \u003ccode\u003efalse\u003c/code\u003e | 6.8.0 |\n| **`disableJSLogging`** | \u003ccode\u003eboolean\u003c/code\u003e | 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 | \u003ccode\u003efalse\u003c/code\u003e | 7.3.0 |\n| **`osLogging`** | \u003ccode\u003eboolean\u003c/code\u003e | Enable OS-level logging. When enabled, logs are written to the system log which can be inspected in production builds. - **iOS**: Uses os_log instead of Swift.print, logs accessible via Console.app or Instruments - **Android**: Logs to Logcat (android.util.Log) When set to false, system logging is disabled on both platforms (only JavaScript console logging will occur if enabled). This is useful for debugging production apps (App Store/TestFlight builds on iOS, or production APKs on Android). | \u003ccode\u003etrue\u003c/code\u003e | 8.42.0 |\n| **`shakeMenu`** | \u003ccode\u003eboolean\u003c/code\u003e | Enable shake gesture to show update menu for debugging/testing purposes | \u003ccode\u003efalse\u003c/code\u003e | 7.5.0 |\n| **`allowShakeChannelSelector`** | \u003ccode\u003eboolean\u003c/code\u003e | Enable the shake gesture to show a channel selector menu for switching between update channels. When enabled AND `shakeMenu` is true, the shake gesture shows a channel selector instead of the default debug menu (Go Home/Reload/Close). After selecting a channel, the app automatically checks for updates and downloads if available. Only works if channels have `allow_self_set` enabled on the backend. Only available for Android and iOS. | \u003ccode\u003efalse\u003c/code\u003e | 8.43.0 |\n\n### Examples\n\nIn `capacitor.config.json`:\n\n```json\n{\n \"plugins\": {\n \"CapacitorUpdater\": {\n \"appReadyTimeout\": 1000 // (1 second, minimum 1000),\n \"responseTimeout\": 10 // (10 second),\n \"autoDeleteFailed\": false,\n \"autoDeletePrevious\": false,\n \"autoUpdate\": false,\n \"resetWhenUpdate\": false,\n \"updateUrl\": https://example.com/api/auto_update,\n \"channelUrl\": https://example.com/api/channel,\n \"statsUrl\": https://example.com/api/stats,\n \"publicKey\": undefined,\n \"version\": undefined,\n \"directUpdate\": undefined,\n \"autoSplashscreen\": undefined,\n \"autoSplashscreenLoader\": undefined,\n \"autoSplashscreenTimeout\": undefined,\n \"periodCheckDelay\": 3600 (1 hour),\n \"localS3\": undefined,\n \"localHost\": undefined,\n \"localWebHost\": undefined,\n \"localSupa\": undefined,\n \"localSupaAnon\": undefined,\n \"localApi\": undefined,\n \"localApiFiles\": undefined,\n \"allowModifyUrl\": undefined,\n \"allowModifyAppId\": undefined,\n \"allowManualBundleError\": undefined,\n \"persistCustomId\": undefined,\n \"persistModifyUrl\": undefined,\n \"allowSetDefaultChannel\": undefined,\n \"defaultChannel\": undefined,\n \"appId\": undefined,\n \"keepUrlPathAfterReload\": undefined,\n \"disableJSLogging\": undefined,\n \"osLogging\": undefined,\n \"shakeMenu\": undefined,\n \"allowShakeChannelSelector\": undefined\n }\n }\n}\n```\n\nIn `capacitor.config.ts`:\n\n```ts\n/// \u003creference types=\"@capgo/capacitor-updater\" /\u003e\n\nimport { CapacitorConfig } from '@capacitor/cli';\n\nconst config: CapacitorConfig = {\n plugins: {\n CapacitorUpdater: {\n appReadyTimeout: 1000 // (1 second, minimum 1000),\n responseTimeout: 10 // (10 second),\n autoDeleteFailed: false,\n autoDeletePrevious: false,\n autoUpdate: false,\n resetWhenUpdate: false,\n updateUrl: https://example.com/api/auto_update,\n channelUrl: https://example.com/api/channel,\n statsUrl: https://example.com/api/stats,\n publicKey: undefined,\n version: undefined,\n directUpdate: undefined,\n autoSplashscreen: undefined,\n autoSplashscreenLoader: undefined,\n autoSplashscreenTimeout: undefined,\n periodCheckDelay: 3600 (1 hour),\n localS3: undefined,\n localHost: undefined,\n localWebHost: undefined,\n localSupa: undefined,\n localSupaAnon: undefined,\n localApi: undefined,\n localApiFiles: undefined,\n allowModifyUrl: undefined,\n allowModifyAppId: undefined,\n allowManualBundleError: undefined,\n persistCustomId: undefined,\n persistModifyUrl: undefined,\n allowSetDefaultChannel: undefined,\n defaultChannel: undefined,\n appId: undefined,\n keepUrlPathAfterReload: undefined,\n disableJSLogging: undefined,\n osLogging: undefined,\n shakeMenu: undefined,\n allowShakeChannelSelector: undefined,\n },\n },\n};\n\nexport default config;\n```\n\n\u003c/docgen-config\u003e\n\n## API\n\n\u003cdocgen-index\u003e\n\u003c!--Auto-generated, compact index--\u003e\n\n* [`notifyAppReady()`](#notifyappready)\n* [`setUpdateUrl(...)`](#setupdateurl)\n* [`setStatsUrl(...)`](#setstatsurl)\n* [`setChannelUrl(...)`](#setchannelurl)\n* [`download(...)`](#download)\n* [`next(...)`](#next)\n* [`set(...)`](#set)\n* [`delete(...)`](#delete)\n* [`setBundleError(...)`](#setbundleerror)\n* [`list(...)`](#list)\n* [`reset(...)`](#reset)\n* [`current()`](#current)\n* [`reload()`](#reload)\n* [`setMultiDelay(...)`](#setmultidelay)\n* [`cancelDelay()`](#canceldelay)\n* [`getLatest(...)`](#getlatest)\n* [`setChannel(...)`](#setchannel)\n* [`unsetChannel(...)`](#unsetchannel)\n* [`getChannel()`](#getchannel)\n* [`listChannels()`](#listchannels)\n* [`setCustomId(...)`](#setcustomid)\n* [`getBuiltinVersion()`](#getbuiltinversion)\n* [`getDeviceId()`](#getdeviceid)\n* [`getPluginVersion()`](#getpluginversion)\n* [`isAutoUpdateEnabled()`](#isautoupdateenabled)\n* [`removeAllListeners()`](#removealllisteners)\n* [`addListener('download', ...)`](#addlistenerdownload-)\n* [`addListener('noNeedUpdate', ...)`](#addlistenernoneedupdate-)\n* [`addListener('updateCheckResult', ...)`](#addlistenerupdatecheckresult-)\n* [`addListener('updateAvailable', ...)`](#addlistenerupdateavailable-)\n* [`addListener('downloadComplete', ...)`](#addlistenerdownloadcomplete-)\n* [`addListener('breakingAvailable', ...)`](#addlistenerbreakingavailable-)\n* [`addListener('majorAvailable', ...)`](#addlistenermajoravailable-)\n* [`addListener('updateFailed', ...)`](#addlistenerupdatefailed-)\n* [`addListener('set', ...)`](#addlistenerset-)\n* [`addListener('setNext', ...)`](#addlistenersetnext-)\n* [`addListener('downloadFailed', ...)`](#addlistenerdownloadfailed-)\n* [`addListener('appReloaded', ...)`](#addlistenerappreloaded-)\n* [`addListener('appReady', ...)`](#addlistenerappready-)\n* [`addListener('channelPrivate', ...)`](#addlistenerchannelprivate-)\n* [`addListener('onFlexibleUpdateStateChange', ...)`](#addlisteneronflexibleupdatestatechange-)\n* [`isAutoUpdateAvailable()`](#isautoupdateavailable)\n* [`getNextBundle()`](#getnextbundle)\n* [`getFailedUpdate()`](#getfailedupdate)\n* [`setShakeMenu(...)`](#setshakemenu)\n* [`isShakeMenuEnabled()`](#isshakemenuenabled)\n* [`setShakeChannelSelector(...)`](#setshakechannelselector)\n* [`isShakeChannelSelectorEnabled()`](#isshakechannelselectorenabled)\n* [`getAppId()`](#getappid)\n* [`setAppId(...)`](#setappid)\n* [`getAppUpdateInfo(...)`](#getappupdateinfo)\n* [`openAppStore(...)`](#openappstore)\n* [`performImmediateUpdate()`](#performimmediateupdate)\n* [`startFlexibleUpdate()`](#startflexibleupdate)\n* [`completeFlexibleUpdate()`](#completeflexibleupdate)\n* [Interfaces](#interfaces)\n* [Type Aliases](#type-aliases)\n* [Enums](#enums)\n\n\u003c/docgen-index\u003e\n\n\u003cdocgen-api\u003e\n\u003c!--Update the source file JSDoc comments and rerun docgen to update the docs below--\u003e\n\n#### notifyAppReady()\n\n```typescript\nnotifyAppReady() =\u003e Promise\u003cAppReadyResult\u003e\n```\n\nNotify the native layer that JavaScript initialized successfully.\n\n**CRITICAL: You must call this method on every app launch to prevent automatic rollback.**\n\nThis is a simple notification to confirm that your bundle's JavaScript loaded and executed.\nThe native web server successfully served the bundle files and your JS runtime started.\nThat's all it checks - nothing more complex.\n\n**What triggers rollback:**\n- NOT calling this method within the timeout (default: 10 seconds)\n- Complete JavaScript failure (bundle won't load at all)\n\n**What does NOT trigger rollback:**\n- Runtime errors after initialization (API failures, crashes, etc.)\n- Network request failures\n- Application logic errors\n\n**IMPORTANT: Call this BEFORE any network requests.**\nDon't wait for APIs, data loading, or async operations. Call it as soon as your\nJavaScript bundle starts executing to confirm the bundle itself is valid.\n\nBest practices:\n- Call immediately in your app entry point (main.js, app component mount, etc.)\n- Don't put it after network calls or heavy initialization\n- Don't wrap it in try/catch with conditions\n- Adjust {@link PluginsConfig.CapacitorUpdater.appReadyTimeout} if you need more time\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#appreadyresult\"\u003eAppReadyResult\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n#### setUpdateUrl(...)\n\n```typescript\nsetUpdateUrl(options: UpdateUrl) =\u003e Promise\u003cvoid\u003e\n```\n\nSet the update URL for the app dynamically at runtime.\n\nThis overrides the {@link PluginsConfig.CapacitorUpdater.updateUrl} config value.\nRequires {@link PluginsConfig.CapacitorUpdater.allowModifyUrl} to be set to `true`.\n\nUse {@link PluginsConfig.CapacitorUpdater.persistModifyUrl} to persist this value across app restarts.\nOtherwise, the URL will reset to the config value on next app launch.\n\n| Param | Type | Description |\n| ------------- | ----------------------------------------------- | ------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#updateurl\"\u003eUpdateUrl\u003c/a\u003e\u003c/code\u003e | Contains the URL to use for checking for updates. |\n\n**Since:** 5.4.0\n\n--------------------\n\n\n#### setStatsUrl(...)\n\n```typescript\nsetStatsUrl(options: StatsUrl) =\u003e Promise\u003cvoid\u003e\n```\n\nSet the statistics URL for the app dynamically at runtime.\n\nThis overrides the {@link PluginsConfig.CapacitorUpdater.statsUrl} config value.\nRequires {@link PluginsConfig.CapacitorUpdater.allowModifyUrl} to be set to `true`.\n\nPass an empty string to disable statistics gathering entirely.\nUse {@link PluginsConfig.CapacitorUpdater.persistModifyUrl} to persist this value across app restarts.\n\n| Param | Type | Description |\n| ------------- | --------------------------------------------- | ------------------------------------------------------------------------------ |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#statsurl\"\u003eStatsUrl\u003c/a\u003e\u003c/code\u003e | Contains the URL to use for sending statistics, or an empty string to disable. |\n\n**Since:** 5.4.0\n\n--------------------\n\n\n#### setChannelUrl(...)\n\n```typescript\nsetChannelUrl(options: ChannelUrl) =\u003e Promise\u003cvoid\u003e\n```\n\nSet the channel URL for the app dynamically at runtime.\n\nThis overrides the {@link PluginsConfig.CapacitorUpdater.channelUrl} config value.\nRequires {@link PluginsConfig.CapacitorUpdater.allowModifyUrl} to be set to `true`.\n\nUse {@link PluginsConfig.CapacitorUpdater.persistModifyUrl} to persist this value across app restarts.\nOtherwise, the URL will reset to the config value on next app launch.\n\n| Param | Type | Description |\n| ------------- | ------------------------------------------------- | ----------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#channelurl\"\u003eChannelUrl\u003c/a\u003e\u003c/code\u003e | Contains the URL to use for channel operations. |\n\n**Since:** 5.4.0\n\n--------------------\n\n\n#### download(...)\n\n```typescript\ndownload(options: DownloadOptions) =\u003e Promise\u003cBundleInfo\u003e\n```\n\nDownload a new bundle from the provided URL for later installation.\n\nThe downloaded bundle is stored locally but not activated. To use it:\n- Call {@link next} to set it for installation on next app backgrounding/restart\n- Call {@link set} to activate it immediately (destroys current JavaScript context)\n\nThe URL should point to a zip file containing either:\n- Your app files directly in the zip root, or\n- A single folder containing all your app files\n\nThe bundle must include an `index.html` file at the root level.\n\nFor encrypted bundles, provide the `sessionKey` and `checksum` parameters.\nFor multi-file delta updates, provide the `manifest` array.\n\n| Param | Type | Description |\n| ------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#downloadoptions\"\u003eDownloadOptions\u003c/a\u003e\u003c/code\u003e | The {@link \u003ca href=\"#downloadoptions\"\u003eDownloadOptions\u003c/a\u003e} for downloading a new bundle zip. |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#bundleinfo\"\u003eBundleInfo\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n#### next(...)\n\n```typescript\nnext(options: BundleId) =\u003e Promise\u003cBundleInfo\u003e\n```\n\nSet the next bundle to be activated when the app backgrounds or restarts.\n\nThis is the recommended way to apply updates as it doesn't interrupt the user's current session.\nThe bundle will be activated when:\n- The app is backgrounded (user switches away), or\n- The app is killed and relaunched, or\n- {@link reload} is called manually\n\nUnlike {@link set}, this method does NOT destroy the current JavaScript context immediately.\nYour app continues running normally until one of the above events occurs.\n\nUse {@link setMultiDelay} to add additional conditions before the update is applied.\n\n| Param | Type | Description |\n| ------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#bundleid\"\u003eBundleId\u003c/a\u003e\u003c/code\u003e | Contains the ID of the bundle to set as next. Use {@link \u003ca href=\"#bundleinfo\"\u003eBundleInfo.id\u003c/a\u003e} from a downloaded bundle. |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#bundleinfo\"\u003eBundleInfo\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n#### set(...)\n\n```typescript\nset(options: BundleId) =\u003e Promise\u003cvoid\u003e\n```\n\nSet the current bundle and immediately reloads the app.\n\n**IMPORTANT: This is a terminal operation that destroys the current JavaScript context.**\n\nWhen you call this method:\n- The entire JavaScript context is immediately destroyed\n- The app reloads from a different folder with different files\n- NO code after this call will execute\n- NO promises will resolve\n- NO callbacks will fire\n- Event listeners registered after this call are unreliable and may never fire\n\nThe reload happens automatically - you don't need to do anything else.\nIf you need to preserve state like the current URL path, use the {@link PluginsConfig.CapacitorUpdater.keepUrlPathAfterReload} config option.\nFor other state preservation needs, save your data before calling this method (e.g., to localStorage).\n\n**Do not** try to execute additional logic after calling `set()` - it won't work as expected.\n\n| Param | Type | Description |\n| ------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#bundleid\"\u003eBundleId\u003c/a\u003e\u003c/code\u003e | A {@link \u003ca href=\"#bundleid\"\u003eBundleId\u003c/a\u003e} object containing the new bundle id to set as current. |\n\n--------------------\n\n\n#### delete(...)\n\n```typescript\ndelete(options: BundleId) =\u003e Promise\u003cvoid\u003e\n```\n\nDelete a bundle from local storage to free up disk space.\n\nYou cannot delete:\n- The currently active bundle\n- The `builtin` bundle (the version shipped with your app)\n- The bundle set as `next` (call {@link next} with a different bundle first)\n\nUse {@link list} to get all available bundle IDs.\n\n**Note:** The bundle ID is NOT the same as the version name.\nUse the `id` field from {@link \u003ca href=\"#bundleinfo\"\u003eBundleInfo\u003c/a\u003e}, not the `version` field.\n\n| Param | Type | Description |\n| ------------- | --------------------------------------------- | ------------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#bundleid\"\u003eBundleId\u003c/a\u003e\u003c/code\u003e | A {@link \u003ca href=\"#bundleid\"\u003eBundleId\u003c/a\u003e} object containing the bundle ID to delete. |\n\n--------------------\n\n\n#### setBundleError(...)\n\n```typescript\nsetBundleError(options: BundleId) =\u003e Promise\u003cBundleInfo\u003e\n```\n\nManually mark a bundle as failed/errored in manual update mode.\n\nThis is useful when you detect that a bundle has critical issues and want to prevent\nit from being used again. The bundle status will be changed to `error` and the plugin\nwill avoid using this bundle in the future.\n\n**Requirements:**\n- {@link PluginsConfig.CapacitorUpdater.allowManualBundleError} must be set to `true`\n- Only works in manual update mode (when autoUpdate is disabled)\n\nCommon use case: After downloading and testing a bundle, you discover it has critical\nbugs and want to mark it as failed so it won't be retried.\n\n| Param | Type | Description |\n| ------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#bundleid\"\u003eBundleId\u003c/a\u003e\u003c/code\u003e | A {@link \u003ca href=\"#bundleid\"\u003eBundleId\u003c/a\u003e} object containing the bundle ID to mark as errored. |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#bundleinfo\"\u003eBundleInfo\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 7.20.0\n\n--------------------\n\n\n#### list(...)\n\n```typescript\nlist(options?: ListOptions | undefined) =\u003e Promise\u003cBundleListResult\u003e\n```\n\nGet all locally downloaded bundles stored in your app.\n\nThis returns all bundles that have been downloaded and are available locally, including:\n- The currently active bundle\n- The `builtin` bundle (shipped with your app)\n- Any downloaded bundles waiting to be activated\n- Failed bundles (with `error` status)\n\nUse this to:\n- Check available disk space by counting bundles\n- Delete old bundles with {@link delete}\n- Monitor bundle download status\n\n| Param | Type | Description |\n| ------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------ |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#listoptions\"\u003eListOptions\u003c/a\u003e\u003c/code\u003e | The {@link \u003ca href=\"#listoptions\"\u003eListOptions\u003c/a\u003e} for customizing the bundle list output. |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#bundlelistresult\"\u003eBundleListResult\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n#### reset(...)\n\n```typescript\nreset(options?: ResetOptions | undefined) =\u003e Promise\u003cvoid\u003e\n```\n\nReset the app to a known good bundle.\n\nThis method helps recover from problematic updates by reverting to either:\n- The `builtin` bundle (the original version shipped with your app to App Store/Play Store)\n- The last successfully loaded bundle (most recent bundle that worked correctly)\n\n**IMPORTANT: This triggers an immediate app reload, destroying the current JavaScript context.**\nSee {@link set} for details on the implications of this operation.\n\nUse cases:\n- Emergency recovery when an update causes critical issues\n- Testing rollback functionality\n- Providing users a \"reset to factory\" option\n\n| Param | Type |\n| ------------- | ----------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#resetoptions\"\u003eResetOptions\u003c/a\u003e\u003c/code\u003e |\n\n--------------------\n\n\n#### current()\n\n```typescript\ncurrent() =\u003e Promise\u003cCurrentBundleResult\u003e\n```\n\nGet information about the currently active bundle.\n\nReturns:\n- `bundle`: The currently active bundle information\n- `native`: The version of the builtin bundle (the original app version from App/Play Store)\n\nIf no updates have been applied, `bundle.id` will be `\"builtin\"`, indicating the app\nis running the original version shipped with the native app.\n\nUse this to:\n- Display the current version to users\n- Check if an update is currently active\n- Compare against available updates\n- Log the active bundle for debugging\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#currentbundleresult\"\u003eCurrentBundleResult\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n#### reload()\n\n```typescript\nreload() =\u003e Promise\u003cvoid\u003e\n```\n\nManually reload the app to apply a pending update.\n\nThis triggers the same reload behavior that happens automatically when the app backgrounds.\nIf you've called {@link next} to queue an update, calling `reload()` will apply it immediately.\n\n**IMPORTANT: This destroys the current JavaScript context immediately.**\nSee {@link set} for details on the implications of this operation.\n\nCommon use cases:\n- Applying an update immediately after download instead of waiting for backgrounding\n- Providing a \"Restart now\" button to users after an update is ready\n- Testing update flows during development\n\nIf no update is pending (no call to {@link next}), this simply reloads the current bundle.\n\n--------------------\n\n\n#### setMultiDelay(...)\n\n```typescript\nsetMultiDelay(options: MultiDelayConditions) =\u003e Promise\u003cvoid\u003e\n```\n\nConfigure conditions that must be met before a pending update is applied.\n\nAfter calling {@link next} to queue an update, use this method to control when it gets applied.\nThe update will only be installed after ALL specified conditions are satisfied.\n\nAvailable condition types:\n- `background`: Wait for the app to be backgrounded. Optionally specify duration in milliseconds.\n- `kill`: Wait for the app to be killed and relaunched (**Note:** Current behavior triggers update immediately on kill, not on next background. This will be fixed in v8.)\n- `date`: Wait until a specific date/time (ISO 8601 format)\n- `nativeVersion`: Wait until the native app is updated to a specific version\n\nCondition value formats:\n- `background`: Number in milliseconds (e.g., `\"300000\"` for 5 minutes), or omit for immediate\n- `kill`: No value needed\n- `date`: ISO 8601 date string (e.g., `\"2025-12-31T23:59:59Z\"`)\n- `nativeVersion`: Version string (e.g., `\"2.0.0\"`)\n\n| Param | Type | Description |\n| ------------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#multidelayconditions\"\u003eMultiDelayConditions\u003c/a\u003e\u003c/code\u003e | Contains the {@link \u003ca href=\"#multidelayconditions\"\u003eMultiDelayConditions\u003c/a\u003e} array of conditions. |\n\n**Since:** 4.3.0\n\n--------------------\n\n\n#### cancelDelay()\n\n```typescript\ncancelDelay() =\u003e Promise\u003cvoid\u003e\n```\n\nCancel all delay conditions and apply the pending update immediately.\n\nIf you've set delay conditions with {@link setMultiDelay}, this method clears them\nand triggers the pending update to be applied on the next app background or restart.\n\nThis is useful when:\n- User manually requests to update now (e.g., clicks \"Update now\" button)\n- Your app detects it's a good time to update (e.g., user finished critical task)\n- You want to override a time-based delay early\n\n**Since:** 4.0.0\n\n--------------------\n\n\n#### getLatest(...)\n\n```typescript\ngetLatest(options?: GetLatestOptions | undefined) =\u003e Promise\u003cLatestVersion\u003e\n```\n\nCheck the update server for the latest available bundle version.\n\nThis queries your configured update URL (or Capgo backend) to see if a newer bundle\nis available for download. It does NOT download the bundle automatically.\n\nThe response includes:\n- `version`: The latest available version identifier\n- `url`: Download URL for the bundle (if available)\n- `breaking`: Whether this update is marked as incompatible (requires native app update)\n- `message`: Optional message from the server\n- `manifest`: File list for delta updates (if using multi-file downloads)\n\nAfter receiving the latest version info, you can:\n1. Compare it with your current version\n2. Download it using {@link download}\n3. Apply it using {@link next} or {@link set}\n\n**Important: Handling \"no new version available\"**\n\nWhen the device's current version matches the latest version on the server (i.e., the device is already\nup-to-date), the server returns a 200 response with `error: \"no_new_version_available\"` and\n`message: \"No new version available\"`. This is a normal, expected condition and resolves with\n`kind: \"up_to_date\"` when the backend provides that classification.\n\nYou should check `kind` and `error` before attempting to download:\n\n```typescript\nconst latest = await CapacitorUpdater.getLatest();\nif (latest.kind === 'up_to_date') {\n console.log('Already up to date');\n} else if (latest.kind === 'blocked') {\n console.log('Update is blocked:', latest.error);\n} else if (latest.url) {\n // New version is available, proceed with download\n}\n```\n\nIn this scenario, the server:\n- Logs the request with a \"No new version available\" message\n- Sends a \"noNew\" stat action to track that the device checked for updates but was already current (done on the backend)\n\n| Param | Type | Description |\n| ------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#getlatestoptions\"\u003eGetLatestOptions\u003c/a\u003e\u003c/code\u003e | Optional {@link \u003ca href=\"#getlatestoptions\"\u003eGetLatestOptions\u003c/a\u003e} to specify which channel to check. |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#latestversion\"\u003eLatestVersion\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 4.0.0\n\n--------------------\n\n\n#### setChannel(...)\n\n```typescript\nsetChannel(options: SetChannelOptions) =\u003e Promise\u003cChannelRes\u003e\n```\n\nAssign this device to a specific update channel at runtime.\n\nChannels allow you to distribute different bundle versions to different groups of users\n(e.g., \"production\", \"beta\", \"staging\"). This method switches the device to a new channel.\n\n**Requirements:**\n- The target channel must allow self-assignment (configured in your Capgo dashboard or backend)\n- The backend may accept or reject the request based on channel settings\n\n**When to use:**\n- After the app is ready and the user has interacted (e.g., opted into beta program)\n- To implement in-app channel switching (beta toggle, tester access, etc.)\n- For user-driven channel changes\n\n**When NOT to use:**\n- At app boot/initialization - use {@link PluginsConfig.CapacitorUpdater.defaultChannel} config instead\n- Before user interaction\n\n**Important: Listen for the `channelPrivate` event**\n\nWhen a user attempts to set a channel that doesn't allow device self-assignment, the method will\nthrow an error AND fire a {@link addListener}('channelPrivate') event. You should listen to this event\nto provide appropriate feedback to users:\n\n```typescript\nCapacitorUpdater.addListener('channelPrivate', (data) =\u0026gt; {\n console.warn(`Cannot access channel \"${data.channel}\": ${data.message}`);\n // Show user-friendly message\n});\n```\n\nThis sends a request to the Capgo backend linking your device ID to the specified channel.\n\n| Param | Type | Description |\n| ------------- | --------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#setchanneloptions\"\u003eSetChannelOptions\u003c/a\u003e\u003c/code\u003e | The {@link \u003ca href=\"#setchanneloptions\"\u003eSetChannelOptions\u003c/a\u003e} containing the channel name and optional auto-update trigger. |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#channelres\"\u003eChannelRes\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 4.7.0\n\n--------------------\n\n\n#### unsetChannel(...)\n\n```typescript\nunsetChannel(options: UnsetChannelOptions) =\u003e Promise\u003cvoid\u003e\n```\n\nRemove the device's channel assignment and return to the default channel.\n\nThis unlinks the device from any specifically assigned channel, causing it to fall back to:\n- The {@link PluginsConfig.CapacitorUpdater.defaultChannel} if configured, or\n- Your backend's default channel for this app\n\nUse this when:\n- Users opt out of beta/testing programs\n- You want to reset a device to standard update distribution\n- Testing channel switching behavior\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#unsetchanneloptions\"\u003eUnsetChannelOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Since:** 4.7.0\n\n--------------------\n\n\n#### getChannel()\n\n```typescript\ngetChannel() =\u003e Promise\u003cGetChannelRes\u003e\n```\n\nGet the current channel assigned to this device.\n\nReturns information about:\n- `channel`: The currently assigned channel name (if any)\n- `allowSet`: Whether the channel allows self-assignment\n- `status`: Operation status\n- `error`/`message`: Additional information (if applicable)\n\nUse this to:\n- Display current channel to users (e.g., \"You're on the Beta channel\")\n- Check if a device is on a specific channel before showing features\n- Verify channel assignment after calling {@link setChannel}\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#getchannelres\"\u003eGetChannelRes\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 4.8.0\n\n--------------------\n\n\n#### listChannels()\n\n```typescript\nlistChannels() =\u003e Promise\u003cListChannelsResult\u003e\n```\n\nGet a list of all channels available for this device to self-assign to.\n\nOnly returns channels where `allow_self_set` is `true`. These are channels that\nusers can switch to using {@link setChannel} without backend administrator intervention.\n\nEach channel includes:\n- `id`: Unique channel identifier\n- `name`: Human-readable channel name\n- `public`: Whether the channel is publicly visible\n- `allow_self_set`: Always `true` in results (filtered to only self-assignable channels)\n\nUse this to:\n- Build a channel selector UI for users (e.g., \"Join Beta\" button)\n- Show available testing/preview channels\n- Implement channel discovery features\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#listchannelsresult\"\u003eListChannelsResult\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 7.5.0\n\n--------------------\n\n\n#### setCustomId(...)\n\n```typescript\nsetCustomId(options: SetCustomIdOptions) =\u003e Promise\u003cvoid\u003e\n```\n\nSet a custom identifier for this device.\n\nThis allows you to identify devices by your own custom ID (user ID, account ID, etc.)\ninstead of or in addition to the device's unique hardware ID. The custom ID is sent\nto your update server and can be used for:\n- Targeting specific users for updates\n- Analytics and user tracking\n- Debugging and support (correlating devices with users)\n- A/B testing or feature flagging\n\n**Persistence:**\n- When {@link PluginsConfig.CapacitorUpdater.persistCustomId} is `true`, the ID persists across app restarts\n- When `false`, the ID is only kept for the current session\n\n**Clearing the custom ID:**\n- Pass an empty string `\"\"` to remove any stored custom ID\n\n| Param | Type | Description |\n| ------------- | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#setcustomidoptions\"\u003eSetCustomIdOptions\u003c/a\u003e\u003c/code\u003e | The {@link \u003ca href=\"#setcustomidoptions\"\u003eSetCustomIdOptions\u003c/a\u003e} containing the custom identifier string. |\n\n**Since:** 4.9.0\n\n--------------------\n\n\n#### getBuiltinVersion()\n\n```typescript\ngetBuiltinVersion() =\u003e Promise\u003cBuiltinVersion\u003e\n```\n\nGet the builtin bundle version (the original version shipped with your native app).\n\nThis returns the version of the bundle that was included when the app was installed\nfrom the App Store or Play Store. This is NOT the currently active bundle version -\nuse {@link current} for that.\n\nReturns:\n- The {@link PluginsConfig.CapacitorUpdater.version} config value if set, or\n- The native app version from platform configs (package.json, Info.plist, build.gradle)\n\nUse this to:\n- Display the \"factory\" version to users\n- Compare against downloaded bundle versions\n- Determine if any updates have been applied\n- Debugging version mismatches\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#builtinversion\"\u003eBuiltinVersion\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 5.2.0\n\n--------------------\n\n\n#### getDeviceId()\n\n```typescript\ngetDeviceId() =\u003e Promise\u003cDeviceId\u003e\n```\n\nGet the unique, privacy-friendly identifier for this device.\n\nThis ID is used to identify the device when communicating with update servers.\nIt's automatically generated and stored securely by the plugin.\n\n**Privacy \u0026 Security characteristics:**\n- Generated as a UUID (not based on hardware identifiers)\n- Stored securely in platform-specific secure storage\n- Android: Android Keystore (persists across app reinstalls on API 23+)\n- iOS: Keychain with `kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly`\n- Not synced to cloud (iOS)\n- Follows Apple and Google privacy best practices\n- Users can clear it via system settings (Android) or keychain access (iOS)\n\n**Persistence:**\nThe device ID persists across app reinstalls to maintain consistent device identity\nfor update tracking and analytics.\n\nUse this to:\n- Debug update delivery issues (check what ID the server sees)\n- Implement device-specific features\n- Correlate server logs with specific devices\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#deviceid\"\u003eDeviceId\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n#### getPluginVersion()\n\n```typescript\ngetPluginVersion() =\u003e Promise\u003cPluginVersion\u003e\n```\n\nGet the version of the Capacitor Updater plugin installed in your app.\n\nThis returns the version of the native plugin code (Android/iOS), which is sent\nto the update server with each request. This is NOT your app version or bundle version.\n\nUse this to:\n- Debug plugin-specific issues (when reporting bugs)\n- Verify plugin installation and version\n- Check compatibility with backend features\n- Display in debug/about screens\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pluginversion\"\u003ePluginVersion\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n#### isAutoUpdateEnabled()\n\n```typescript\nisAutoUpdateEnabled() =\u003e Promise\u003cAutoUpdateEnabled\u003e\n```\n\nCheck if automatic updates are currently enabled.\n\nReturns `true` if {@link PluginsConfig.CapacitorUpdater.autoUpdate} is enabled,\nmeaning the plugin will automatically check for, download, and apply updates.\n\nReturns `false` if in manual mode, where you control the update flow using\n{@link getLatest}, {@link download}, {@link next}, and {@link set}.\n\nUse this to:\n- Determine which update flow your app is using\n- Show/hide manual update UI based on mode\n- Debug update behavior\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#autoupdateenabled\"\u003eAutoUpdateEnabled\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n#### removeAllListeners()\n\n```typescript\nremoveAllListeners() =\u003e Promise\u003cvoid\u003e\n```\n\nRemove all event listeners registered for this plugin.\n\nThis unregisters all listeners added via {@link addListener} for all event types:\n- `download`\n- `noNeedUpdate`\n- `updateCheckResult`\n- `updateAvailable`\n- `downloadComplete`\n- `downloadFailed`\n- `breakingAvailable` / `majorAvailable`\n- `updateFailed`\n- `appReloaded`\n- `appReady`\n\nUse this during cleanup (e.g., when unmounting components or closing screens)\nto prevent memory leaks from lingering event listeners.\n\n**Since:** 1.0.0\n\n--------------------\n\n\n#### addListener('download', ...)\n\n```typescript\naddListener(eventName: 'download', listenerFunc: (state: DownloadEvent) =\u003e void) =\u003e Promise\u003cPluginListenerHandle\u003e\n```\n\nListen for bundle download event in the App. Fires once a download has started, during downloading and when finished.\nThis will return you all download percent during the download\n\n| Param | Type |\n| ------------------ | --------------------------------------------------------------------------- |\n| **`eventName`** | \u003ccode\u003e'download'\u003c/code\u003e |\n| **`listenerFunc`** | \u003ccode\u003e(state: \u003ca href=\"#downloadevent\"\u003eDownloadEvent\u003c/a\u003e) =\u0026gt; void\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pluginlistenerhandle\"\u003ePluginListenerHandle\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 2.0.11\n\n--------------------\n\n\n#### addListener('noNeedUpdate', ...)\n\n```typescript\naddListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) =\u003e void) =\u003e Promise\u003cPluginListenerHandle\u003e\n```\n\nListen for no need to update event, useful when you want force check every time the app is launched\n\n| Param | Type |\n| ------------------ | ----------------------------------------------------------------------- |\n| **`eventName`** | \u003ccode\u003e'noNeedUpdate'\u003c/code\u003e |\n| **`listenerFunc`** | \u003ccode\u003e(state: \u003ca href=\"#noneedevent\"\u003eNoNeedEvent\u003c/a\u003e) =\u0026gt; void\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pluginlistenerhandle\"\u003ePluginListenerHandle\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 4.0.0\n\n--------------------\n\n\n#### addListener('updateCheckResult', ...)\n\n```typescript\naddListener(eventName: 'updateCheckResult', listenerFunc: (state: UpdateCheckResultEvent) =\u003e void) =\u003e Promise\u003cPluginListenerHandle\u003e\n```\n\nListen for update check results before the updater decides whether to download.\nThe backend can classify the \u003ca href=\"#updatecheckresultevent\"\u003eUpdateCheckResultEvent\u003c/a\u003e payload as `up_to_date`, `blocked`, or `failed`.\n\nThis event is emitted alongside legacy events. For `up_to_date` and `blocked`, it is emitted before\n`noNeedUpdate` and does not emit `downloadFailed`. For `failed`, it is emitted before the legacy\n`downloadFailed` event and keeps the existing failure stats behavior.\n\n| Param | Type |\n| ------------------ | --------------------------------------------------------------------------------------------- |\n| **`eventName`** | \u003ccode\u003e'updateCheckResult'\u003c/code\u003e |\n| **`listenerFunc`** | \u003ccode\u003e(state: \u003ca href=\"#updatecheckresultevent\"\u003eUpdateCheckResultEvent\u003c/a\u003e) =\u0026gt; void\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pluginlistenerhandle\"\u003ePluginListenerHandle\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 8.45.11\n\n--------------------\n\n\n#### addListener('updateAvailable', ...)\n\n```typescript\naddListener(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) =\u003e void) =\u003e Promise\u003cPluginListenerHandle\u003e\n```\n\nListen for available update event, useful when you want to force check every time the app is launched\n\n| Param | Type |\n| ------------------ | ----------------------------------------------------------------------------------------- |\n| **`eventName`** | \u003ccode\u003e'updateAvailable'\u003c/code\u003e |\n| **`listenerFunc`** | \u003ccode\u003e(state: \u003ca href=\"#updateavailableevent\"\u003eUpdateAvailableEvent\u003c/a\u003e) =\u0026gt; void\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pluginlistenerhandle\"\u003ePluginListenerHandle\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 4.0.0\n\n--------------------\n\n\n#### addListener('downloadComplete', ...)\n\n```typescript\naddListener(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) =\u003e void) =\u003e Promise\u003cPluginListenerHandle\u003e\n```\n\nListen for downloadComplete events.\n\n| Param | Type |\n| ------------------ | ------------------------------------------------------------------------------------------- |\n| **`eventName`** | \u003ccode\u003e'downloadComplete'\u003c/code\u003e |\n| **`listenerFunc`** | \u003ccode\u003e(state: \u003ca href=\"#downloadcompleteevent\"\u003eDownloadCompleteEvent\u003c/a\u003e) =\u0026gt; void\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pluginlistenerhandle\"\u003ePluginListenerHandle\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 4.0.0\n\n--------------------\n\n\n#### addListener('breakingAvailable', ...)\n\n```typescript\naddListener(eventName: 'breakingAvailable', listenerFunc: (state: BreakingAvailableEvent) =\u003e void) =\u003e Promise\u003cPluginListenerHandle\u003e\n```\n\nListen for breaking update events when the backend flags an update as incompatible with the current app.\nEmits the same payload as the legacy `majorAvailable` listener.\n\n| Param | Type |\n| ------------------ | --------------------------------------------------------------------------------------- |\n| **`eventName`** | \u003ccode\u003e'breakingAvailable'\u003c/code\u003e |\n| **`listenerFunc`** | \u003ccode\u003e(state: \u003ca href=\"#majoravailableevent\"\u003eMajorAvailableEvent\u003c/a\u003e) =\u0026gt; void\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pluginlistenerhandle\"\u003ePluginListenerHandle\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 7.22.0\n\n--------------------\n\n\n#### addListener('majorAvailable', ...)\n\n```typescript\naddListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) =\u003e void) =\u003e Promise\u003cPluginListenerHandle\u003e\n```\n\nListen for Major update event in the App, let you know when major update is blocked by setting disableAutoUpdateBreaking\n\n| Param | Type |\n| ------------------ | --------------------------------------------------------------------------------------- |\n| **`eventName`** | \u003ccode\u003e'majorAvailable'\u003c/code\u003e |\n| **`listenerFunc`** | \u003ccode\u003e(state: \u003ca href=\"#majoravailableevent\"\u003eMajorAvailableEvent\u003c/a\u003e) =\u0026gt; void\u003c/code\u003e ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcap-go%2Fcapacitor-updater","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcap-go%2Fcapacitor-updater","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcap-go%2Fcapacitor-updater/lists"}