manup 0.0.3

Mandatory update for Flutter Apps.

Mandatory Update

Sometimes you have an app which talks to services in the cloud. Sometimes, those services change, and your app no longer works. Wouldn't it be great if the app could let the user know there's an update? That's what this module does.

Usage

Remote File

You need a hosted json file that contains the version metadata. This could be part of your API. However, often the reason for maintenance mode is because your API is down. An s3 bucket may be a safer bet, even though it means a little more work in maintaining the file.

{
  "ios": {
    "latest": "2.4.1",
    "minimum": "2.1.0",
    "url": "http://example.com/myAppUpdate",
    "enabled": true
  },
  "android": {
    "latest": "2.5.1",
    "minimum": "2.1.0",
    "url": "http://example.com/myAppUpdate/android",
    "enabled": true
  }
}

copied to clipboard

Using the Service Directly

You can use ManUpService directly in your code. As part of your app startup logic, use the service to validate the running version.

ManUpService service = ManUpService('https://example.com/manup.json');
ManUpStatus result = await service.validate();

copied to clipboard

ManUpStatus will let you know how the version of the app running compares to the metadata:

• latest: The app is the latest version
• supported: The app is a supported version, but not the latest
• unsupported: The app is an unsupported version and should not run
• disabled: The app has been marked as disabled and should not run

Exception Handling

validate will throw a ManUpException if the lookup failed for any reason. Most likely, this will be caused by the device being offline and unable to retreive the metadata. It is up to you how you want to handle this in your app. Some apps, where a supported version is critical, should probably not run unless the version was validated successfully. However, for other apps, there's probably no problem and the app should continue running.