blob: b5b2405a231a77c90ecba289b1572f0c2ecf0be8 [file] [log] [blame] [view]
# PackageInfo
This Flutter plugin provides an API for querying information about an
application package.
**Please set your constraint to `package_info: '>=0.4.y+x <2.0.0'`**
## Backward compatible 1.0.0 version is coming
The package_info plugin has reached a stable API, we guarantee that version `1.0.0` will be backward compatible with `0.4.y+z`.
Please use `package_info: '>=0.4.y+x <2.0.0'` as your dependency constraint to allow a smoother ecosystem migration.
For more details see: https://github.com/flutter/flutter/wiki/Package-migration-to-1.0.0
# Usage
You can use the PackageInfo to query information about the
application package. This works both on iOS and Android.
```dart
import 'package:package_info/package_info.dart';
PackageInfo packageInfo = await PackageInfo.fromPlatform();
String appName = packageInfo.appName;
String packageName = packageInfo.packageName;
String version = packageInfo.version;
String buildNumber = packageInfo.buildNumber;
```
Or in async mode:
```dart
PackageInfo.fromPlatform().then((PackageInfo packageInfo) {
String appName = packageInfo.appName;
String packageName = packageInfo.packageName;
String version = packageInfo.version;
String buildNumber = packageInfo.buildNumber;
});
```
## Known Issue
As noted on [issue 20761](https://github.com/flutter/flutter/issues/20761#issuecomment-493434578), package_info on iOS
requires the Xcode build folder to be rebuilt after changes to the version string in `pubspec.yaml`.
Clean the Xcode build folder with:
`XCode Menu -> Product -> (Holding Option Key) Clean build folder`.
## Issues and feedback
Please file [issues](https://github.com/flutter/flutter/issues/new) to send feedback or report a bug. Thank you!