智能小程序 Ray 开发基础API——系统 API 合集(三)

handleShortcut

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

引入

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

需引入BizKit,且在>=3.1.1版本才可使用。

参数

Object object

属性类型默认值必填说明
typenumber操作类型。0-添加、1-移除
sceneIdstring场景 ID
namestring场景名称
iconUrlstring场景 Logo
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性类型说明
operationStepnumber操作步骤,0-添加、1-移除、2-更新、3-取消
operationStatusboolean操作状态,YES,表示成功;NO,表示失败

object.fail 回调参数

参数

Object res

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

函数定义示例

/**
 * 操作快捷方式,包括添加和移除, 仅 iOS
 */
export function handleShortcut(params: {
  /** 操作类型。0-添加、1-移除 */
  type: number;
  /** 场景 ID */
  sceneId: string;
  /** 场景名称 */
  name: string;
  /** 场景 Logo */
  iconUrl?: string;
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: {
    /** 操作步骤,0-添加、1-移除、2-更新、3-取消 */
    operationStep: number;
    /** 操作状态,YES,表示成功;NO,表示失败 */
    operationStatus: boolean;
  }) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

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

isAssociatedShortcut

获取是否关联 siri 状态, 仅 iOS

引入

import { isAssociatedShortcut } from '@ray-js/ray';

需引入 BizKit,且在 >=3.1.1 版本才可使用。

参数

Object object

属性类型默认值必填说明
sceneIdstring场景 ID
namestring场景名称
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性类型说明
isAssociatedboolean是否已关联

object.fail 回调参数

参数

Object res

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

函数定义示例

/**
 * 获取是否关联 Siri 状态, 仅 iOS
 */
export function isAssociatedShortcut(params: {
  /** 场景 ID */
  sceneId: string;
  /** 场景名称 */
  name?: string;
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: {
    /** 是否已关联 */
    isAssociated: boolean;
  }) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

 

isSupportedShortcut

是否支持 Siri, 仅 iOS

引入

import { isSupportedShortcut } from '@ray-js/ray';

需引入 BizKit,且在 >=3.1.1 版本才可使用。

参数

Object object

属性类型默认值必填说明
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性类型说明
isSupportedboolean是否支持

object.fail 回调参数

参数

Object res

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

函数定义示例

/**
 * 是否支持 Siri, 仅 iOS
 */
export function isSupportedShortcut(params?: {
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: {
    /** 是否支持 */
    isSupported: boolean;
  }) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

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

  • 48
    点赞
  • 26
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

IoT砖家涂拉拉

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值