vtils

Home > utils > Wechat

Wechat class

对微信 JSSDK 的封装。

Signature:

export declare class Wechat 

Example

const wechat = new Wechat()
getWechatConfigAsync().then(config => {
  wechat.config(config)
})
wechat.updateShareData({
  title: '分享标题',
  desc: '分享描述',
  link: '分享链接',
  imgUrl: '缩略图地址',
})
wechat.invoke('scanQRCode').then(res => {
  // => API 调用结果
})

Constructors

Constructor Modifiers Description
(constructor)(params)   构造函数。

Properties

Property Modifiers Type Description
configParams   WechatConfigParams 注入微信 JSSDK 的权限验证配置参数。
uploadImage   (params: WechatUploadImageParams) => Promise<WechatUploadImageResult> <p>上传图片。</p><p>内部已作处理保证同时只能有一个图片在上传。</p><p>**备注:** 上传图片有效期3天, 可用微信多媒体接口下载图片到自己的服务器, 此处获得的服务器端 ID 即 media_id。</p>

Methods

Method Modifiers Description
beforeInvoke(cb)    
checkJsApi(jsApiList)   判断当前客户端版本是否支持指定 JS 接口。
chooseImage(params)   选择图片。
closeWindow()   关闭当前网页窗口。
config(params)   注入微信 JSSDK 的权限验证配置。
getLocation(params)   获取地理位置接口。
hideAllNonBaseMenuItems()   隐藏所有的非基础菜单项。
hideNonBaseMenuItems(menuList)   批量隐藏非基础菜单项。
invoke(jsApi, params)   调用 JSSDK 的 API 方法。
isReady()   微信 JSSDK 是否准备好可用。
onError(callback)   错误处理。
openLocation(params)   使用微信内置地图查看位置。
previewImage(params)   预览图片。
requestPayment(params)   发起微信支付。
showAllNonBaseMenuItems()   显示所有的非基础菜单项。
showNonBaseMenuItems(menuList)   批量显示非基础菜单项。
updateShareData(params)   <p>设置分享数据。</p><p>**注意**:每次分享的数据会和上次分享的数据合并作为最终分享的数据,因此,可以设置全局的分享数据。</p>