@huiqiangdev/react-native-wechat-api v1.0.3

react-native-wechat-api

微信SDK

React Native bridging library that integrates WeChat SDKs:

• iOS SDK 1.9.2
• Android SDK 6.8.0

Installation

npm install @huiqiangdev/react-native-wechat-api

yarn add @huiqiangdev/react-native-wechat-api

Start

• iOS 安装
• Android 安装

Usage

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

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

registerApp(appid) 注册

• appid {String} the appid you get from WeChat dashboard
• universalLink ios 需要 / android 为空
• returns {Boolean} explains if your application is registered done

This method should be called once globally.

import * as WeChat from '@huiqiangdev/react-native-wechat-api';

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

class ShareMetadata

• title {String} title of this message.
• 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:

The following examples require the 'react-native-chat' and 'react-native-fs' packages.

import * as WeChat from '@/huiqiangdev/react-native-wechat-api';
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 sends the message to a friend or chat group.

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

• returns {Boolean} if WeChat is installed.

Check if the WeChat app is installed on the device.

import * as WeChat from 'react-native-wechat-api';

WeChat.isWXAppInstalled();

isWXAppSupportApi() 检查支持情况

• returns {Boolean} Contains the result.

Check if wechat support open url.

import * as WeChat from 'react-native-wechat-api';

WeChat.isWXAppSupportApi();

getApiVersion() 获取 API 版本号

• returns {String} Contains the result.

Get the WeChat SDK api version.

import * as WeChat from 'react-native-wechat-api';

WeChat.getApiVersion();

openWXApp() 打开微信

• returns {Boolean}

Open the WeChat app from your application.

import * as WeChat from 'react-native-wechat-api';

WeChat.openWXApp();

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

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

ShareImage(ShareImageMetadata) 分享图片

ShareImageMetadata

Return:

import * as WeChat from 'react-native-wechat-api';

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

ShareLocalImage(ShareImageMetadata) 分享本地图片

ShareImageMetadata

Return:

ShareFile(ShareFileMetadata) 分享文件

ShareFileMetadata

Return:

import * as WeChat from 'react-native-wechat-api';

WeChat.shareFile({
  imageUrl: 'https://sdcard/test.png',
  title: '测试文件.pdf',
  scene: 0,
});

ShareMusic(ShareMusicMetadata) 分享音乐

ShareMusicMetadata

Return:

import * as WeChat from 'react-native-wechat-api';

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

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

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

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

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

launchCustomerService (LaunchCustomerServiceMetadata) 跳到小程序

LaunchMiniProgramMetadata

Return:

import * as WeChat from 'react-native-wechat-api';

WeChat.launchCustomerService({
  corpid: 'gh_d39d10000000',
  url: 'https://work.weixin.qq.com/kfid/kfcxxxxx',
});

ChooseInvoice (ChooseInvoice) 选择发票

ChooseInvoice

Invoice

Return:

import * as WeChat from 'react-native-wechat-api';

// ios 什么都不填都可以，android可以填写以下假的内容都可以正常运行，具体参数获取可以去看微信文档
WeChat.chooseInvoice({
  cardSign: 'cardSign',
  signType: 'SHA256',
  timeStamp: Date.now(),
  nonceStr: `${Date.now()}`,
});

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}

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT