React-Native-easy-Wechat

React Native bridging library that integrates WeChat SDKs:

iOS SDK @1.8.2
Android SDK @lastVersion

And [react-native-easy-wechat] has the following tracking data in open source world:

NPM	Dependency	Downloads	Build

Get Startted

Build setup on iOS
Build setup on Android

API Documentation

[react-native-easy-wechat] exposes the promise-based, therefore you could use Promise or async/await to manage your dataflow.

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-easy-wechat';

WeChat.registerApp('appid');

registerAppWithDescription(appid, description)

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

This method is only available on iOS.

isWXAppInstalled()

returns {Boolean} if WeChat is installed.

Check if wechat installed in this app.

isWXAppSupportApi()

returns {Boolean} Contain the result.

Check if wechat support open url.

getApiVersion()

returns {String} Contain the result.

Get api version of WeChat SDK.

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:

field	type	description
errCode	Number	Error Code
errStr	String	Error message if any error occurred
openId	String
code	String	Authorization code
url	String	The URL string
lang	String	The user language
country	String	The user country

class `ShareMetadata`

type {Number} type of this message. Can be {news|text|imageUrl|imageFile|imageResource|video|audio|file}
thumbImage {String} Thumb image of the message, which can be a uri or a resource id.
description {String} The description about the sharing.
webpageUrl {String} Required if type equals news. The webpage link to share.
imageUrl {String} Provide a remote image if type equals image.
videoUrl {String} Provide a remote video if type equals video.
musicUrl {String} Provide a remote music if type equals audio.
filePath {String} Provide a local file if type equals file.
fileExtension {String} Provide the file type if type equals file.

shareToTimeline(message)

message {ShareMetadata} This object saves the metadata for sharing
returns {Object}

Share a ShareMetadata message to timeline(朋友圈) and returns:

name	type	description
errCode	Number	0 if authorization successed
errStr	String	Error message if any error occurred

These example code need 'react-native-chat' and 'react-native-fs' plugin.

import * as WeChat from 'react-native-easy-wechat';
import fs from 'react-native-fs';
let resolveAssetSource = require('resolveAssetSource');

// Code example to share text message:
try {
  let result = await WeChat.shareToTimeline({
    type: 'text', 
    description: 'hello, wechat'
  });
  console.log('share text message to time line successful:', result);
} catch (e) {
  if (e instanceof WeChat.WechatError) {
    console.error(e.stack);
  } else {
    throw e;
  }
}

// Code example to share image url:
// Share raw http(s) image from web will always fail with unknown reason, please use image file or image resource instead
try {
  let result = await WeChat.shareToTimeline({
    type: 'imageUrl',
    title: 'web image',
    description: 'share web image to time line',
    mediaTagName: 'email signature',
    messageAction: undefined,
    messageExt: undefined,
    imageUrl: 'http://www.ncloud.hk/email-signature-262x100.png'
  });
  console.log('share image url to time line successful:', result);
} catch (e) {
  if (e instanceof WeChat.WechatError) {
    console.error(e.stack);
  } else {
    throw e;
  }
}

// Code example to share image file:
try {
  let rootPath = fs.DocumentDirectoryPath;
  let savePath = rootPath + '/email-signature-262x100.png';
  console.log(savePath);
  
  /*
   * savePath on iOS may be:
   *  /var/mobile/Containers/Data/Application/B1308E13-35F1-41AB-A20D-3117BE8EE8FE/Documents/email-signature-262x100.png
   *
   * savePath on Android may be:
   *  /data/data/com.wechatsample/files/email-signature-262x100.png
   **/
  await fs.downloadFile('http://www.ncloud.hk/email-signature-262x100.png', savePath);
  let result = await WeChat.shareToTimeline({
    type: 'imageFile',
    title: 'image file download from network',
    description: 'share image file to time line',
    mediaTagName: 'email signature',
    messageAction: undefined,
    messageExt: undefined,
    imageUrl: "file://" + savePath // require the prefix on both iOS and Android platform
  });
  console.log('share image file to time line successful:', result);
} catch (e) {
  if (e instanceof WeChat.WechatError) {
    console.error(e.stack);
  } else {
    throw e;
  }
}

// Code example to share image resource:
try {
  let imageResource = require('./email-signature-262x100.png');
  let result = await WeChat.shareToTimeline({
    type: 'imageResource',
    title: 'resource image',
    description: 'share resource image to time line',
    mediaTagName: 'email signature',
    messageAction: undefined,
    messageExt: undefined,
    imageUrl: resolveAssetSource(imageResource).uri
  });
  console.log('share resource image to time line successful', result);
}
catch (e) {
  if (e instanceof WeChat.WechatError) {
    console.error(e.stack);
  } else {
    throw e;
  }
}

// Code example to download an word file from web, then share it to WeChat session
// only support to share to session but time line
// iOS code use DocumentDirectoryPath
try {
  let rootPath = fs.DocumentDirectoryPath;
  let fileName = 'signature_method.doc';
  /*
   * savePath on iOS may be:
   *  /var/mobile/Containers/Data/Application/B1308E13-35F1-41AB-A20D-3117BE8EE8FE/Documents/signature_method.doc
   **/ 
  let savePath = rootPath + '/' + fileName;

  await fs.downloadFile('https://open.weixin.qq.com/zh_CN/htmledition/res/assets/signature_method.doc', savePath);
  let result = await WeChat.shareToSession({
    type: 'file',
    title: fileName, // WeChat app treat title as file name
    description: 'share word file to chat session',
    mediaTagName: 'word file',
    messageAction: undefined,
    messageExt: undefined,
    filePath: savePath,
    fileExtension: '.doc'
  });
  console.log('share word file to chat session successful', result);
} catch (e) {
  if (e instanceof WeChat.WechatError) {
    console.error(e.stack);
  } else {
    throw e;
  }
}

//android code use ExternalDirectoryPath
try {
  let rootPath = fs.ExternalDirectoryPath;
  let fileName = 'signature_method.doc';
  /*
   * savePath on Android may be:
   *  /storage/emulated/0/Android/data/com.wechatsample/files/signature_method.doc
   **/
  let savePath = rootPath + '/' + fileName;
  await fs.downloadFile('https://open.weixin.qq.com/zh_CN/htmledition/res/assets/signature_method.doc', savePath);
  let result = await WeChat.shareToSession({
    type: 'file',
    title: fileName, // WeChat app treat title as file name
    description: 'share word file to chat session',
    mediaTagName: 'word file',
    messageAction: undefined,
    messageExt: undefined,
    filePath: savePath,
    fileExtension: '.doc'
  });
  console.log('share word file to chat session successful', result);
}
catch (e) {
  if (e instanceof WeChat.WechatError) {
    console.error(e.stack);
  } else {
    throw e;
  }
}

shareToSession(message)

message {ShareMetadata} This object saves the metadata for sharing
returns {Object}

Similar to shareToTimeline but send message to a friend or chat group.

pay(payload)

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

shareToMiniProgram(data)

webpageUrl {String} 兼容低版本的网页链接
miniprogramType {String} 小程序的类型，正式版:0，测试版:1，体验版:2
userName {String} 小程序原始id
path {String} 小程序页面路径
title {String} 小程序消息desc
thumbData {String} 小程序消息封面图片，小于128k

    const isWXAppInstalled = await wechat.isWXAppInstalled();
    const description = `${this.state.inviteCompany}的${global.User.name}给您发了一封邀请函，请查收。`;
    let thumbImage = resolveAssetSource(this.state.templateType.shareIcon).uri;
    const hdImageData = resolveAssetSource(this.state.templateType.miniProgramCard).uri;
    const WXMiniProgramType = wechat.WXMiniProgramType.WXMiniProgramTypeTest;
    if (isWXAppInstalled) {
      const result = await wechat.shareToMiniProgram({
        title: description,
        WXMiniProgramType,
        description,
        thumbImage,
        webpageUrl: `${Api.INVITATION_URL}${cardId}`,
        userName: WXMiniProgramName,
        path: `${WXMiniProgramPath}${cardId}`,
        hdImageData,
      });
      console.warn(result);
    } else {
      Toast.show('您的手机还没有安装微信，请先安装微信客户端');
      console.warn(isWXAppInstalled, '没有安装微信');
    }

openWXMiniProgram(data)

miniprogramType {String} 小程序的类型，正式版:0，测试版:1，体验版:2
userName {String} 小程序原始id
path {String} 小程序页面路径

const isWXAppInstalled = await wechat.isWXAppInstalled();
const WXMiniProgramType = wechat.WXMiniProgramType.WXMiniProgramTypeTest;
   if (isWXAppInstalled) {
     wechat.openMiniProgram({
       WXMiniProgramType,
       userName: WXMiniProgramName,
       path: `${WXMiniProgramPath}${cardId}`,
     }).catch(e => console.warn(e));
   } else {
     Toast.show('您的手机还没有安装微信，请先安装微信客户端');
     console.warn(isWXAppInstalled, '没有安装微信');
   }

Sends request for proceeding payment, then returns an object:

name	type	description
errCode	Number	0 if authorization successed
errStr	String	Error message if any error occurred

Installation

$ npm install react-native-wechat --save

Tutorials

react-native-wechat微信组件的使用
超详细React Native实现微信好友/朋友圈分享功能-Android/iOS双平台通用
柳轩涤俗 - 微信登录

Who use it

Authors

GitHub	Role	Email
@yorkie	Author	yorkiefixer@gmail.com
@xing-zheng	Emeriti
@tdzl2003	Emeriti	tdzl2003@gmail.com

License

MIT

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

React-Native-easy-Wechat

Table of Contents

Get Startted

API Documentation

registerApp(appid)

registerAppWithDescription(appid, description)

isWXAppInstalled()

isWXAppSupportApi()

getApiVersion()

openWXApp()

sendAuthRequest([scope[, state]])

class `ShareMetadata`

shareToTimeline(message)

shareToSession(message)

pay(payload)

shareToMiniProgram(data)

openWXMiniProgram(data)

Installation

Tutorials

Who use it

Authors

License

Files

README.md

Latest commit

History

README.md

File metadata and controls

React-Native-easy-Wechat

Table of Contents

Get Startted

API Documentation

registerApp(appid)

registerAppWithDescription(appid, description)

isWXAppInstalled()

isWXAppSupportApi()

getApiVersion()

openWXApp()

sendAuthRequest([scope[, state]])

class ShareMetadata

shareToTimeline(message)

shareToSession(message)

pay(payload)

shareToMiniProgram(data)

openWXMiniProgram(data)

Installation

Tutorials

Who use it

Authors

License

class `ShareMetadata`