小程序API能力集成指南——设备API汇总（五）

网络 API

ty.getNetworkType

获取网络类型

需引入BaseKit，且在>=1.2.10版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性	类型	说明
networkType	string	网络类型
signalStrength	number	信号强弱，单位 dbm

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/**
 * 获取网络类型
 */
export function getNetworkType(params?: {
  complete?: () => void;
  success?: (params: {
    /** 网络类型 */
    networkType: string;
    /** 信号强弱，单位 dbm */
    signalStrength: number;
  }) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.onNetworkStatusChange

监听网络状态变化事件

需引入BaseKit，且在>=1.2.10版本才可使用

参数

function callback

监听网络状态变化事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
isConnected	boolean		是	当前是否有网络连接
networkType	string		是	网络类型

函数定义示例

/**
 * 监听网络状态变化事件
 */
export function onNetworkStatusChange(
  listener: (params: {
    /** 当前是否有网络连接 */
    isConnected: boolean;
    /** 网络类型 */
    networkType: string;
  }) => void,
): void;

ty.offNetworkStatusChange

取消监听网络状态变化事件

需引入BaseKit，且在>=1.2.10版本才可使用

参数

function callback

取消监听网络状态变化事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
isConnected	boolean		是	当前是否有网络连接
networkType	string		是	网络类型

函数定义示例

/**
 * 取消监听网络状态变化事件
 */
export function offNetworkStatusChange(
  listener: (params: {
    /** 当前是否有网络连接 */
    isConnected: boolean;
    /** 网络类型 */
    networkType: string;
  }) => void,
): void;

 👉 立即开发。

加速计 API

ty.startAccelerometer

开始监听加速度数据

需引入BaseKit，且在>=2.3.2版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
interval	AccelerometerInterval		否	监听加速度数据回调函数的执行频率
complete	function		否	接口调用完成的回调函数（成功或失败都会回调）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 开始监听加速度数据
 */
export function startAccelerometer(params?: {
  /** 监听加速度数据回调函数的执行频率 */
  interval?: AccelerometerInterval;
  complete?: () => void;
  success?: (params: null) => void;
  failure?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.stopAccelerometer

停止监听加速度数据

需引入BaseKit，且在>=2.3.2版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 停止监听加速度数据
 */
export function stopAccelerometer(params?: {
  complete?: () => void;
  success?: (params: null) => void;
  failure?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.onAccelerometerChange

监听加速度数据事件

需引入BaseKit，且在>=2.3.2版本才可使用

参数

function callback

监听加速度数据事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
x	number		是	X 轴
y	number		是	Y 轴
z	number		是	Z 轴

函数定义示例

/**
 * 监听加速度数据事件
 */
export function onAccelerometerChange(
  listener: (params: {
    /** X 轴 */
    x: number;
    /** Y 轴 */
    y: number;
    /** Z 轴 */
    z: number;
  }) => void,
): void;

ty.offAccelerometerChange

取消监听加速度数据事件，参数为空，则取消所有的事件监听

需引入BaseKit，且在>=2.3.2版本才可使用

参数

function callback

取消监听加速度数据事件，参数为空，则取消所有的事件监听的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
x	number		是	X 轴
y	number		是	Y 轴
z	number		是	Z 轴

函数定义示例

/**
 * 取消监听加速度数据事件，参数为空，则取消所有的事件监听
 */
export function offAccelerometerChange(
  listener: (params: {
    /** X 轴 */
    x: number;
    /** Y 轴 */
    y: number;
    /** Z 轴 */
    z: number;
  }) => void,
): void;

👉 立即开发。