handleShortcut(params: Object)

版本要求:
BizKit≥3.1.1@ray-js/ray≥0.8.0
支持平台:
iOSAndroid
import { handleShortcut } from '@ray-js/ray';

// Promise 调用
try {
  const res = await handleShortcut({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

描述

操作快捷方式,包括添加和移除, 仅 iOS

参数

属性类型必填说明
typenumber是操作类型。0-添加、1-移除
sceneIdstring是场景 id
namestring是场景名称
iconUrlstring否场景 logo
complete() => void否接口调用结束的回调函数(调用成功、失败都会执行)
success(params: Object) => void否接口调用成功的回调函数
fail(params: Object) => void否接口调用失败的回调函数
success 回调参数
属性类型说明BizKit 最低版本
operationStepnumber操作步骤,0-添加、1-移除、2-更新、3-取消v3.1.2
operationStatusboolean操作状态,YES,表示成功;NO,表示失败v3.1.2
fail 回调参数
属性类型说明
errorMsgstring错误信息
errorCodestring | number错误码
错误扩展

返回值

无

示例代码

import { handleShortcut } from '@ray-js/ray'

handleShortcut({
  type: 1,
  sceneId: "xx",
  name: "xx",
  iconUrl: "xx",
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});