64 lines
3.2 KiB
TypeScript
64 lines
3.2 KiB
TypeScript
import { type EventSubscription } from 'expo-modules-core';
|
|
import { KeepAwakeListener, KeepAwakeOptions } from './KeepAwake.types';
|
|
/** Default tag, used when no tag has been specified in keep awake method calls. */
|
|
export declare const ExpoKeepAwakeTag = "ExpoKeepAwakeDefaultTag";
|
|
/** @returns `true` on all platforms except [unsupported web browsers](https://caniuse.com/wake-lock). */
|
|
export declare function isAvailableAsync(): Promise<boolean>;
|
|
/**
|
|
* A React hook to keep the screen awake for as long as the owner component is mounted.
|
|
* The optionally provided `tag` argument is used when activating and deactivating the keep-awake
|
|
* feature. If unspecified, an ID unique to the owner component is used. See the documentation for
|
|
* `activateKeepAwakeAsync` below to learn more about the `tag` argument.
|
|
*
|
|
* @param tag Tag to lock screen sleep prevention. If not provided, an ID unique to the owner component is used.
|
|
* @param options Additional options for the keep awake hook.
|
|
*/
|
|
export declare function useKeepAwake(tag?: string, options?: KeepAwakeOptions): void;
|
|
/**
|
|
* Prevents the screen from sleeping until `deactivateKeepAwake` is called with the same `tag` value.
|
|
*
|
|
* If the `tag` argument is specified, the screen will not sleep until you call `deactivateKeepAwake`
|
|
* with the same `tag` argument. When using multiple `tags` for activation you'll have to deactivate
|
|
* each one in order to re-enable screen sleep. If tag is unspecified, the default `tag` is used.
|
|
*
|
|
* Web support [is limited](https://caniuse.com/wake-lock).
|
|
*
|
|
* @param tag Tag to lock screen sleep prevention. If not provided, the default tag is used.
|
|
* @deprecated use `activateKeepAwakeAsync` instead.
|
|
*/
|
|
export declare function activateKeepAwake(tag?: string): Promise<void>;
|
|
/**
|
|
* Prevents the screen from sleeping until `deactivateKeepAwake` is called with the same `tag` value.
|
|
*
|
|
* If the `tag` argument is specified, the screen will not sleep until you call `deactivateKeepAwake`
|
|
* with the same `tag` argument. When using multiple `tags` for activation you'll have to deactivate
|
|
* each one in order to re-enable screen sleep. If tag is unspecified, the default `tag` is used.
|
|
*
|
|
* Web support [is limited](https://caniuse.com/wake-lock).
|
|
*
|
|
* @param tag Tag to lock screen sleep prevention. If not provided, the default tag is used.
|
|
*/
|
|
export declare function activateKeepAwakeAsync(tag?: string): Promise<void>;
|
|
/**
|
|
* Releases the lock on screen-sleep prevention associated with the given `tag` value. If `tag`
|
|
* is unspecified, it defaults to the same default tag that `activateKeepAwake` uses.
|
|
*
|
|
* @param tag Tag to release the lock on screen sleep prevention. If not provided,
|
|
* the default tag is used.
|
|
*/
|
|
export declare function deactivateKeepAwake(tag?: string): Promise<void>;
|
|
/**
|
|
* Observe changes to the keep awake timer.
|
|
* On web, this changes when navigating away from the active window/tab. No-op on native.
|
|
* @platform web
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* KeepAwake.addListener(({ state }) => {
|
|
* // ...
|
|
* });
|
|
* ```
|
|
*/
|
|
export declare function addListener(tagOrListener: string | KeepAwakeListener, listener?: KeepAwakeListener): EventSubscription;
|
|
export * from './KeepAwake.types';
|
|
//# sourceMappingURL=index.d.ts.map
|