Options
All
  • Public
  • Public/Protected
  • All
Menu

对微信 JSSDK 的封装。

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

Hierarchy

  • Wechat

Index

Constructors

constructor

Properties

configParams

configParams: WechatConfigParams = {} as any

注入微信 JSSDK 的权限验证配置参数。

Methods

checkJsApi

  • checkJsApi<T>(jsApiList: T[]): Promise<Record<T, boolean>>
  • 判断当前客户端版本是否支持指定 JS 接口。

    Type parameters

    Parameters

    • jsApiList: T[]

      需要检测的 JS 接口列表

    Returns Promise<Record<T, boolean>>

    以键值对的形式返回,可用的 apitrue,不可用为 false

chooseImage

closeWindow

  • closeWindow(): Promise<any>
  • 关闭当前网页窗口。

    Returns Promise<any>

config

hideAllNonBaseMenuItems

  • hideAllNonBaseMenuItems(): Promise<any>
  • 隐藏所有的非基础菜单项。

    Returns Promise<any>

hideNonBaseMenuItems

invoke

  • invoke(jsApi: WechatJsApi, params?: Record<string, any>): Promise<any>
  • 调用 JSSDK 的 API 方法。

    Parameters

    • jsApi: WechatJsApi

      要调用的 API 名称

    • Default value params: Record<string, any> = {}

      传给 API 的参数

    Returns Promise<any>

    调用结果

onError

previewImage

showAllNonBaseMenuItems

  • showAllNonBaseMenuItems(): Promise<any>
  • 显示所有的非基础菜单项。

    Returns Promise<any>

showNonBaseMenuItems

updateShareData

uploadImage

  • 上传图片。

    备注: 上传图片有效期3天, 可用微信多媒体接口下载图片到自己的服务器, 此处获得的服务器端 ID 即 media_id

    Parameters

    Returns Promise<string>

    图片的服务器端 ID

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc