智能小程序 Ray 开发基础API——容器 API 合集（四）

openSetting

调起客户端小程序设置界面，返回用户设置的操作结果。

引入

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

需引入MiniKit，且在>=2.6.0版本才可使用

参数

Object object

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

object.success 回调参数

参数

Object res

属性	类型	说明
scope	any	用户授权设置信息

object.fail 回调参数

参数

Object res

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

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

 

openURL

打开设备上的某个应用或可以处理 URL 的程序。

引入

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

需引入MiniKit，且在>=3.0.0版本才可使用

参数

Object object

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

 

openHelpCenter

打开帮助中心，默认：面板小程序会跳转到面板帮助中心，普通小程序会跳转到 App 帮助中心

引入

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

需引入MiniKit，且在>=2.6.0版本才可使用

参数

Object object

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

 

openAppHelpCenter

打开跳转到 App 帮助与反馈页面

引入

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

需引入MiniKit，且在>=2.6.0版本才可使用。

@ray-js/ray >= 1.4.49版本才可使用。

参数

Object object

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

 

getAssetHostname

自动根据当前面板所处的 App 环境获取对应的静态资源地址。

请求参数

无

返回参数

参数	数据类型	说明
hostname	String	静态资源地址

请求示例

import { getAssetHostname } from '@ray-js/ray';
 
getAssetHostname()
  .then((response) => {
    console.log(response);
  })
  .catch();

返回示例

'https://images.tuyacn.com';

 

getAccountInfo

获取小程序账号信息

导入

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

需引入MiniKit，且在>=3.1.0 @ray-js/ray >= 0.9.0版本才可使用

参数

Object object

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

object.success 回调参数

参数

Object res

属性	类型	说明
miniProgram	MiniProgramAccountInfo	小程序账号信息

MiniProgramAccountInfo

Property	Type	Description
appId	string	小程序 ID
envVersion	string	小程序版本： - develop：开发版 - trail：体验版 - release：正式版
version	string	版本号

object.fail 回调参数

参数

Object res

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

函数定义示例

export type MiniProgramAccountInfo = {
  /** 小程序 ID */
  appId: string;
  /**
   * 小程序版本
   * develop: 开发版
   * trail: 体验版
   * release: 正式版
   */
  envVersion: string;
  /** 小程序版本号 */
  version: string;
};
/**
 * 获取小程序账号信息
 */
export function getAccountInfo(params?: {
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: {
    /** 小程序账号信息 */
    miniProgram: MiniProgramAccountInfo;
  }) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

 

getAccountInfoSync

获取小程序账号信息同步方法

导入

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

需引入MiniKit，且在>=3.1.0 @ray-js/ray >= 0.9.0版本才可使用

getAccountInfo 的同步版本

返回值

属性	类型	说明
miniProgram	MiniProgramAccountInfo	小程序账号信息

MiniProgramAccountInfo

Property	Type	Description
appId	string	小程序 ID
envVersion	string	小程序版本： - develop：开发版 - trail：体验版 - release：正式版
version	string	版本号

函数定义示例

export type MiniProgramAccountInfo = {
  /** 小程序 ID */
  appId: string;
  /**
   * 小程序版本
   * develop: 开发版
   * trail: 体验版
   * release: 正式版
   */
  envVersion: string;
  /** 小程序版本号 */
  version: string;
};
/**
 * 获取小程序账号信息
 */
export function getAccountInfoSync(): {
  /** 小程序账号信息 */
  miniProgram: MiniProgramAccountInfo;
};

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