blob: e1a42571c6b332c81d595945bcdb65a61f17b8f6 [file] [view]
# battery_platform_interface
A common platform interface for the [`battery`][1] plugin.
This interface allows platform-specific implementations of the `battery`
plugin, as well as the plugin itself, to ensure they are supporting the
same interface.
# Usage
To implement a new platform-specific implementation of `battery`, extend
[`BatteryPlatform`][2] with an implementation that performs the
platform-specific behavior, and when you register your plugin, set the default
`BatteryPlatform` by calling
`BatteryPlatform.instance = MyPlatformBattery()`.
# Note on breaking changes
Strongly prefer non-breaking changes (such as adding a method to the interface)
over breaking changes for this package.
See https://flutter.dev/go/platform-interface-breaking-changes for a discussion
on why a less-clean interface is preferable to a breaking change.
[1]: ../battery
[2]: lib/battery_platform_interface.dart