Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/g123k/flutter_plugin_install_referrer
Detect from where your Flutter application was installed (Google Play, App Store, TestFlight…)
https://github.com/g123k/flutter_plugin_install_referrer
android dart flutter ios
Last synced: 13 days ago
JSON representation
Detect from where your Flutter application was installed (Google Play, App Store, TestFlight…)
- Host: GitHub
- URL: https://github.com/g123k/flutter_plugin_install_referrer
- Owner: g123k
- License: apache-2.0
- Created: 2022-03-22T19:40:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-12T14:12:38.000Z (4 months ago)
- Last Synced: 2024-10-13T11:44:49.493Z (27 days ago)
- Topics: android, dart, flutter, ios
- Language: Dart
- Homepage: https://pub.dev/packages/install_referrer
- Size: 95.7 KB
- Stars: 20
- Watchers: 1
- Forks: 17
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# install_referrer
[](https://pub.dartlang.org/packages/install_referrer)
A Flutter plugin that allows you to detect how your application was installed.
## Supported platforms
- Android: ✅
- iOS: ✅
Feel free to open a PR to support new platforms.
## Installation
1. Add `install_referrer: ^1.2.1` to your `pubspec.yaml` file.
2. Import `import 'package:install_referrer/install_referrer.dart';`
3. Get the value by invoking the `Future` `InstallReferrer.referrer`
## Possibles values
### Android
| Store | Value |
|--------------------|---------------------------------------------------|
| Google Play | `InstallationAppReferrer.androidGooglePlay` |
| Amazon App Store | `InstallationAppReferrer.androidAmazonAppStore` |
| Huawei App Gallery | `InstallationAppReferrer.androidHuaweiAppGallery` |
| Oppo App Market | `InstallationAppReferrer.androidOppoAppMarket` |
| Samsung App Shop | `InstallationAppReferrer.androidSamsungAppShop` |
| Vivo App Store | `InstallationAppReferrer.androidVivoAppStore` |
| Xiaomi App Store | `InstallationAppReferrer.androidXiaomiAppStore` |
| Others | `InstallationAppReferrer.androidManually` |
If the application was installed from a third party app (eg: GMail, Google Drive, Chrome…), it will be considered as a **manual installation** (`InstallationAppReferrer.androidManually`).
If the application was installed from a store (FDroid, Amazon App Shop…) which was not preinstalled on the device (a _"non-system"_ app), it will also be considered as a **manual installation** (`InstallationAppReferrer.androidManually`).
If the Android application is in debug mode, it will be marked as `InstallationAppReferrer.androidDebug`.
### iOS
| Store | Value |
|------------------|--------------------------------------------------|
| App Store | `InstallationAppReferrer.iosAppStore` |
| Test Flight | `InstallationAppReferrer.iosTestFlight` |
If the iOS application is in debug mode (eg: from the simulator), it will be marked as `InstallationAppReferrer.iosDebug`.
## Package name
You can also get the package name (Android) or app id (iOS), by calling instead `InstallReferrer.app`
## Widgets
If you want to receive the result directly in a Widget, you have two choices: `InstallReferrerDetectorListener` and `InstallReferrerDetectorBuilder` :
```dart
InstallReferrerDetectorBuilder(
builder: (BuildContext context, InstallationApp? app) {
if (app == null) {
return const CircularProgressIndicator.adaptive();
} else {
return Text(
'Package name:\n${app.packageName ?? 'Unknown'}\n'
'Referrer:\n${referrerToReadableString(app.referrer)}',
textAlign: TextAlign.center,
);
}
},
);
```
```dart
InstallReferrerDetectorListener(
child: YourWidget(),
onReferrerAvailable: (InstallationApp? app) {
// TODO
},
);
```