PlayxUpdateOptions class
Configuration for version checking.
Constructors
-
PlayxUpdateOptions({String? localVersion, String? newVersion, String? minVersion, @Deprecated('Use versionSource: PlayxStaticVersionSource(version: ...) instead.') PlayxPlatformVersion? newPlatformVersion, @Deprecated('Use versionSource: PlayxStaticVersionSource(version: ...) instead.') PlayxPlatformVersion? minPlatformVersion, bool? forceUpdate, @Deprecated('Use appIds: PlayxPlatformValue(android: ...) instead.') String? androidPackageName, @Deprecated('Use appIds: PlayxPlatformValue(ios: ...) instead.') String? iosBundleId, String country = 'us', String language = 'en', bool enableNetworkLogging = false, PlayxNetworkOptions networkOptions = const PlayxNetworkOptions(), PlayxVersionSource? versionSource, PlayxPlatformValue<
String> ? appIds, PlayxPlatformValue<String> ? storeUrls}) -
const
Properties
- androidPackageName → String?
-
The app's package name on the Google Play Store (e.g., 'com.example.app').
If not provided, it's fetched from
package_info_plus.final -
appIds
→ PlayxPlatformValue<
String> ? -
The app's id on each platform: the Google Play package name, the App
Store bundle id, or the identifier used by another platform's store.
Set every platform once; the package uses the one of the current
platform. Platforms without a value fall back to androidPackageName /
iosBundleId, then to the id read from the app itself.
final
- country → String
-
The two-letter country code for the store country. Defaults to 'us'.
final
- enableNetworkLogging → bool
-
Whether to log the version-check network traffic to the console:
request method, URL and headers, response status, headers, timing and a
short body preview, plus errors and retries. Sensitive headers are masked.
final
- forceUpdate → bool?
-
Manually set the force update status.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- iosBundleId → String?
-
The app's bundle ID on the Apple App Store (e.g., 'com.example.app').
If not provided, it's fetched from
package_info_plus.final - language → String
-
The two-letter language code for store details. Defaults to 'en'.
final
- localVersion → String?
-
The current version of the app. If not provided, it's fetched from
package_info_plus.final - minPlatformVersion → PlayxPlatformVersion?
-
Platform-specific minimum required app versions, typically provided by a custom backend.
final
- minVersion → String?
-
The minimum required version for the app to run.
final
- networkOptions → PlayxNetworkOptions
-
Settings for the store request: retries, timeouts, headers, a custom
Dioinstance and cancellation. See PlayxNetworkOptions.final - newPlatformVersion → PlayxPlatformVersion?
-
Platform-specific new app versions, typically provided by a custom backend.
final
- newVersion → String?
-
The new version to compare against.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
storeUrls
→ PlayxPlatformValue<
String> ? -
Where users update the app, per platform. Any scheme works (
https://,market://, a marketing short link). Set every platform once; the package uses the one of the current platform.final - versionSource → PlayxVersionSource?
-
Where the latest version comes from. Defaults to the store
(
PlayxStoreVersionSource). UsePlayxCallbackVersionSourcefor Firebase Remote Config or your own backend, andPlayxFallbackVersionSourceto chain several. Values set directly on these options (newVersion,minVersion, the platform overrides,forceUpdate) always win over it.final
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