小程序API能力汇总——基础容器API（四）-Toy模板网

这篇具有很好参考价值的文章主要介绍了小程序API能力汇总——基础容器API（四）。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

ty.showStatusBar

显示手机状态栏

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

参数

Object object

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

函数定义示例

/**
 * 显示手机状态栏
 */
export function showStatusBar(params?: {
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.hideStatusBar

隐藏手机状态栏

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

参数

Object object

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

函数定义示例

/**
 * 隐藏手机状态栏
 */
export function hideStatusBar(params?: {
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.share

需引入BizKit，且在>=3.0.0版本才可使用

参数

Object object

属性	类型	必填	说明
type	`string`	是	分享渠道，可选值如下： WeChat：微信 Message：短信 Email：邮件 More：系统更多分享渠道（调用系统分享）
title	`string`	是	title 标题
message	`string`	是	message 文本内容
contentType	`string`	是	contentType 内容类型空值默认为 text 可选值如下： text：文本 image：图片 file：文件 web：网页地址 miniProgram：微信小程序分享内容
recipients	`array`	否	recipients 邮件收件人
imagePath	`string`	否	imagePath 图片路径
filePath	`string`	否	filePath 当 contentType == file 时候使用
webPageUrl	`string`	否	web 当 contentType == file 时候使用
miniProgramInfo	`MiniProgramInfo`	否	miniProgramInfo 当 contentType == miniProgram 时候使用，且分享渠道必须是微信。
complete	`function`	否	接口调用结束的回调函数（调用成功、失败都会执行）
success	`function`	否	接口调用成功的回调函数
fail	`function`	否	接口调用失败的回调函数

MiniProgramInfo

属性	类型	必填	说明
userName	`string`	是	用户名称
path	`string`	是	路径
hdImagePath	`string`	是	图片地址
withShareTicket	`boolean`	是	ticket
miniProgramType	`number`	是	类型
webPageUrl	`string`	是	小程序地址

ty.getShareChannelList

获取可分享的渠道列表

需引入BizKit，且在>=3.0.0版本才可使用

参数

Object object

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

object.success 回调参数

参数

Object res

属性	类型	说明
shareChannelList	`array`	可分享的渠道列表

object.fail 回调参数

参数

Object res

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

ty.getUserInfo

获取用户信息

需引入BizKit，且在>=3.0.0版本才可使用

参数

Object object

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

object.success 回调参数

参数

Object res

属性	类型	说明
nickName	`string`	nickName 用户昵称
avatarUrl	`string`	用户头像
phoneCode	`string`	国家代码
isTemporaryUser	`boolean`	是否是临时用户

object.fail 回调参数

参数

Object res

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

ty.openCountrySelectPage

进入选择国家页面

需引入BizKit，且在>=3.0.0版本才可使用

参数

Object object

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