{"id":18339867,"url":"https://github.com/rnkit/rnkit-in-app-update","last_synced_at":"2025-09-08T23:38:19.151Z","repository":{"id":135844623,"uuid":"97190379","full_name":"rnkit/rnkit-in-app-update","owner":"rnkit","description":"InApp Update apk","archived":false,"fork":false,"pushed_at":"2018-01-08T09:57:48.000Z","size":13,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-15T12:49:13.883Z","etag":null,"topics":["inapp-update","rnkit","update"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rnkit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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}},"created_at":"2017-07-14T03:45:11.000Z","updated_at":"2017-07-14T06:03:55.000Z","dependencies_parsed_at":"2023-04-04T09:04:30.589Z","dependency_job_id":null,"html_url":"https://github.com/rnkit/rnkit-in-app-update","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rnkit%2Frnkit-in-app-update","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rnkit%2Frnkit-in-app-update/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rnkit%2Frnkit-in-app-update/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rnkit%2Frnkit-in-app-update/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rnkit","download_url":"https://codeload.github.com/rnkit/rnkit-in-app-update/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248109283,"owners_count":21049281,"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","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":["inapp-update","rnkit","update"],"created_at":"2024-11-05T20:19:40.170Z","updated_at":"2025-04-09T20:38:50.704Z","avatar_url":"https://github.com/rnkit.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![npm][npm-badge]][npm]\n[![react-native][rn-badge]][rn]\n[![MIT][license-badge]][license]\n[![bitHound Score][bithound-badge]][bithound]\n[![Downloads](https://img.shields.io/npm/dm/rnkit-in-app-update.svg)](https://www.npmjs.com/package/rnkit-in-app-update)\n\nInApp Update for react-native for [React Native][rn].\n\n[**Support me with a Follow**](https://github.com/simman/followers)\n\n[npm-badge]: https://img.shields.io/npm/v/rnkit-in-app-update.svg\n[npm]: https://www.npmjs.com/package/rnkit-in-app-update\n[rn-badge]: https://img.shields.io/badge/react--native-v0.40-05A5D1.svg\n[rn]: https://facebook.github.io/react-native\n[license-badge]: https://img.shields.io/dub/l/vibe-d.svg\n[license]: https://raw.githubusercontent.com/rnkit/rnkit-in-app-update/master/LICENSE\n[bithound-badge]: https://www.bithound.io/github/rnkit/rnkit-in-app-update/badges/score.svg\n[bithound]: https://www.bithound.io/github/rnkit/rnkit-in-app-update\n\n## Getting Started\n\nFirst, `cd` to your RN project directory, and install RNMK through [rnpm](https://github.com/rnpm/rnpm) . If you don't have rnpm, you can install RNMK from npm with the command `npm i -S rnkit-in-app-update` and link it manually (see below).\n\n### Android\n\n* #### React Native \u003c 0.29 (Using rnpm)\n\n  `rnpm install rnkit-in-app-update`\n\n* #### React Native \u003e= 0.29\n  `$npm install -S rnkit-in-app-update`\n\n  `$react-native link rnkit-in-app-update`\n\n#### Manually\n1. JDK 7+ is required\n1. Add the following snippet to your `android/settings.gradle`:\n\n  ```gradle\ninclude ':rnkit-in-app-update'\nproject(':rnkit-in-app-update').projectDir = new File(rootProject.projectDir, '../node_modules/rnkit-in-app-update/android/app')\n  ```\n  \n1. Declare the dependency in your `android/app/build.gradle`\n  \n  ```gradle\n  dependencies {\n      ...\n      compile project(':rnkit-in-app-update')\n  }\n  ```\n  \n1. Import `import io.rnkit.inappupdate.InAppUpdatePackage;` and register it in your `MainActivity` (or equivalent, RN \u003e= 0.32 MainApplication.java):\n\n  ```java\n  @Override\n  protected List\u003cReactPackage\u003e getPackages() {\n      return Arrays.asList(\n              new MainReactPackage(),\n              new InAppUpdatePackage()\n      );\n  }\n  ```\n\nFinally, you're good to go, feel free to require `rnkit-in-app-update` in your JS files.\n\nHave fun! :metal:\n\n## Basic Usage\n\nImport library\n\n```\nimport InAppUpdate from 'rnkit-in-app-update'\n```\n\n\n## Contribution\n\n- [@ws123](https://github.com/ws123) The main author.\n- [@simamn](mailto:liwei0990@gmail.com)\n\n## Thanks\n\n[@yjfnypeu](https://github.com/yjfnypeu) - [UpdatePlugin](https://github.com/yjfnypeu/UpdatePlugin)\n\n# Api\n\n```\n/**\n * 获取安卓的metadata信息, 主要用于获取渠道号\n * @param {String} [required] key 对应的key\n */\nasync getAppMetaData(key);\n\n/**\n * 下载Apk文件\n * @param {Object} options 下载参数\n * ------- options ---------\n * @param {String} [required] url apk 下载地址\n * @param {String} [required] version 版本号\n * @param {String} algorithm 可选(md5, etag), 当文件下载完成后会返回对应的值\n * @param {Bool} isForce 为true的情况下，会忽略网络条件和下载策略\n * @param {Bool} strategy 0默认，表示只判断当前环境，如果是wifi就下载，否则就不下载, 1表示监听wifi，如果当前是wifi就下载，如果当前不是wifi，就监听网络变化，如果在程序运行期间，切换到了wifi，就提示用户下载\n */\ndownloadApk(options);\n\n/**\n * 安卓应用\n */\ninstallApk();\n\n/**\n * 暂停下载\n * 调用此方法, 系统会发送事件RNKitApkDownloadPause, type: manual\n */\npauseDownload();\n\n/**\n * 继续下载\n */\ndownloadResume();\n\n--------------- 新增事件回调 ------------\n开始下载： RNKitApkStartDownload\n下载进度： RNKitApkDownloadProgress, return params{received, total}\n下载错误: RNKitApkDownloadError, return params{errorMsg}\n下载被暂停了: RNKitApkDownloadPause, return params{type}, type: (manual, network)\n下载完成了: RNKitApkDownloadComplete, return params{md5, etag, path, success}\n\n```\n\n\n## Questions\n\nFeel free to [contact me](mailto:liwei0990@gmail.com) or [create an issue](https://github.com/rnkit/rnkit-in-app-update/issues/new)\n\n\u003e made with ♥","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frnkit%2Frnkit-in-app-update","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frnkit%2Frnkit-in-app-update","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frnkit%2Frnkit-in-app-update/lists"}