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

IoT砖家涂拉拉2024-02-19 11:50

ty.preDownloadMiniApp

预下载智能小程序，此接口仅供提供预下载普通智能小程序调用，面板小程序的预下载需要使用另外的接口。

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

参数

Object object

属性 类型 默认值 必填 说明
miniAppId string 是 小程序 id
miniAppVersion string 否 指定小程序版本(可选参数)
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数

函数定义示例

复制代码 
/**
 * 预下载智能小程序，此接口仅供提供预下载普通智能小程序调用，面板小程序的预下载需要使用另外的接口。
 */
export function preDownloadMiniApp(params: {
  /** 小程序id */
  miniAppId: string;
  /** 指定小程序版本(可选参数) */
  miniAppVersion?: string;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.showMenuButton

显示右上角胶囊按钮

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

参数

Object object

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

函数定义示例

复制代码 
/**
 * 显示右上角胶囊按钮
 */
export function showMenuButton(params?: {
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.hideMenuButton

隐藏右上角胶囊按钮

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

参数

Object object

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

函数定义示例

复制代码 
/**
 * 隐藏右上角胶囊按钮
 */
export function hideMenuButton(params?: {
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.setPageOrientation

屏幕旋转设置，auto / portrait / landscape。pad 模式下不支持屏幕旋转

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

参数

Object object

属性 类型 默认值 必填 说明
pageOrientation string 是 屏幕旋转设置， auto(暂不支持) / portrait / landscape
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数

函数定义示例

复制代码 
/**
 * 屏幕旋转设置，auto / portrait / landscape。pad模式下不支持屏幕旋转
 */
export function setPageOrientation(params: {
  /** 屏幕旋转设置， auto(暂不支持) / portrait / landscape */
  pageOrientation: string;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

MiniWidgetDialogTask ty.openMiniWidget

用来控制小部件弹窗显示和关闭

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

参数

Object object

打开小部件弹窗的回调函数

回调参数 Object res

属性 类型 默认值 必填 说明
appId string 是 要打开的小部件 appid
pagePath string 否 对应的小部件页面相对 URL，如果为空则打开首页 path 中 ? 后面的部分会成为 query
deviceId string 否 面板类型设备 id
groupId string 否 面板群组类型群组 id
style string 否 小部件样式，默认 middle
versionType WidgetVersionType 否 版本类型，默认 release
version string 否 版本号
position WidgetPosition 否 展示位置，默认 bottom
autoDismiss boolean 否 点击空白处是否关闭
autoCache boolean 否 是否优先展示默认缓存，对应属性在小程序容器 3.1.0 生效
supportDark boolean 否 是否支持深色模式
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数

object.fail 回调参数

参数

Object res

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

返回值

MiniWidgetDialogTask 用来控制小部件弹窗显示和关闭

函数定义示例

复制代码 
/**
 * 用来控制小部件弹窗显示和关闭
 */
interface MiniWidgetDialogTask {
  /**
   * 关闭小部件弹窗
   */
  dismissMiniWidget(params: {
    complete?: () => void;
    success?: (params: null) => void;
    fail?: (params: {
      errorMsg: string;
      errorCode: string | number;
      innerError: {
        errorCode: string | number;
        errorMsg: string;
      };
    }) => void;
  }): void;
 
  /**
   * 监听 widget 关闭事件
   */
  onWidgetDismiss(
    listener: (params: {
      /** widget 弹窗 ID */
      dialogId: string;
    }) => void,
  ): void;
 
  /**
   * 取消监听 widget 关闭事件
   */
  offWidgetDismiss(
    listener: (params: {
      /** widget 弹窗 ID */
      dialogId: string;
    }) => void,
  ): void;
}
export function openMiniWidget(params: {
  /** 要打开的小部件 appid */
  appId: string;
  /** 对应的小部件页面相对 URL，如果为空则打开首页 path 中 ? 后面的部分会成为 query */
  pagePath?: string;
  /** 面板类型设备 ID */
  deviceId?: string;
  /** 面板群组类型群组 ID */
  groupId?: string;
  /** 小部件样式，默认 middle */
  style?: string;
  /** 版本类型，默认 release */
  versionType?: WidgetVersionType;
  /** 版本号 */
  version?: string;
  /** 展示位置，默认 bottom */
  position?: WidgetPosition;
  /** 点击空白处是否关闭 */
  autoDismiss?: boolean;
  /**
   * 是否优先展示默认缓存
   * 对应属性在小程序容器 3.1.0 生效
   */
  autoCache?: boolean;
  /** 是否支持深色模式 */
  supportDark?: boolean;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): MiniWidgetDialogTask;

MiniWidgetDialogTask

MiniWidgetDialogTask.dismissMiniWidget

关闭小部件弹窗

参数

Object object

关闭小部件弹窗的回调函数

回调参数 Object res

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

函数定义示例

复制代码 
/**
 * 关闭小部件弹窗
 */
export function dismissMiniWidget(params: {
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: null) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

MiniWidgetDialogTask.onWidgetDismiss

监听 widget 关闭事件

参数

function callback

监听 widget 关闭事件的回调函数

回调参数 Object res

属性 类型 默认值 必填 说明
dialogId string 是 widget 弹窗 ID

MiniWidgetDialogTask.offWidgetDismiss

取消监听 widget 关闭事件

参数

function callback

取消监听 widget 关闭事件的回调函数

回调参数 Object res

属性 类型 默认值 必填 说明
dialogId string 是 widget 弹窗 ID

👉 立即开发。

相关推荐
计算机毕设指导64 分钟前
基于微信小程序的健康指导平台【源码文末联系】
java·spring boot·mysql·微信小程序·小程序·tomcat·maven
苏打水com7 分钟前
Day4-6 CSS 进阶 + JS 基础 —— 实现 “交互效果 + 样式复用”（对标职场 “组件化思维” 入门）
javascript·css·交互
亿元程序员10 分钟前
其实Creator里面这个裁剪代码的功能很好用，建议试试
前端
感谢地心引力11 分钟前
【Chrome-Edge-Firefox】浏览器插件开发
前端·chrome·edge·firefox
qq_2965446516 分钟前
安卓版Google(谷歌地球)，安卓谷歌（Google）地图，谷歌翻译，谷歌（Chrome）浏览器，手机版Edge，浏览器等安卓版浏览器下载
前端·chrome
今天也想MK代码17 分钟前
JS 注入机制深度解析
java·前端·javascript
一字白首20 分钟前
Vue 进阶,指令补充 + computed+watch
前端·javascript·vue.js
暮之沧蓝21 分钟前
React(18-19)总结
前端·react.js·前端框架
wx_ywyy679824 分钟前
同城跑腿小程序核心功能解析：多订单合并、智能计费与实时位置共享
小程序·跑腿小程序·小程序制作·同城小程序·同城服务小程序开发·跑腿小程序开发·外卖小程序开发
HIT_Weston25 分钟前
50、【Ubuntu】【Gitlab】拉出内网 Web 服务：http.server 单/多线程分析（二）
前端·ubuntu·gitlab
热门推荐
01GitHub 镜像站点02【超详细教程】手把手教你从微软官网免费下载Windows 10官方原版ISO镜像（2025最新版）03UV安装并设置国内源04安娜的档案(Anna’s Archive) 镜像网站/国内最新可访问入口（持续更新）05React CVE-2025-55182漏洞排查与修复指南06BongoCat - 跨平台键盘猫动画工具07本地部署阿里最新开源的Z-Image08Linux下V2Ray安装配置指南09智能库存管理的需求预测模型：从业务痛点到落地代码的完整实践10Labelme从安装到标注：零基础完整指南