PlayxVersionUpdate class abstract
The main entry point for the Playx Version Update package.
This utility class provides static methods to:
- Check for app updates against the Google Play Store and Apple App Store.
- Display customizable update dialogs and pages.
- Handle native in-app updates on Android.
- Open the app's store page.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
checkVersion(
{PlayxUpdateOptions options = const PlayxUpdateOptions()}) → Future< PlayxVersionUpdateResult< PlayxVersionUpdateInfo> > - Checks the app's version against the appropriate app store.
-
completeFlexibleUpdate(
) → Future< PlayxVersionUpdateResult< bool> > - Completes and installs a downloaded flexible in-app update.
-
getAppBuildNumber(
) → Future< String> - Retrieves the current build number (or build code) of the app.
-
getAppVersion(
) → Future< String> -
Retrieves the current version name of the app from its
pubspec.yamlfile. -
getUpdateAvailability(
) → Future< PlayxVersionUpdateResult< PlayxAppUpdateAvailability> > - Checks if an update is available for the app.
-
getUpdatePriority(
) → Future< PlayxVersionUpdateResult< int> > - Retrieves the priority level of an available in-app update.
-
getUpdateStalenessDays(
) → Future< PlayxVersionUpdateResult< int> > - Retrieves the number of days since an update became available on the Play Store.
-
isFlexibleUpdateNeedToBeInstalled(
) → Future< PlayxVersionUpdateResult< bool> > - Checks if a flexible in-app update has been downloaded and is ready for installation.
-
isUpdateAllowed(
{required PlayxAppUpdateType type}) → Future< PlayxVersionUpdateResult< bool> > - Checks if the platform currently allows a specific type of in-app update.
-
listenToFlexibleDownloadUpdate(
) → Stream< PlayxDownloadInfo?> - Monitors the progress and state of a flexible in-app update download.
-
openStore(
{String? storeUrl, PlayxUpdateOptions options = const PlayxUpdateOptions(), LaunchMode launchMode = LaunchMode.externalApplication, bool preferStoreApp = true}) → Future< PlayxVersionUpdateResult< bool> > - Opens the app's page on the Google Play Store or Apple App Store.
-
refreshInAppUpdate(
) → Future< PlayxVersionUpdateResult< bool> > - Refreshes the internal state of the in-app update manager.
-
showInAppUpdateDialog(
{required BuildContext context, required PlayxAppUpdateType type, PlayxUpdateOptions iosOptions = const PlayxUpdateOptions(), PlayxUpdateUIOptions iosUiOptions = const PlayxUpdateUIOptions(), PlayxUpdateReminderOptions? iosReminderOptions, PlayxUpdateEvents? events}) → Future< PlayxVersionUpdateResult< bool> > - Initiates and displays an in-app update flow for both Android and iOS platforms.
-
showUpdateDialog(
{required BuildContext context, PlayxUpdateOptions options = const PlayxUpdateOptions(), PlayxUpdateUIOptions uiOptions = const PlayxUpdateUIOptions(), PlayxUpdateReminderOptions? reminderOptions}) → Future< PlayxVersionUpdateResult< bool> > - Checks for an update and displays a platform-adaptive dialog or page if one is available.
-
startFlexibleUpdate(
) → Future< PlayxVersionUpdateResult< bool> > - Initiates a flexible in-app update flow.
-
startImmediateUpdate(
) → Future< PlayxVersionUpdateResult< bool> > - Initiates an immediate in-app update flow.