小程序API能力集成指南——界面容器API汇总

ty.setBoardTitle

小程序看板的标题，小程序名称，面板名称等

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

参数

Object object

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

函数定义示例

/**
 * 小程序看板的标题，小程序名称，面板名称等
 */
export function setBoardTitle(params: {
  /** 看板的标题 */
  title: string;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

 

ty.setBoardTitleSync

小程序看板的标题，小程序名称，面板名称等同步方法

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

ty.setBoardTitle 的同步版本

参数

Object object

属性	类型	默认值	必填	说明
title	string		是	看板的标题

函数定义示例

/**
 * 小程序看板的标题，小程序名称，面板名称等
 */
export function setBoardTitleSync(params: {
  /** 看板的标题 */
  title: string;
}): null;

 

ty.startPullDownRefresh

开始下拉刷新。调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。

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

参数

Object object

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

函数定义示例

/**
 * 开始下拉刷新。调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。
 */
export function startPullDownRefresh(params?: {
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

 

ty.stopPullDownRefresh

停止当前页面下拉刷新。

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

参数

Object object

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

函数定义示例

/**
 * 停止当前页面下拉刷新。
 */
export function stopPullDownRefresh(params?: {
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

👉 立即开发。