Skip to content

docs(package_info_plus): add installerStore values documentation #3721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+43 −0
Open

docs(package_info_plus): add installerStore values documentation #3721

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions packages/package_info_plus/package_info_plus/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,49 @@ String version = packageInfo.version;
String buildNumber = packageInfo.buildNumber;
```

## Installer Store

The `installerStore` property indicates which app store installed the application. This is useful for directing users to the appropriate store page for ratings or updates.

```dart
String? installerStore = packageInfo.installerStore;
```

### iOS

On iOS, the `installerStore` value is determined by checking the app store receipt path:

| Environment | `installerStore` value |
|-------------|------------------------|
| App Store | `com.apple` |
| TestFlight | `com.apple.testflight` |
| Simulator | `com.apple.simulator` |

### Android

On Android, the value is the package name of the app store that installed the application, obtained via `PackageManager.getInstallSourceInfo()` (Android 11+) or `PackageManager.getInstallerPackageName()` (older versions).

| Store | `installerStore` value |
|-------|------------------------|
| Google Play Store | `com.android.vending` |
| Amazon Appstore | `com.amazon.venezia` |
| Samsung Galaxy Store | `com.sec.android.app.samsungapps` |
| Huawei AppGallery | `com.huawei.appmarket` |
| Xiaomi GetApps | `com.xiaomi.mipicks` |
| OPPO App Market | `com.oppo.market` |
| VIVO App Store | `com.vivo.appstore` |
| Manual/ADB install | `null` |

**Note:** Some stores may not properly implement the installer package name API, which could result in `null` being returned even for store installations.

### macOS

On macOS, `installerStore` always returns `null` as there is no reliable way to detect the installation source.

### Other Platforms

On Linux, Windows, and Web, `installerStore` returns `null`.

## Known Issues

### iOS
Expand Down