智能小程序 Ray 开发——出行 API 接口汇总（四）

Currentdevice

outdoor.currentDevice

出行获取当前首页展示的设备 ID

需引入OutdoorKit，且在>=1.0.0版本才可使用

Use in Ray

// @ray-js/ray >=1.4.40
import { outdoor } from '@ray-js/ray';
const { currentDevice } = outdoor;

参数

Object object

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

object.success 回调参数

参数

Object res

属性	类型	说明
deviceID	string	deviceID 设备 ID

object.fail 回调参数

参数

Object res

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

函数定义示例

/**
 * 出行获取当前首页展示的设备ID
 */
export function currentDevice(params?: {
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: {
    /** deviceID 设备ID */
    deviceID: string;
  }) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。  

getBoundDeviceIdList

outdoor.getBoundDeviceIdList

获取已绑定设备 ID 集合

需引入OutdoorKit，且在>=1.0.1版本才可使用

Use in Ray

// @ray-js/ray >=1.4.40
import { outdoor } from '@ray-js/ray';
const { getBoundDeviceIdList } = outdoor;

参数

Object object

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

object.success 回调参数

参数

Object res

属性	类型	说明
devIdList	array	返回已绑定的设备 ID 集合

object.fail 回调参数

参数

Object res

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

函数定义示例

/**
 * 获取已绑定设备ID集合
 */
export function getBoundDeviceIdList(params?: {
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: {
    /** 返回已绑定的设备ID集合 */
    devIdList: string[];
  }) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

switchDevice 

outdoor.switchDevice

切换设备，会弹出 Native 切换选择器

需引入OutdoorKit，且在>=1.0.4版本才可使用

Use in Ray

// @ray-js/ray >=1.4.40
import { outdoor } from '@ray-js/ray';
const { switchDevice } = outdoor;

参数

Object object

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

函数定义示例

/**
 * 切换设备，会弹出Native切换选择器
 */
export function switchDevice(params?: {
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: boolean) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。