playx_version_update library

Classes

ActivityNotFoundError
Error indicating the Android Activity required for the update is not available. This typically happens if the app is in the background.
AppUpdateMangerNotFoundError
Error indicating the Android App Update Manager service is not available on the device. This can happen on devices without Google Play Services or an outdated Play Store.
DefaultFailureError
A generic fallback error when a more specific error message is not available.
InstallApiNotAvailableError
The Play In-App Update API is not available on this device. This might happen if the device doesn't support the feature or has an outdated Play Store.
InstallAppNotOwnedError
The app is not genuinely owned by any user on this device. This typically occurs if the app was installed from an unofficial source (side-loaded APK).
InstallDownloadNotPresentError
The in-app update has not been fully downloaded yet. For flexible updates, ensure the download is complete before attempting to install.
InstallInProgressError
An in-app update installation is already in progress. Please wait for the current update to complete or restart the app.
InstallInternalError
An unexpected internal error occurred within the Google Play Store during installation. Please try again later.
InstallInvalidRequestError
The update request sent by the app is malformed or invalid. This indicates an issue with how the app requested the update.
InstallNotAllowedError
The in-app update download or installation isn't allowed right now. This could be due to issues like low storage, low battery, device overheating, network restrictions, or system security policies.
InstallPlayStoreNotFoundError
The Google Play Store app is either not installed or is not the official version.
InstallUnavailableError
The in-app update is unavailable for this specific user or device. This might happen for restricted profiles or secondary users.
InstallUnknownError
Represents an unhandled or unexpected InstallErrorCode from Kotlin. This captures any future error codes or those not explicitly mapped.
NetworkErrorCode
Stable string codes identifying every NetworkException type.
NotSupportedException
Error indicating the version check encountered an unsupported version.
PlatformNotSupportedError
Error indicating the current platform (e.g., iOS, Web) does not support the requested operation.
PlayxCallbackVersionSource
A PlayxVersionSource backed by a function: the shortest way to read versions from Firebase Remote Config or your own API.
PlayxDownloadInfo
PlayxFallbackVersionSource
Tries sources in order and uses the first one that succeeds.
PlayxInAppUpdateCanceledError
Error indicating the in-app update process was explicitly cancelled by the user. The user likely chose not to proceed with the update.
PlayxInAppUpdateFailedError
Error indicating an in-app update failed for a general, unspecified reason. For more specific installation issues, check the PlayxInstallError types.
PlayxInMemoryUpdateStorage
A PlayxUpdateStorage that keeps values in memory, so they are lost when the app process ends.
PlayxInstallError
Sealed class representing specific errors that can occur during the installation phase of an in-app update on Android.
PlayxNetworkOptions
Settings for the network requests made while checking the store version.
PlayxPlatformValue<T>
A value that can differ per platform, for example a version, a store URL or an app id.
PlayxPlatformVersion
Per-platform version values, for example the latest or the minimum version on Android and on iOS.
PlayxRemoteVersionInfo
Version information returned by a PlayxVersionSource.
PlayxStaticVersionSource
A PlayxVersionSource with fixed values per platform, for example values you read once from your backend or hard-code. Each platform can have its own version, minimum version, release notes and store URL.
PlayxStoreVersionSource
Reads the version from Google Play (Android), the App Store (iOS) or the Mac App Store (macOS). This is the default PlayxVersionSource. Other platforms, and Mac apps distributed outside the Mac App Store, need a custom source.
PlayxUpdateDialog
A platform-adaptive Flutter widget that displays an update dialog.
PlayxUpdateEvents
Callbacks for the update flow, mainly for analytics.
PlayxUpdateInProgressError
Error indicating an update is already in progress, so another one cannot be started.
PlayxUpdateNotAllowedError
Error indicating Google Play does not allow this type of update (flexible or immediate) for this user or device right now.
PlayxUpdateNotAvailableError
Error indicating Google Play has no update to offer for this app right now.
PlayxUpdateOptions
Configuration for version checking.
PlayxUpdatePage
A full-screen Flutter widget designed to prompt users for an app update.
PlayxUpdateReminder
Remembers when the user dismissed or skipped an update, and decides whether the prompt should be shown again.
PlayxUpdateReminderOptions
Configures how the update prompt is suppressed after the user chose "Later" or "Skip this version".
PlayxUpdateStorage
Where PlayxUpdateReminder remembers snoozed and skipped versions.
PlayxUpdateUIOptions
Options for customizing the user interface of Flutter-based update prompts.
PlayxVersionCantUpdateError
Error indicating the app cannot be updated because the new version is not higher than the current one.
PlayxVersionNetworkError
Represents a network-related error encountered during Playx Version Update operations.
PlayxVersionRequest
What a PlayxVersionSource is asked for.
PlayxVersionSource
Where the latest app version comes from.
PlayxVersionUpdate
The main entry point for the Playx Version Update package.
PlayxVersionUpdateError
Sealed class representing all possible errors that can occur during Playx Version Update operations.
PlayxVersionUpdateErrorResult<T>
Represents an error result with an associated error.
PlayxVersionUpdateInfo
Represents comprehensive information about the app's version update status.
PlayxVersionUpdateResult<T>
PlayxVersionUpdateSuccessResult<T>
Represents a successful result with associated data.
Version
Provides immutable storage and comparison of semantic-like version numbers, extended to handle additional numeric components and flexible parsing.
VersionFormatException
Error indicating the version string was not formatted correctly.

Enums

PlayxAppUpdateAvailability
PlayxAppUpdateType
PlayxDownloadStatus
PlayxPlatform
The platforms an app can run on and be updated for.
PlayxPromptSuppressedReason
Why an update prompt was not shown.
PlayxUpdateDismissReason
How the user closed the update UI without updating.
PlayxUpdateDisplayType
Defines the preferred UI presentation for Flutter-based update prompts.

Constants

defaultFailureErrorCode → const String

Typedefs

StoreLauncherCallback = Future<bool> Function(PlayxVersionUpdateInfo info)
Opens the store for info and reports whether it was opened.
UpdateCancelPressedCallback = dynamic Function(PlayxVersionUpdateInfo info)
UpdatePressedCallback = dynamic Function(PlayxVersionUpdateInfo info, LaunchMode launchMode)
UpdateTextInfoCallback = String Function(PlayxVersionUpdateInfo info)

Exceptions / Errors

ApiException
Exception for HTTP responses with an error status code.
AppNotFoundException
Exception for an app that does not exist on the store.
BadCertificateException
Exception for TLS/certificate failures.
BadRequestException
Exception for bad requests (400).
ConflictException
Exception for conflicts (409).
ConsentRequiredException
Google Play showed its cookie-consent page instead of the app page.
DefaultApiException
Default API exception (for unhandled status codes).
EmptyResponseException
Exception for empty responses.
InternalServerErrorException
Exception for internal server errors (500).
InvalidFormatException
Exception for invalid response format.
NetworkException
Base class for network errors that can occur while fetching version information from the App Store or Google Play.
NoInternetConnectionException
Exception for no internet connection.
NotFoundException
Exception for "Not Found" errors (404).
RequestCanceledException
Exception for request cancellation.
RequestTimeoutException
Exception for request timeouts (408, or a connection/receive timeout).
SendTimeoutException
Exception for request send timeout.
ServiceUnavailableException
Exception for service unavailable (502, 503, 504).
TooManyRequestsException
Exception for rate limiting (429).
UnableToProcessException
Exception for unprocessable entity (422).
UnauthorizedRequestException
Exception for unauthorized requests (401, 403).
UnexpectedErrorException
Exception for unexpected errors.