flutter_package / flutter_wakelock

Go to a project
Toggle navigation Toggle navigation pinning
creativecreatorormaybenot
cedf0033 1 parent fdbd2cf6

0.1.2+6

Inline Side-by-side
Showing 5 changed files with 19 additions and 13 deletions
## 0.1.2+6
* Cleaned up Android manifest.
* Changed a test name in `test_driver`.
* Updated description.
* Updated `README.md`.
## 0.1.2+5
* Expanded continuous integration to include format checking and code analysis.
... ...
# Wakelock [![](https://travis-ci.com/creativecreatorormaybenot/wakelock.svg?branch=master)](https://travis-ci.com/creativecreatorormaybenot/wakelock) [![](https://img.shields.io/github/stars/creativecreatorormaybenot/wakelock.svg)](https://github.com/creativecreatorormaybenot/wakelock) [![](https://img.shields.io/pub/v/wakelock.svg)](https://pub.dev/packages/wakelock)
This Flutter plugin allows you to enable and toggle the Android and iOS screen wakelock, which prevents the screen from turning off automatically.
Essentially, this allows you to keep the device awake, i.e. prevent the phone or tablet from sleeping.
This Flutter plugin allows you to enable and toggle the screen wakelock on Android and iOS, which prevents the screen from turning off automatically.
Essentially, this allows you to keep the device awake, i.e. prevent the device from sleeping.
## Usage
... ... @@ -10,7 +10,8 @@ To use this plugin, follow the [installing guide](https://pub.dev/packages/wakel
### Implementation
Everything in this plugin is controlled via the [`Wakelock` class](https://pub.dev/documentation/wakelock/latest/wakelock/Wakelock-class.html).
If you want to enable the wakelock, you can simply call [`Wakelock.enable`](https://pub.dev/documentation/wakelock/latest/wakelock/Wakelock/enable.html) and to disable it, you can use [`Wakelock.disable`](https://pub.dev/documentation/wakelock/latest/wakelock/Wakelock/disable.html):
If you want to enable the wakelock, i.e. keep the device awake, you can simply call [`Wakelock.enable`](https://pub.dev/documentation/wakelock/latest/wakelock/Wakelock/enable.html)
and to disable it again, you can use [`Wakelock.disable`](https://pub.dev/documentation/wakelock/latest/wakelock/Wakelock/disable.html):
```dart
import 'package:wakelock/wakelock.dart';
... ... @@ -23,7 +24,8 @@ Wakelock.enable();
Wakelock.disable();
```
For more advanced usage, you can pass a `bool` to [`Wakelock.toggle`](https://pub.dev/documentation/wakelock/latest/wakelock/Wakelock/toggle.html) to enable or disable the wakelock and also retrieve the current wakelock status using [`Wakelock.isEnabled`](https://pub.dev/documentation/wakelock/latest/wakelock/Wakelock/isEnabled.html):
For more advanced usage, you can pass a `bool` to [`Wakelock.toggle`](https://pub.dev/documentation/wakelock/latest/wakelock/Wakelock/toggle.html) to enable or disable the wakelock
and also retrieve the current wakelock status using [`Wakelock.isEnabled`](https://pub.dev/documentation/wakelock/latest/wakelock/Wakelock/isEnabled.html):
```dart
import 'package:wakelock/wakelock.dart';
... ... @@ -44,7 +46,8 @@ Wakelock.toggle(on: on);
bool isEnabled = await Wakelock.isEnabled;
```
If you want to wait for the wakelock toggle on Android or iOS to complete (which takes an insignificant amount of time), you can also await any of `Wakelock.enable`, `Wakelock.disable`, and `Wakelock.toggle`.
If you want to wait for the wakelock toggle on Android or iOS to complete (which takes an insignificant amount of time),
you can also `await` any of `Wakelock.enable`, `Wakelock.disable`, and `Wakelock.toggle`.
## Notes
... ...
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="wakelock.wakelock">
<!-- <uses-permission android:name="android.permission.WAKE_LOCK" /> -->
</manifest>
<manifest package="wakelock.wakelock"/>
... ...
... ... @@ -10,7 +10,7 @@ void main() {
tearDownAll(() => completer.complete(null));
group('wakelock', () {
test('is disabled on start', () async {
test('is disabled at start', () async {
expect(await Wakelock.isEnabled, false);
});
... ...
name: wakelock
description: This plugin allows you to keep Android and iOS devices awake, i.e. prevent the screen from sleeping by toggling the wakelock of the phone or tablet on or off.
version: 0.1.2+5
description: This plugin allows you to keep Android and iOS devices awake, i.e. prevent the screen from sleeping by toggling the wakelock of the device on or off.
version: 0.1.2+6
author: creativecreatorormaybenot <19204050+creativecreatorormaybenot@users.noreply.github.com>
homepage: https://github.com/creativecreatorormaybenot/wakelock
... ...