r_upgrade 0.2.3

A plugin for upgrade and install application ,Support Android and IOS.

r_upgrade

Android and IOS upgrade plugin.

中文点此

Getting Started

1. Use Plugin:

add this code in pubspec.yaml

dependencies:
  r_upgrade: last version

2. Upgrade from your website ( Android or IOS )

    void upgradeFromUrl()async{
        bool isSuccess =await RUpgrade.upgradeFromUrl(
                    'https://www.google.com',
                  );
        print(isSuccess);
    }

Android Platform

1. Add Upgrade Download Listener

RUpgrade.stream.listen((DownloadInfo info){
  ///...
});

info:

param	desc
(int) id	download id
(int) max_length ( total Deprecated )	download max bytes length (bytes)
(int) current_length ( progress Deprecated )	download current bytes length (bytes)
(double) percent	download percent 0-100
(double) planTime	download plan time /s (X.toStringAsFixed(0))
(String) path ( address Deprecated )	download file path
(double) speed	download speed kb/s
(DownloadStatus) status	download status STATUS_PAUSED STATUS_PENDING STATUS_RUNNING STATUS_SUCCESSFUL STATUS_FAILED STATUS_CANCEL

2. Upgrade your application

This upgrade have two part. useDownloadManager:

• true: Use system DownloadManagerto download
  • advantage：Simple, use system.
  • Inferiority：can not use http download , can not click the notification pause downloading, can not pause and continue download by network status etc...
• false: Use Service download（default use）
  • advantage：Power, support http/https download, support auto pause and continue download by network status etc..
  • Inferiority：No bugs found yet. If you find a bug, you are welcome to issue

    // [isAutoRequestInstall] downloaded finish will auto request install apk.
    // [apkName] apk name (such as `release.apk`)
    // [notificationVisibility] notification visibility.
    // [useDownloadManager] look up at
    void upgrade() async {
      int id = await RUpgrade.upgrade(
                 'https://raw.githubusercontent.com/rhymelph/r_upgrade/master/apk/app-release.apk',
                 apkName: 'app-release.apk',isAutoRequestInstall: true);
    }

3. Cancel Download

useDownloadManager:

• false: use upgradeor getLastUpgradedId method will return .
• true : use upgrade method will return .

    void cancel() async {
      bool isSuccess=await RUpgrade.cancel(id);
    }

4. Install Apk

useDownloadManager:

• false: use upgradeor getLastUpgradedId method will return .
• true : use upgrade method will return .

    void install() async {
      bool isSuccess=await RUpgrade.install(id);
    }

5. Pause Download(Service)

useDownloadManager:

• false: use upgradeor getLastUpgradedId method will return .

    void pause() async {
      bool isSuccess=await RUpgrade.pause(id);
    }

6. Continue Download(Service)

useDownloadManager:

• false: use upgradeor getLastUpgradedId method will return .

    void pause() async {
      bool isSuccess=await RUpgrade.upgradeWithId(id);
      /// return true.
      /// * if download status is [STATUS_PAUSED] or [STATUS_FAILED] or [STATUS_CANCEL], will restart running.
      /// * if download status is [STATUS_RUNNING] or [STATUS_PENDING], nothing happened.
      /// * if download status is [STATUS_SUCCESSFUL] , will install apk.
      ///
      /// return false.
      /// * if not found the id , will return [false].
    }

7. Get the last upgrade id(Service)

this method will find id by your application version name and version code.

    void getLastUpgradeId() async {
     int id = await RUpgrade.getLastUpgradedId();
    }

8. Get the download status from id(Service)

useDownloadManager:

• false: use upgradeor getLastUpgradedId method will return .

    void getDownloadStatus()async{
    DownloadStatus status = await RUpgrade.getDownloadStatus(id);
   }

9.your application is ios.You can use this.

    void iosUpgrade(String url)async{
      RUpgrade.appStore(url);
    }

10. Hot Upgrade ( use DownloadManager )

• you can use this id to hot upgrade,but download file is zip. include three file [isolate_snapshot_data]、[kernel_blob.bin]、[vm_snapshot_data].Your can use flutter build bundle generate.

 flutter build bundle

generate file path form ./build/flutter_assets and packaged into zip.

|- AssetManifest.json
|- FontManifest.json
|- fonts
    |- ...
|- isolate_snapshot_data *
|- kernel-blob.bin       *
|- LICENSE
|- packages
    |- ...
|- vm_snapshot_data      *

download complete you can use download id to hot upgrade

           bool isSuccess = await RUpgrade.hotUpgrade(id);
           if (isSuccess) {
              _state.currentState
                    .showSnackBar(SnackBar(content: Text('热更新成功，3s后退出应用，请重新进入')));
                Future.delayed(Duration(seconds: 3)).then((_){
                  SystemNavigator.pop(animated: true);
                });
           }else{
              _state.currentState
                    .showSnackBar(SnackBar(content: Text('热更新失败，请等待更新包下载完成')));
              }

if your application is Android,make sure your application had this permission and request dynamic permission.

    <uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

At present, the hot update is still in the testing stage, only supporting the change of the flutter code, not supporting the resource file, etc. the author of the plug-in is not responsible for all the consequences caused by the hot update, and the user is responsible for it.

IOS Platform

1.Go to the AppStore Upgrade

    void upgradeFromAppStore() async {
        bool isSuccess =await RUpgrade.upgradeFromAppStore(
                 'your AppId',//such as:WeChat AppId:414478124
              );
        print(isSuccess);
    }

2.Get the last version form AppStore

    void getVersionFromAppStore() async {
        String versionName = await RUpgrade.getVersionFromAppStore(
                'your AppId',//such as:WeChat AppId:414478124
               );
        print(versionName);
    }