原子操作

飞道科技

@dfeidao/atom-wxapp > api_quipment设备相关

External module: api_quipment设备相关

Index

Functions


Functions

get_beacons

get_beacons(): Promise<object>

Defined in api/equipment/get-beacons.ts:14

获取所有已搜索到的 iBeacon 设备

see: 微信官方文档

example:

import get_beacons from '@dfeidao/atom-wxapp/api/equipment/get-beacons';
await get_beacons();

Returns: Promise<object>


get_clipboard_data

get_clipboard_data(): Promise<DataResponse>

Defined in api/equipment/get-clipboard-data.ts:14

获取系统剪贴板的内容

see: 微信官方文档

example:

import get_clipboard_data from '@dfeidao/atom-wxapp/api/equipment/get-clipboard-data';
const res = await get_clipboard_data();

Returns: Promise<DataResponse>


get_screen_brightness

get_screen_brightness(): Promise<number>

Defined in api/equipment/get-screen-brightness.ts:14

获取屏幕亮度

see: 微信官方文档

example:

import get_screen_brightness from '@dfeidao/atom-wxapp/api/equipment/get-screen-brightness';
const res = await get_screen_brightness();

Returns: Promise<number>


get_system_info

get_system_info(): Promise<SystemInfo>

Defined in api/equipment/get-system-info.ts:19

Returns: Promise<SystemInfo>


on_accelerometer_change

on_accelerometer_change(): Promise<AccelerometerData>

Defined in api/equipment/on-accelerometer-change.ts:16

监听加速度数据事件

description: 频率根据 start-accelerometer 的 interval 参数。可使用 stop-accelerometer 停止监听。

see: 微信官方文档 stop-accelerometer stop-accelerometer

example:

import on_accelerometer_change from '@dfeidao/atom-wxapp/api/equipment/on-accelerometer-change';
await on_accelerometer_change();

Returns: Promise<AccelerometerData>


on_beacon_service_change

on_beacon_service_change(): Promise<object>

Defined in api/equipment/on-beacon-service-change.ts:15

监听 iBeacon 服务状态变化事件

see: 微信官方文档

example:

import on_beacon_service_change from '@dfeidao/atom-wxapp/api/equipment/on-beacon-service-change';
await on_beacon_service_change();

Returns: Promise<object>


on_beacon_update

on_beacon_update(): Promise<object[]>

Defined in api/equipment/on-beacon-update.ts:15

监听 iBeacon 设备更新事件

see: 微信官方文档

example:

import on_beacon_update from '@dfeidao/atom-wxapp/api/equipment/on-beacon-update';
await on_beacon_update();

Returns: Promise<object[]>


on_compass_change

on_compass_change(): Promise<CompassData>

Defined in api/equipment/on-compass-change.ts:16

监听罗盘数据变化事件

description: 频率:5 次/秒,接口调用后会自动开始监听,可使用 stop-compass 原子操作停止监听。

see: 微信官方文档 stop-compass

example:

import on_compass_change from '@dfeidao/atom-wxapp/api/equipment/on-compass-change';
const res = await on_compass_change();

Returns: Promise<CompassData>


on_network_status_change

on_network_status_change(fd: IFeidaoAiWeappPage): void

Defined in api/equipment/on-network-status-change.ts:18

监听网络状态变化事件

see: 微信官方文档

example:

import on_network_status_change from '@dfeidao/atom-wxapp/api/equipment/on-network-status-change';
const res = await on_network_status_change(fd);

Parameters:

Name Type
fd IFeidaoAiWeappPage

Returns: void


on_user_capture_screen

on_user_capture_screen(fd: IFeidaoAiWeappPage): void

Defined in api/equipment/on-user-capture-screen.ts:19

监听用户主动截屏事件

description: 用户使用系统截屏按键截屏时触发

see: 微信官方文档

example:

import on_user_capture_screen from '@dfeidao/atom-wxapp/api/equipment/on-user-capture-screen';
const res = await on_user_capture_screen(fd);

Parameters:

Name Type
fd IFeidaoAiWeappPage

Returns: void


set_clipboard_data

set_clipboard_data(data: string): Promise<boolean>

Defined in api/equipment/set-clipboard-data.ts:15

设置系统剪贴板的内容

see: 微信官方文档

example:

import set_clipboard_data from '@dfeidao/atom-wxapp/api/equipment/set-clipboard-data';
const res = await set_clipboard_data(true);

Parameters:

Name Type Description
data string 需要设置的内容

Returns: Promise<boolean>


set_keep_screen_on

set_keep_screen_on(keepScreenOn: boolean): Promise<boolean>

Defined in api/equipment/set-keep-screen-on.ts:16

设置是否保持常亮状态

description: 仅在当前小程序生效,离开小程序后设置失效。

see: 微信官方文档

example:

import set_keep_screen_on from '@dfeidao/atom-wxapp/api/equipment/set-keep-screen-on';
const res = await set_keep_screen_on(true);

Parameters:

Name Type Description
keepScreenOn boolean 是否保持屏幕常亮

Returns: Promise<boolean>


set_screen_brightness

set_screen_brightness(value: number): Promise<boolean>

Defined in api/equipment/set-screen-brightness.ts:15

设置屏幕亮度

see: 微信官方文档

example:

import set_screen_brightness from '@dfeidao/atom-wxapp/api/equipment/set-screen-brightness';
await set_screen_brightness(0);

Parameters:

Name Type Description
value number 屏幕亮度值,范围 0~1,0 最暗,1 最亮

Returns: Promise<boolean>


start_accelerometer

start_accelerometer(): Promise<boolean>

Defined in api/equipment/start-accelerometer.ts:15

开始监听加速度数据

see: 微信官方文档

example:

import start_accelerometer from '@dfeidao/atom-wxapp/api/equipment/start-accelerometer';
await start_accelerometer();

Returns: Promise<boolean>


start_beacon_discovery

start_beacon_discovery(uuids: string[]): Promise<boolean>

Defined in api/equipment/start-beacon-discovery.ts:15

开始搜索附近的 iBeacon 设备

see: 微信官方文档

example:

import start_beacon_discovery from '@dfeidao/atom-wxapp/api/equipment/start-beacon-discovery';
const res = await start_beacon_discovery(['uuid1', 'uuid2']);

Parameters:

Name Type Description
uuids string[] iBeacon设备广播的 uuids

Returns: Promise<boolean>


start_compass

start_compass(): Promise<boolean>

Defined in api/equipment/start-compass.ts:15

开始监听罗盘数据

see: 微信官方文档

example:

import start_compass from '@dfeidao/atom-wxapp/api/equipment/start-compass';
await start_compass();

Returns: Promise<boolean>


stop_accelerometer

stop_accelerometer(): Promise<boolean>

Defined in api/equipment/stop-accelerometer.ts:15

停止监听加速度数据

see: 微信官方文档

example:

import stop_accelerometer from '@dfeidao/atom-wxapp/api/equipment/stop-accelerometer';
await stop_accelerometer();

Returns: Promise<boolean>


stop_beacon_discovery

stop_beacon_discovery(): Promise<boolean>

Defined in api/equipment/stop-beacon-discovery.ts:14

停止搜索附近的 iBeacon 设备

see: 微信官方文档

example:

import stop_beacon_discovery from '@dfeidao/atom-wxapp/api/equipment/stop-beacon-discovery';
await stop_beacon_discovery();

Returns: Promise<boolean>


stop_compass

stop_compass(): Promise<boolean>

Defined in api/equipment/stop-compass.ts:15

停止监听罗盘数据

see: 微信官方文档

example:

import stop_compass from '@dfeidao/atom-wxapp/api/equipment/stop-compass';
await stop_compass();

Returns: Promise<boolean>