getEnterOptions
获取本次小程序启动时的参数。如果当前是冷启动,则返回值与 App.onLaunch 的回调参数一致;如果当前是热启动,则返回值与 App.onShow 一致。
引入
import { getEnterOptions } from '@ray-js/ray';
需引入
MiniKit
,且在>=2.0.0
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
object.success 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
path | string | 启动小程序的路径 (代码包路径) |
query | any | 启动小程序的 query 参数 |
referrerInfo | ReferrerInfo | 分享转发 |
apiCategory | string | API 类别: default 默认类别; embedded 内嵌,通过打开半屏小程序能力打开的小程序 |
object.fail 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
👉 立即免费领取开发资源,体验涂鸦 MiniApp 小程序开发。
getEnterOptionsSync
获取本次小程序启动时的参数。如果当前是冷启动,则返回值与 App.onLaunch 的回调参数一致;如果当前是热启动,则返回值与 App.onShow 一致。同步方法
引入
import { getEnterOptionsSync } from '@ray-js/ray';
需引入
MiniKit
,且在>=2.0.0
版本才可使用getEnterOptions 的同步版本
返回值
属性 | 类型 | 说明 |
---|---|---|
path | string | 启动小程序的路径 (代码包路径) |
query | any | 启动小程序的 query 参数 |
referrerInfo | ReferrerInfo | 分享转发 |
apiCategory | string | API 类别: default 默认类别; embedded 内嵌,通过打开半屏小程序能力打开的小程序 |
getLaunchOptions
获取小程序启动时的参数。与 App.onLaunch 的回调参数一致。
引入
import { getLaunchOptions } from '@ray-js/ray';
需引入
MiniKit
,且在>=2.0.0
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
object.success 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
path | string | 启动小程序的路径 (代码包路径) |
query | any | 启动小程序的 query 参数 |
referrerInfo | ReferrerInfo | 分享转发 |
apiCategory | string | API 类别: default 默认类别; embedded 内嵌,通过打开半屏小程序能力打开的小程序 |
object.fail 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
getLaunchOptionsSync
获取小程序启动时的参数。与 App.onLaunch 的回调参数一致。同步方法
引入
import { getLaunchOptionsSync } from '@ray-js/ray';
需引入
MiniKit
,且在>=2.0.0
版本才可使用getLaunchOptions 的同步版本
返回值
属性 | 类型 | 说明 |
---|---|---|
path | string | 启动小程序的路径 (代码包路径) |
query | any | 启动小程序的 query 参数 |
referrerInfo | ReferrerInfo | 分享转发 |
apiCategory | string | API 类别: default 默认类别; embedded 内嵌,通过打开半屏小程序能力打开的小程序 |
getAppInfo
拿到当前 App 的业务信息
引入
import { getAppInfo } from '@ray-js/ray';
需引入
BizKit
,且在>=3.0.0
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
object.success 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
serverTimestamp | number | 云端时间戳 |
appVersion | string | app 版本 |
language | string | 语言 |
countryCode | string | 国家码 |
regionCode | string | 地区码 |
appName | string | appName app 名称 |
appIcon | string | appIcon app 图标 |
appEnv | number | app 环境 0: 日常 1: 预发 2: 线上 |
appBundleId | string | app 包名 |
appScheme | string | app scheme |
object.fail 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
👉 立即免费领取开发资源,体验涂鸦 MiniApp 小程序开发。