小程序API能力汇总——基础容器API（三）
ty.getAccountInfo
获取小程序账号信息
需引入
MiniKit，且在>=3.1.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;
ty.getAccountInfoSync
获取小程序账号信息同步方法
需引入
MiniKit，且在>=3.1.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;
};
ty.setBoardIcon
设置小程序看板的 icon
需引入
MiniKit，且在>=3.0.3版本才可使用
参数
Object object
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| icon | string | 是 | 看板的 icon | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | |
| success | function | 否 | 接口调用成功的回调函数 | |
| fail | function | 否 | 接口调用失败的回调函数 |
函数定义示例
/*** 小程序看板的icon，小程序icon，面板icon等*/
export function setBoardIcon(params: {/** 看板的icon */icon: string;/** 接口调用结束的回调函数（调用成功、失败都会执行） */complete?: () => void;/** 接口调用成功的回调函数 */success?: (params: null) => void;/** 接口调用失败的回调函数 */fail?: (params: {errorMsg: string;errorCode: string | number;innerError: {errorCode: string | number;errorMsg: string;};}) => void;
}): void;ty.setBoardIconSync
设置小程序看板的 icon
需引入
MiniKit，且在>=3.0.3版本才可使用ty.setBoardIcon 的同步版本
参数
Object object
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| icon | string | 是 | 看板的 icon |
函数定义示例
/*** 设置小程序看板的 icon*/
export function setBoardIconSync(params: {/** 看板的icon */icon: string;
}): null;ty.showBoardTitleIcon
显示小程序看板中的标题和 icon
需引入
MiniKit，且在>=3.0.3版本才可使用
参数
Object object
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | |
| success | function | 否 | 接口调用成功的回调函数 | |
| fail | function | 否 | 接口调用失败的回调函数 |
函数定义示例
/*** 显示小程序看板中的标题和icon*/
export function showBoardTitleIcon(params?: {/** 接口调用结束的回调函数（调用成功、失败都会执行） */complete?: () => void;/** 接口调用成功的回调函数 */success?: (params: null) => void;/** 接口调用失败的回调函数 */fail?: (params: {errorMsg: string;errorCode: string | number;innerError: {errorCode: string | number;errorMsg: string;};}) => void;
}): void;ty.showBoardTitleIconSync
The synchronous method used to display the title and icon of the miniapp dashboard.
Be sure to import
MiniKit3.0.3 or later.The synchronous method of
ty.showBoardTitleIcon.
Examples of function definitions
/*** Display the title and icon of the miniapp dashboard.*/
export function showBoardTitleIconSync(): null;ty.hideBoardTitleIcon
隐藏小程序看板中的标题和 icon
需引入
MiniKit，且在>=3.0.3版本才可使用
参数
Object object
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | |
| success | function | 否 | 接口调用成功的回调函数 | |
| fail | function | 否 | 接口调用失败的回调函数 |
函数定义示例
/*** 隐藏小程序看板中的标题和icon*/
export function hideBoardTitleIcon(params?: {/** 接口调用结束的回调函数（调用成功、失败都会执行） */complete?: () => void;/** 接口调用成功的回调函数 */success?: (params: null) => void;/** 接口调用失败的回调函数 */fail?: (params: {errorMsg: string;errorCode: string | number;innerError: {errorCode: string | number;errorMsg: string;};}) => void;
}): void;
ty.hideBoardTitleIconSync
隐藏小程序看板中的标题和 icon 同步方法
需引入
MiniKit，且在>=3.0.3版本才可使用ty.hideBoardTitleIcon 的同步版本
函数定义示例
/*** 隐藏小程序看板中的标题和icon*/
export function hideBoardTitleIconSync(): null;👉 立即开发。