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

2024-05-13 10:36

本文主要是介绍智能小程序 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 小程序开发。 

这篇关于智能小程序 Ray 开发基础API——系统 API 合集(三)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/985456

相关文章

Linux系统性能检测命令详解

《Linux系统性能检测命令详解》本文介绍了Linux系统常用的监控命令(如top、vmstat、iostat、htop等)及其参数功能,涵盖进程状态、内存使用、磁盘I/O、系统负载等多维度资源监控,... 目录toppsuptimevmstatIOStatiotopslabtophtopdstatnmon

Python办公自动化实战之打造智能邮件发送工具

《Python办公自动化实战之打造智能邮件发送工具》在数字化办公场景中,邮件自动化是提升工作效率的关键技能,本文将演示如何使用Python的smtplib和email库构建一个支持图文混排,多附件,多... 目录前言一、基础配置:搭建邮件发送框架1.1 邮箱服务准备1.2 核心库导入1.3 基础发送函数二、

使用Docker构建Python Flask程序的详细教程

《使用Docker构建PythonFlask程序的详细教程》在当今的软件开发领域,容器化技术正变得越来越流行,而Docker无疑是其中的佼佼者,本文我们就来聊聊如何使用Docker构建一个简单的Py... 目录引言一、准备工作二、创建 Flask 应用程序三、创建 dockerfile四、构建 Docker

Knife4j+Axios+Redis前后端分离架构下的 API 管理与会话方案(最新推荐)

《Knife4j+Axios+Redis前后端分离架构下的API管理与会话方案(最新推荐)》本文主要介绍了Swagger与Knife4j的配置要点、前后端对接方法以及分布式Session实现原理,... 目录一、Swagger 与 Knife4j 的深度理解及配置要点Knife4j 配置关键要点1.Spri

SpringBoot开发中十大常见陷阱深度解析与避坑指南

《SpringBoot开发中十大常见陷阱深度解析与避坑指南》在SpringBoot的开发过程中,即使是经验丰富的开发者也难免会遇到各种棘手的问题,本文将针对SpringBoot开发中十大常见的“坑... 目录引言一、配置总出错?是不是同时用了.properties和.yml?二、换个位置配置就失效?搞清楚加

linux重启命令有哪些? 7个实用的Linux系统重启命令汇总

《linux重启命令有哪些?7个实用的Linux系统重启命令汇总》Linux系统提供了多种重启命令,常用的包括shutdown-r、reboot、init6等,不同命令适用于不同场景,本文将详细... 在管理和维护 linux 服务器时,完成系统更新、故障排查或日常维护后,重启系统往往是必不可少的步骤。本文

Python中对FFmpeg封装开发库FFmpy详解

《Python中对FFmpeg封装开发库FFmpy详解》:本文主要介绍Python中对FFmpeg封装开发库FFmpy,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录一、FFmpy简介与安装1.1 FFmpy概述1.2 安装方法二、FFmpy核心类与方法2.1 FF

基于Python开发Windows屏幕控制工具

《基于Python开发Windows屏幕控制工具》在数字化办公时代,屏幕管理已成为提升工作效率和保护眼睛健康的重要环节,本文将分享一个基于Python和PySide6开发的Windows屏幕控制工具,... 目录概述功能亮点界面展示实现步骤详解1. 环境准备2. 亮度控制模块3. 息屏功能实现4. 息屏时间

Mac系统下卸载JAVA和JDK的步骤

《Mac系统下卸载JAVA和JDK的步骤》JDK是Java语言的软件开发工具包,它提供了开发和运行Java应用程序所需的工具、库和资源,:本文主要介绍Mac系统下卸载JAVA和JDK的相关资料,需... 目录1. 卸载系统自带的 Java 版本检查当前 Java 版本通过命令卸载系统 Java2. 卸载自定

HTML5 getUserMedia API网页录音实现指南示例小结

《HTML5getUserMediaAPI网页录音实现指南示例小结》本教程将指导你如何利用这一API,结合WebAudioAPI,实现网页录音功能,从获取音频流到处理和保存录音,整个过程将逐步... 目录1. html5 getUserMedia API简介1.1 API概念与历史1.2 功能与优势1.3