小程序API能力汇总——基础容器API（一）

IoT砖家涂拉拉2024-02-19 10:01

ty.getEnterOptions

获取本次小程序启动时的参数。如果当前是冷启动，则返回值与 App.onLaunch 的回调参数一致；如果当前是热启动，则返回值与 App.onShow 一致。

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

参数

Object object

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

object.success 回调参数

参数

Object res

属性 类型 说明
path string 启动小程序的路径 (代码包路径)
query object 启动小程序的 query 参数
referrerInfo ReferrerInfo 分享转发
apiCategory string API 类别: default 默认类别; embedded 内嵌，通过打开半屏小程序能力打开的小程序

object.fail 回调参数

参数

Object res

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

函数定义示例

复制代码 
/**
 * 获取本次小程序启动时的参数。如果当前是冷启动，则返回值与App.onLaunch的回调参数一致；如果当前是热启动，则返回值与App.onShow 一致。
 */
export function getEnterOptions(params?: {
  complete?: () => void;
  success?: (params: {
    /** 启动小程序的路径 (代码包路径) */
    path: string;
    /** 启动小程序的 query 参数 */
    query: Record<string, any>;
    /** 分享转发 */
    referrerInfo: ReferrerInfo;
    /** API 类别: default	默认类别; embedded 内嵌，通过打开半屏小程序能力打开的小程序 */
    apiCategory?: string;
  }) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.getEnterOptionsSync

获取本次小程序启动时的参数。如果当前是冷启动，则返回值与 App.onLaunch 的回调参数一致；如果当前是热启动，则返回值与 App.onShow 一致。同步方法

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

ty.getEnterOptions 的同步版本

返回值

属性 类型 说明
path string 启动小程序的路径 (代码包路径)
query object 启动小程序的 query 参数
referrerInfo ReferrerInfo 分享转发
apiCategory string API 类别: default 默认类别; embedded 内嵌，通过打开半屏小程序能力打开的小程序

函数定义示例

复制代码 
/**
 * 获取本次小程序启动时的参数。如果当前是冷启动，则返回值与App.onLaunch的回调参数一致；如果当前是热启动，则返回值与App.onShow 一致。
 */
export function getEnterOptionsSync(): {
  /** 启动小程序的路径 (代码包路径) */
  path: string;
  /** 启动小程序的 query 参数 */
  query: Record<string, any>;
  /** 分享转发 */
  referrerInfo: ReferrerInfo;
  /** API 类别: default	默认类别; embedded 内嵌，通过打开半屏小程序能力打开的小程序 */
  apiCategory?: string;
};

ty.getLaunchOptions

获取小程序启动时的参数。与 App.onLaunch 的回调参数一致。

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

参数

Object object

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

object.success 回调参数

参数

Object res

属性 类型 说明
path string 启动小程序的路径 (代码包路径)
query object 启动小程序的 query 参数
referrerInfo ReferrerInfo 分享转发
apiCategory string API 类别: default 默认类别; embedded 内嵌，通过打开半屏小程序能力打开的小程序

object.fail 回调参数

参数

Object res

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

函数定义示例

复制代码 
/**
 * 获取小程序启动时的参数。与App.onLaunch的回调参数一致。
 */
export function getLaunchOptions(params?: {
  complete?: () => void;
  success?: (params: {
    /** 启动小程序的路径 (代码包路径) */
    path: string;
    /** 启动小程序的 query 参数 */
    query: Record<string, any>;
    /** 分享转发 */
    referrerInfo: ReferrerInfo;
    /** API 类别: default	默认类别; embedded 内嵌，通过打开半屏小程序能力打开的小程序 */
    apiCategory?: string;
  }) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.getLaunchOptionsSync

获取小程序启动时的参数。与 App.onLaunch 的回调参数一致。同步方法

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

ty.getLaunchOptions 的同步版本

返回值

属性 类型 说明
path string 启动小程序的路径 (代码包路径)
query object 启动小程序的 query 参数
referrerInfo ReferrerInfo 分享转发
apiCategory string API 类别: default 默认类别; embedded 内嵌，通过打开半屏小程序能力打开的小程序

函数定义示例

复制代码 
/**
 * 获取小程序启动时的参数。与App.onLaunch的回调参数一致。
 */
export function getLaunchOptionsSync(): {
  /** 启动小程序的路径 (代码包路径) */
  path: string;
  /** 启动小程序的 query 参数 */
  query: Record<string, any>;
  /** 分享转发 */
  referrerInfo: ReferrerInfo;
  /** API 类别: default	默认类别; embedded 内嵌，通过打开半屏小程序能力打开的小程序 */
  apiCategory?: string;
};

ty.getAppInfo

拿到当前 App 的业务信息

需引入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 }

ty.getAppInfo

拿到当前 App 的业务信息

需引入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 }

ty.getTempDirectory

获取通用缓存路径

需引入BaseKit，且在>=2.2.3版本才可使用

参数

Object object

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

object.success 回调参数

参数

Object res

属性 类型 说明
tempDirectory string 【待废弃， 不建议使用】临时文件夹路径

object.fail 回调参数

参数

Object res

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

函数定义示例

复制代码 
/**
 * 获取通用缓存路径
 */
export function getTempDirectory(params?: {
  complete?: () => void;
  success?: (params: {
    /** 【待废弃， 不建议使用】临时文件夹路径 */
    tempDirectory: string;
  }) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.getMenuButtonBoundingClientRect

获取菜单按钮（右上角胶囊按钮）的布局位置信息。坐标信息以屏幕左上角为原点。

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

参数

Object object

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

object.success 回调参数

参数

Object res

属性 类型 说明
width number 宽度，单位：px
height number 高度，单位：px
top number 上边界坐标，单位：px
right number 右边界坐标，单位：px
bottom number 下边界坐标，单位：px
left number 左边界坐标，单位：px

object.fail 回调参数

参数

Object res

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

函数定义示例

复制代码 
/**
 * 获取菜单按钮（右上角胶囊按钮）的布局位置信息。坐标信息以屏幕左上角为原点。
 */
export function getMenuButtonBoundingClientRect(params?: {
  complete?: () => void;
  success?: (params: {
    /** 宽度，单位：px */
    width: number;
    /** 高度，单位：px */
    height: number;
    /** 上边界坐标，单位：px */
    top: number;
    /** 右边界坐标，单位：px */
    right: number;
    /** 下边界坐标，单位：px */
    bottom: number;
    /** 左边界坐标，单位：px */
    left: number;
  }) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.getMenuButtonBoundingClientRectSync

获取菜单按钮（右上角胶囊按钮）的布局位置信息。坐标信息以屏幕左上角为原点。同步方法

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

ty.getMenuButtonBoundingClientRect 的同步版本

返回值

属性 类型 说明
width number 宽度，单位：px
height number 高度，单位：px
top number 上边界坐标，单位：px
right number 右边界坐标，单位：px
bottom number 下边界坐标，单位：px
left number 左边界坐标，单位：px

函数定义示例

复制代码 
/**
 * 获取菜单按钮（右上角胶囊按钮）的布局位置信息。坐标信息以屏幕左上角为原点。
 */
export function getMenuButtonBoundingClientRectSync(): {
  /** 宽度，单位：px */
  width: number;
  /** 高度，单位：px */
  height: number;
  /** 上边界坐标，单位：px */
  top: number;
  /** 右边界坐标，单位：px */
  right: number;
  /** 下边界坐标，单位：px */
  bottom: number;
  /** 左边界坐标，单位：px */
  left: number;
};

👉 立即开发。

相关推荐
AOwhisky5 小时前
Linux 网络服务架设学习笔记（第五期）——Web 服务（上篇）：Apache HTTP Server——从静态到动态
linux·运维·服务器·笔记·学习·云计算·apache
Ai-_Man8 小时前
千问能否电脑批量导出？深度拆解「AI导出鸭」如何让这件事从“反人性”变成“优雅”
人工智能·ai·小程序
一杯Americano11 小时前
用LangChain搭一个RAG知识库Agent：多模型统一API接入实践
api
todoitbo12 小时前
用蓝耘元生代做 GitHub 热榜解读：Dify Chatflow 接入和真实项目分析
ai·github·api·dify·蓝耘
太阳之神aboluo12 小时前
微信小程序 (1) 基础用法
微信小程序·小程序
csdn_aspnet12 小时前
mysql 函数、存储过程写法及示例
数据库·mysql·存储过程·函数·function·procedure
lhldsg14 小时前
AI智能商城实战指南：从架构设计到落地开发经验分享
java·人工智能·经验分享·小程序
lhldsg14 小时前
树洞交友系统开发实战：从匿名社交需求到技术落地
java·小程序·uni-app·交友
show43317 小时前
2026方言语音识别技术现状：小程序端22种方言免费识别挑战与进展
人工智能·小程序·语音识别
热门推荐
01国内可直接用、免费额度/永久免费的大模型API清单（含 SiliconFlow、火山、阿里、智谱、百度、Kimi、DeepSeek、DMXAPI 等）02GitHub 镜像站点03ZCode 周末送额度活动开启：3 亿 Token 免费领取042026 国产 AI 大模型横评：DeepSeek、通义千问、Kimi、文心一言、星火、豆包谁更能打？05历年考研数学一、数学二、数学三真题试卷及答案PDF06微信历史版本含下载地址（ Windows PC | 安卓 | MAC ）及设置微信不更新07蜘蛛磁力 搜索引擎大全，如何使用蜘蛛磁力查找磁力链接08AI 编程 IDE 全景解析 2026：Agent 全面接管开发链路09Agnes AI 免费 API 接入指南：文本、生图、生视频，一套接口全免费10VSCode+CodeX扩展，无法启动