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

蓝牙-通用API 

ty.onBluetoothAdapterStateChange

监听蓝牙适配器状态变化事件

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

参数

function callback

监听蓝牙适配器状态变化事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
available	boolean		是	蓝牙适配器是否可用

函数定义示例

/**
 * 监听蓝牙适配器状态变化事件
 */
export function onBluetoothAdapterStateChange(
  listener: (params: {
    /** 蓝牙适配器是否可用 */
    available: boolean;
  }) => void,
): void;

ty.offBluetoothAdapterStateChange

取消监听蓝牙适配器状态变化事件

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

参数

function callback

取消监听蓝牙适配器状态变化事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
available	boolean		是	蓝牙适配器是否可用

函数定义示例

/**
 * 取消监听蓝牙适配器状态变化事件
 */
export function offBluetoothAdapterStateChange(
  listener: (params: {
    /** 蓝牙适配器是否可用 */
    available: boolean;
  }) => void,
): void;

👉 立即开发。

Wi-Fi API

ty.getConnectedWifi

获取当前连接的 wifi 信息

iOS: 返回 SSID 和 BSSID

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

参数

Object object

属性	类型	默认值	必填	说明
partialInfo	boolean		否	是否需要返回部分 Wi-Fi 信息 安卓 ty.getConnectedWifi 若设置了 partialInfo:true ，将会返回只包含 SSID 属性的 WifiInfo 对象。 iOS ty.getConnectedWifi 若设置了 partialInfo:true ，将会返回只包含 SSID、BSSID 属性的 WifiInfo 对象，且需要用户开启微信定位权限才能正确返回结果。 默认值：false
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性	类型	说明
SSID	string	wifi 的 SSID
BSSID	string	wifi 的 BSSID
signalStrength	number	Wi-Fi 信号强度, 安卓取值 0 ～ 100 ，iOS 取值 0 ～ 1 ，值越大强度越大
secure	boolean	Wi-Fi 是否安全 Android：Android 系统 12 开始支持。
frequency	number	Wi-Fi 频段单位 MHz

object.fail 回调参数

参数

Object res

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

函数定义示例

/**
 * 获取当前连接的wifi信息
 *iOS: 返回SSID和BSSID
 */
export function getConnectedWifi(params?: {
  /**
   * 是否需要返回部分 Wi-Fi 信息
   * 安卓 ty.getConnectedWifi 若设置了 partialInfo:true ，将会返回只包含 SSID 属性的 WifiInfo 对象。
   * iOS ty.getConnectedWifi 若设置了 partialInfo:true ，将会返回只包含 SSID、BSSID 属性的 WifiInfo 对象，且需要用户开启微信定位权限才能正确返回结果。
   * 默认值：false
   */
  partialInfo?: boolean;
  complete?: () => void;
  success?: (params: {
    /** wifi的SSID */
    SSID: string;
    /** wifi的BSSID */
    BSSID: string;
    /** Wi-Fi 信号强度, 安卓取值 0 ～ 100 ，iOS 取值 0 ～ 1 ，值越大强度越大 */
    signalStrength: number;
    /**
     * Wi-Fi是否安全
     * Android：Android系统12开始支持。
     */
    secure: boolean;
    /** Wi-Fi 频段单位 MHz */
    frequency: number;
  }) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.getWifiList

获取手机附近的 Wi-Fi 列表；列表数据通过 onGetWifiList 事件发送

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

参数

Object object

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

函数定义示例

/**
 * 获取手机附近的Wi-Fi列表；列表数据通过onGetWifiList事件发送
 */
export function getWifiList(params?: {
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.onGetWifiList

监听获取到 Wi-Fi 列表数据事件

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

参数

function callback

监听获取到 Wi-Fi 列表数据事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
wifiList	array		是	Wi-Fi 列表

函数定义示例

/**
 * 监听获取到 Wi-Fi 列表数据事件
 */
export function onGetWifiList(
  listener: (params: {
    /** Wi-Fi列表 */
    wifiList: WifiInfo[];
  }) => void,
): void;

ty.offGetWifiList

取消监听：监听获取到 Wi-Fi 列表数据事件

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

参数

function callback

取消监听：监听获取到 Wi-Fi 列表数据事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
wifiList	array		是	Wi-Fi 列表

函数定义示例

/**
 * 取消监听：监听获取到 Wi-Fi 列表数据事件
 */
export function offGetWifiList(
  listener: (params: {
    /** Wi-Fi列表 */
    wifiList: WifiInfo[];
  }) => void,
): void;

电话API

ty.makePhoneCall

拨打电话

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

参数

Object object

属性	类型	默认值	必填	说明
phoneNumber	string		是	需要拨打的电话号码
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 拨打电话
 */
export function makePhoneCall(params: {
  /** 需要拨打的电话号码 */
  phoneNumber: string;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

 👉 立即开发。