react-native-mwechat v2.4.3

React-Native-Mwechat

React Native bridging library that integrates WeChat SDKs:

• iOS SDK 1.9.2
• Android SDK 6.8.0

前言

首先向各位声明，本库是在 react-native-wechat-lib 基础上进行调整。

由于 react-native-wechat-lib 所使用的 WeChat SDK 已经是几年前的版本，考虑到自身使用和其它开发者的需要，最终决定开一个新仓库，提供给新项目使用。

最后

感谢 yorkie 和各位开发者为 react-native-wechat 做出的贡献。

感谢 little-snow-fox 和各位开发者为 react-native-wechat-lib 做出的贡献。

目录

• 安装
• 起步
• API 文档

安装

npm install react-native-mwechat --save
react-native link react-native-mwechat

起步

• iOS 安装
• Android 安装

API文档

本库支持 TypeScript，使用 Promise 或 async/await 来接收返回。

接口名称和参数尽量跟腾讯官网保持一致性，除了嵌套对象变成扁平对象，你可以直接查看腾讯文档来获得更多帮助。

registerApp(appid) 注册

• appid {String} the appid you get from WeChat dashboard
• returns {Boolean} explains if your application is registered done

This method should be called once globally.

import * as WeChat from 'react-native-mwechat';

WeChat.registerApp('appid', 'universalLink');

isWXAppInstalled() 判断微信是否已安装

• returns {Boolean} if WeChat is installed.

Check if the WeChat app is installed on the device.

isWXAppSupportApi() 检查支持情况

• returns {Boolean} Contains the result.

Check if wechat support open url.

getApiVersion() 获取API版本号

• returns {String} Contains the result.

Get the WeChat SDK api version.

openWXApp() 打开微信

• returns {Boolean}

Open the WeChat app from your application.

sendAuthRequest([scope, state]) 微信授权登录

• scope {Array|String} Scopes of auth request.
• state {String} the state of OAuth2
• returns {Object}

Send authentication request, and it returns an object with the following fields:

ShareText(ShareTextMetadata) 分享文本

ShareTextMetadata

Return:

import * as WeChat from 'react-native-mwechat';

WeChat.shareText({
  text: 'Text content.',
  scene: 0
})

ShareImage(ShareImageMetadata) 分享图片

ShareImageMetadata

Return:

import * as WeChat from 'react-native-mwechat';

WeChat.shareImage({
  imageUrl: 'https://google.com/1.jpg',
  scene: 0
})

ShareLocalImage(ShareImageMetadata) 分享本地图片

ShareImageMetadata

Return:

import * as WeChat from 'react-native-mwechat';

WeChat.ShareLocalImage({
  imageUrl: '/sdcard/test.png',
  scene: 0
})

注意：图片路径必须在一个 Public 目录里，例如 Download 目录，否则微信没权限读取这张图片，导致图片发不出去。

ShareMusic(ShareMusicMetadata) 分享音乐

ShareMusicMetadata

Return:

import * as WeChat from 'react-native-mwechat';

WeChat.shareMusic({
  title: 'Good music.',
  musicUrl: 'https://google.com/music.mp3',
  thumbImageUrl: 'https://google.com/1.jpg',
  scene: 0
})

ShareVideo(ShareVideoMetadata) 分享视频

ShareVideoMetadata

Return:

import * as WeChat from 'react-native-mwechat';

WeChat.shareVideo({
  title: 'Interesting video.',
  videoUrl: 'https://google.com/music.mp3',
  thumbImageUrl: 'https://google.com/1.jpg',
  scene: 0
})

ShareWebpage (ShareWebpageMetadata) 分享网页

ShareWebpageMetadata

Return:

import * as WeChat from 'react-native-mwechat';

WeChat.shareWebpage({
  title: 'Interesting web.',
  videoUrl: 'https://google.com/music.mp3',
  thumbImageUrl: 'https://google.com/1.jpg',
  scene: 0
})

ShareMiniProgram(ShareMiniProgramMetadata) 分享小程序

ShareMiniProgram

Return:

import * as WeChat from 'react-native-mwechat';

WeChat.shareMiniProgram({
  title: 'Mini program.',
  userName: 'gh_d39d10000000',
  webpageUrl: 'https://google.com/show.html',
  thumbImageUrl: 'https://google.com/1.jpg',
  scene: 0
})

LaunchMiniProgram (LaunchMiniProgramMetadata) 跳到小程序

LaunchMiniProgramMetadata

Return:

import * as WeChat from 'react-native-mwechat';

WeChat.launchMiniProgram({
  userName: 'gh_d39d10000000',
  miniProgramType: 1
})

pay(payload) 支付

• payload {Object} the payment data
  • partnerId {String} 商家向财付通申请的商家ID
  • prepayId {String} 预支付订单ID
  • nonceStr {String} 随机串
  • timeStamp {String} 时间戳
  • package {String} 商家根据财付通文档填写的数据和签名
  • sign {String} 商家根据微信开放平台文档对数据做的签名
• returns {Object}

Sends request for proceeding payment, then returns an object:

subscribeMessage(SubscribeMessageMetadata) 一次性订阅消息

• returns {Object}

openCustomerServiceChat (WXOpenCustomerServiceChat) 拉起微信客服

Return:

import * as WeChat from 'react-native-mwechat';

WeChat.openCustomerServiceChat({
  corpId: 'wx123432324',
  url: 'https://work.weixin.qq.com/kfid/kfc/123123123'
})

handleLaunchAppReq 获取启动onReq信息

为了解决微信唤醒App时原生端先触发，但是ReactJs还未准备好，所以以下项目配置信息会缓存启动的时的数据，等调用handleLaunchAppReq时触发WeChat_Req

此方法会触发模块的WeChat_Req，所以在调用此方法之前需要添加WeChat_Req监听

• 需要配置项目

import * as WeChat from 'react-native-mwechat';

WeChat.registerApp(config.wechat.appID, config.wechat.universalLink); //需要调用
let _wechatReq = DeviceEventEmitter.addListener('WeChat_Req', req => {
  console.log(JSON.stringify(req));
});
WeChat.handleLaunchAppReq();

_wechatReq?.remove?.(); //销毁时记得移除监听

License

MIT