FairClip/react-native-wechat-lib
3
0
Fork 0
forked from mirrors/react-native-wechat-lib
Code Pull Requests Activity

docs: improve

Browse Source
This commit is contained in:
Tom Xu 2021-01-18 15:25:30 +08:00
parent 0646908238
commit 1a4cd68c5d
1 changed files with 154 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

268
README.md
View File

@ -9,11 +9,11 @@
## 前言 ## 前言
首先向各位声明，本库是在 [react-native-wechat](https://github.com/yorkie/react-native-wechat) 基础上进行重写。 首先向各位声明，本库是在 [react-native-wechat](https://github.com/yorkie/react-native-wechat) 基础上进行重写。
本库已经向 react-native-wechat 提交合并请求[#526](https://github.com/yorkie/react-native-wechat/pull/526)，但由于 react-native-wechat 所使用的 WeChat SDK 已经是几年前的版本，新 SDK 接口变动大，我修改的代码相当多，几乎重构了核心部分，导致合并需要耗费不小时间，再加上需要兼容正在使用旧版 SDK 的开发者，事情变得异常艰辛。 本库已经向 react-native-wechat 提交合并请求[#526](https://github.com/yorkie/react-native-wechat/pull/526)，但由于 react-native-wechat 所使用的 WeChat SDK 已经是几年前的版本，新 SDK 接口变动大，我修改的代码相当多，几乎重构了核心部分，导致合并需要耗费不小时间，再加上需要兼容正在使用旧版 SDK 的开发者，事情变得异常艰辛。
考虑到自身使用和其它开发者的需要，最终决定开一个新仓库，提供给新项目使用。 考虑到自身使用和其它开发者的需要，最终决定开一个新仓库，提供给新项目使用。
最后，感谢 [yorkie](https://github.com/yorkie) 和各位开发者为 react-native-wechat 做出的贡献。 最后，感谢 [yorkie](https://github.com/yorkie) 和各位开发者为 react-native-wechat 做出的贡献。
@ -40,9 +40,9 @@ react-native link react-native-wechat-lib
- [iOS 安装](./docs/build-setup-ios.md) - [iOS 安装](./docs/build-setup-ios.md)
- [Android 安装](./docs/build-setup-android.md) - [Android 安装](./docs/build-setup-android.md)
## API文档 ## API 文档
本库支持 `TypeScript`，使用 `Promise` 或 `async/await` 来接收返回。 本库支持 `TypeScript`，使用 `Promise` 或 `async/await` 来接收返回。
接口名称和参数尽量跟腾讯官网保持一致性，除了嵌套对象变成扁平对象，你可以直接查看腾讯文档来获得更多帮助。 接口名称和参数尽量跟腾讯官网保持一致性，除了嵌套对象变成扁平对象，你可以直接查看腾讯文档来获得更多帮助。
@ -71,7 +71,7 @@ Check if the WeChat app is installed on the device.
Check if wechat support open url. Check if wechat support open url.
#### getApiVersion() 获取API版本号 #### getApiVersion() 获取 API 版本号
- returns {String} Contains the result. - returns {String} Contains the result.
@ -79,7 +79,7 @@ Get the WeChat SDK api version.
#### openWXApp() 打开微信 #### openWXApp() 打开微信
- returns {Boolean} - returns {Boolean}
Open the WeChat app from your application. Open the WeChat app from your application.
@ -89,11 +89,11 @@ Open the WeChat app from your application.
- `state` {String} the state of OAuth2 - `state` {String} the state of OAuth2
- returns {Object} - returns {Object}
Send authentication request, and it returns an object with the Send authentication request, and it returns an object with the
following fields: following fields:
| field | type | description | | field | type | description |
|---------|--------|-------------------------------------| | ------- | ------ | ----------------------------------- |
| errCode | Number | Error Code | | errCode | Number | Error Code |
| errStr | String | Error message if any error occurred | | errStr | String | Error message if any error occurred |
| openId | String | | | openId | String | |
@ -102,112 +102,121 @@ following fields:
| lang | String | The user language | | lang | String | The user language |
| country | String | The user country | | country | String | The user country |
#### ShareText(ShareTextMetadata) 分享文本 #### ShareText(ShareTextMetadata) 分享文本
ShareTextMetadata ShareTextMetadata
| name | type | description | | name | type | description |
|---------|--------|----------------------------------| | ----- | ------ | ------------------------------ |
| text | String | 分享文本 | | text | String | 分享文本 |
| scene | Number | 分享到, 0:会话 1:朋友圈 2:收藏 | | scene | Number | 分享到, 0:会话 1:朋友圈 2:收藏 |
Return: Return:
| name | type | description | | name | type | description |
|---------|--------|-------------------------------------| | ------- | ------ | ----------------------------------- |
| errCode | Number | 0 if authorization succeed | | errCode | Number | 0 if authorization succeed |
| errStr | String | Error message if any error occurred | | errStr | String | Error message if any error occurred |
```js ```js
import * as WeChat from 'react-native-wechat-lib'; import * as WeChat from 'react-native-wechat-lib';
WeChat.shareText({ WeChat.shareText({
text: 'Text content.', text: 'Text content.',
scene: 0 scene: 0,
}) });
``` ```
#### ShareImage(ShareImageMetadata) 分享图片 #### ShareImage(ShareImageMetadata) 分享图片
ShareImageMetadata ShareImageMetadata
| name | type | description | | name | type | description |
|---------|--------|-------------------------------------| | -------- | ------ | ------------------------------ |
| imageUrl| String | 图片地址 | | imageUrl | String | 图片地址 |
| scene | Number | 分享到, 0:会话 1:朋友圈 2:收藏 | | scene | Number | 分享到, 0:会话 1:朋友圈 2:收藏 |
Return: Return:
| name | type | description | | name | type | description |
|---------|--------|-------------------------------------| | ------- | ------ | ----------------------------------- |
| errCode | Number | 0 if authorization succeed | | errCode | Number | 0 if authorization succeed |
| errStr | String | Error message if any error occurred | | errStr | String | Error message if any error occurred |
```js ```js
import * as WeChat from 'react-native-wechat-lib'; import * as WeChat from 'react-native-wechat-lib';
WeChat.shareImage({ WeChat.shareImage({
imageUrl: 'https://google.com/1.jpg', imageUrl: 'https://google.com/1.jpg',
scene: 0 scene: 0,
}) });
``` ```
#### ShareLocalImage(ShareImageMetadata) 分享本地图片 #### ShareLocalImage(ShareImageMetadata) 分享本地图片
ShareImageMetadata ShareImageMetadata
| name | type | description | | name | type | description |
|---------|--------|-------------------------------------| | -------- | ------ | ------------------------------ |
| imageUrl| String | 图片地址 | | imageUrl | String | 图片地址 |
| scene | Number | 分享到, 0:会话 1:朋友圈 2:收藏 | | scene | Number | 分享到, 0:会话 1:朋友圈 2:收藏 |
Return: Return:
| name | type | description | | name | type | description |
|---------|--------|-------------------------------------| | ------- | ------ | ----------------------------------- |
| errCode | Number | 0 if authorization succeed | | errCode | Number | 0 if authorization succeed |
| errStr | String | Error message if any error occurred | | errStr | String | Error message if any error occurred |
#### ShareFile(ShareFileMetadata) 分享文件
ShareFileMetadata
| name | type | description |
| ----- | ------ | -------------- |
| url | String | 文件地址 |
| title | String | 文件标题 |
| scene | Number | 分享到, 0:会话 |
Return:
| name | type | description |
| ------- | ------ | ----------------------------------- |
| errCode | Number | 0 if authorization succeed |
| errStr | String | Error message if any error occurred |
```js ```js
import * as WeChat from 'react-native-wechat-lib'; import * as WeChat from 'react-native-wechat-lib';
WeChat.ShareLocalImage({ WeChat.shareFile({
imageUrl: '/sdcard/test.png', imageUrl: 'https://sdcard/test.png',
scene: 0 title: '测试文件.pdf',
}) scene: 0,
});
``` ```
注意：图片路径必须在一个 Public 目录里，例如 Download 目录，否则微信没权限读取这张图片，导致图片发不出去。
#### ShareMusic(ShareMusicMetadata) 分享音乐 #### ShareMusic(ShareMusicMetadata) 分享音乐
ShareMusicMetadata ShareMusicMetadata
| name | type | description | | name | type | description |
|---------------------|--------|-------------------------------| | ------------------- | ------ | ------------------------------------- |
| title | String | 标题 | | title | String | 标题 |
| description | String | 描述 | | description | String | 描述 |
| thumbImageUrl | String | 缩略图地址，本库会自动压缩到32KB | | thumbImageUrl | String | 缩略图地址，本库会自动压缩到 32KB |
| musicUrl | String | 音频网页的URL地址 | | musicUrl | String | 音频网页的 URL 地址 |
| musicLowBandUrl | String | 供低带宽环境下使用的音频网页URL地址 | | musicLowBandUrl | String | 供低带宽环境下使用的音频网页 URL 地址 |
| musicDataUrl | String | 音频数据的URL地址 | | musicDataUrl | String | 音频数据的 URL 地址 |
| musicLowBandDataUrl | String | 供低带宽环境下使用的音频数据URL地址 | | musicLowBandDataUrl | String | 供低带宽环境下使用的音频数据 URL 地址 |
| scene | Number | 分享到, 0:会话 1:朋友圈 2:收藏 | | scene | Number | 分享到, 0:会话 1:朋友圈 2:收藏 |
Return: Return:
| name | type | description | | name | type | description |
|---------|--------|-------------------------------------| | ------- | ------ | ----------------------------------- |
| errCode | Number | 0 if authorization succeed | | errCode | Number | 0 if authorization succeed |
| errStr | String | Error message if any error occurred | | errStr | String | Error message if any error occurred |
```js ```js
import * as WeChat from 'react-native-wechat-lib'; import * as WeChat from 'react-native-wechat-lib';
@ -215,32 +224,30 @@ WeChat.shareMusic({
title: 'Good music.', title: 'Good music.',
musicUrl: 'https://google.com/music.mp3', musicUrl: 'https://google.com/music.mp3',
thumbImageUrl: 'https://google.com/1.jpg', thumbImageUrl: 'https://google.com/1.jpg',
scene: 0 scene: 0,
}) });
``` ```
#### ShareVideo(ShareVideoMetadata) 分享视频 #### ShareVideo(ShareVideoMetadata) 分享视频
ShareVideoMetadata ShareVideoMetadata
| name | type | description | | name | type | description |
|---------|--------|-------------------------------------| | --------------- | ------ | --------------------------------- |
| title| String | 标题 | | title | String | 标题 |
| description| String | 描述 | | description | String | 描述 |
| thumbImageUrl| String | 缩略图地址，本库会自动压缩到32KB | | thumbImageUrl | String | 缩略图地址，本库会自动压缩到 32KB |
| videoUrl| String | 视频链接 | | videoUrl | String | 视频链接 |
| videoLowBandUrl| String | 供低带宽的环境下使用的视频链接 | | videoLowBandUrl | String | 供低带宽的环境下使用的视频链接 |
| scene | Number | 分享到, 0:会话 1:朋友圈 2:收藏 | | scene | Number | 分享到, 0:会话 1:朋友圈 2:收藏 |
Return: Return:
| name | type | description | | name | type | description |
|---------|--------|-------------------------------------| | ------- | ------ | ----------------------------------- |
| errCode | Number | 0 if authorization succeed | | errCode | Number | 0 if authorization succeed |
| errStr | String | Error message if any error occurred | | errStr | String | Error message if any error occurred |
```js ```js
import * as WeChat from 'react-native-wechat-lib'; import * as WeChat from 'react-native-wechat-lib';
@ -248,31 +255,29 @@ WeChat.shareVideo({
title: 'Interesting video.', title: 'Interesting video.',
videoUrl: 'https://google.com/music.mp3', videoUrl: 'https://google.com/music.mp3',
thumbImageUrl: 'https://google.com/1.jpg', thumbImageUrl: 'https://google.com/1.jpg',
scene: 0 scene: 0,
}) });
``` ```
#### ShareWebpage (ShareWebpageMetadata) 分享网页 #### ShareWebpage (ShareWebpageMetadata) 分享网页
ShareWebpageMetadata ShareWebpageMetadata
| name | type | description | | name | type | description |
|---------|--------|-------------------------------------| | ------------- | ------ | --------------------------------- |
| title| String | 标题 | | title | String | 标题 |
| description| String | 描述 | | description | String | 描述 |
| thumbImageUrl| String | 缩略图地址，本库会自动压缩到32KB | | thumbImageUrl | String | 缩略图地址，本库会自动压缩到 32KB |
| webpageUrl| String | HTML 链接 | | webpageUrl | String | HTML 链接 |
| scene | Number | 分享到, 0:会话 1:朋友圈 2:收藏 | | scene | Number | 分享到, 0:会话 1:朋友圈 2:收藏 |
Return: Return:
| name | type | description | | name | type | description |
|---------|--------|-------------------------------------| | ------- | ------ | ----------------------------------- |
| errCode | Number | 0 if authorization succeed | | errCode | Number | 0 if authorization succeed |
| errStr | String | Error message if any error occurred | | errStr | String | Error message if any error occurred |
```js ```js
import * as WeChat from 'react-native-wechat-lib'; import * as WeChat from 'react-native-wechat-lib';
@ -280,36 +285,34 @@ WeChat.shareWebpage({
title: 'Interesting web.', title: 'Interesting web.',
videoUrl: 'https://google.com/music.mp3', videoUrl: 'https://google.com/music.mp3',
thumbImageUrl: 'https://google.com/1.jpg', thumbImageUrl: 'https://google.com/1.jpg',
scene: 0 scene: 0,
}) });
``` ```
#### ShareMiniProgram(ShareMiniProgramMetadata) 分享小程序 #### ShareMiniProgram(ShareMiniProgramMetadata) 分享小程序
ShareMiniProgram ShareMiniProgram
| name | type | description | | name | type | description |
|---------|--------|-------------------------------------| | --------------- | ------ | ---------------------------------------------------------------------------------- |
| title| String | 标题 | | title | String | 标题 |
| description| String | 描述 | | description | String | 描述 |
| thumbImageUrl| String | 缩略图地址，本库会自动压缩到32KB | | thumbImageUrl | String | 缩略图地址，本库会自动压缩到 32KB |
| userName| String | 小程序的 userName，填小程序原始id | | userName | String | 小程序的 userName，填小程序原始 id |
| path| String | 小程序的页面路径 | | path | String | 小程序的页面路径 |
| hdImageUrl| String | 小程序新版本的预览图二进制数据，6.5.9及以上版本微信客户端支持 | | hdImageUrl | String | 小程序新版本的预览图二进制数据，6.5.9 及以上版本微信客户端支持 |
| withShareTicket| String | 是否使用带shareTicket的分享 | | withShareTicket | String | 是否使用带 shareTicket 的分享 |
| miniProgramType| Number | 小程序的类型，默认正式版，1.8.1及以上版本开发者工具包支持分享开发版和体验版小程序 | | miniProgramType | Number | 小程序的类型，默认正式版，1.8.1 及以上版本开发者工具包支持分享开发版和体验版小程序 |
| webpageUrl| String | 兼容低版本的网页链接 | | webpageUrl | String | 兼容低版本的网页链接 |
| scene | Number | 分享到, 0:会话 1:朋友圈 2:收藏 | | scene | Number | 分享到, 0:会话 1:朋友圈 2:收藏 |
Return: Return:
| name | type | description | | name | type | description |
|---------|--------|-------------------------------------| | ------- | ------ | ----------------------------------- |
| errCode | Number | 0 if authorization succeed | | errCode | Number | 0 if authorization succeed |
| errStr | String | Error message if any error occurred | | errStr | String | Error message if any error occurred |
```js ```js
import * as WeChat from 'react-native-wechat-lib'; import * as WeChat from 'react-native-wechat-lib';
@ -318,44 +321,80 @@ WeChat.shareMiniProgram({
userName: 'gh_d39d10000000', userName: 'gh_d39d10000000',
webpageUrl: 'https://google.com/show.html', webpageUrl: 'https://google.com/show.html',
thumbImageUrl: 'https://google.com/1.jpg', thumbImageUrl: 'https://google.com/1.jpg',
scene: 0 scene: 0,
}) });
``` ```
#### LaunchMiniProgram (LaunchMiniProgramMetadata) 跳到小程序 #### LaunchMiniProgram (LaunchMiniProgramMetadata) 跳到小程序
LaunchMiniProgramMetadata LaunchMiniProgramMetadata
| name | type | description | | name | type | description |
|---------|--------|-------------------------------------| | --------------- | ------ | -------------------------------------------------------------------------------------------------------------------------- |
| userName| String | 填小程序原始id | | userName | String | 填小程序原始 id |
| miniProgramType| Number | 可选打开 开发版，体验版和正式版 | | miniProgramType | Number | 可选打开 开发版，体验版和正式版 |
| path| String | 拉起小程序页面的可带参路径，不填默认拉起小程序首页，对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 "?foo=bar" | | path | String | 拉起小程序页面的可带参路径，不填默认拉起小程序首页，对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 "?foo=bar" |
Return: Return:
| name | type | description | | name | type | description |
|---------|--------|-------------------------------------| | ------- | ------ | ----------------------------------- |
| errCode | Number | 0 if authorization succeed | | errCode | Number | 0 if authorization succeed |
| errStr | String | Error message if any error occurred | | errStr | String | Error message if any error occurred |
```js ```js
import * as WeChat from 'react-native-wechat-lib'; import * as WeChat from 'react-native-wechat-lib';
WeChat.launchMiniProgram({ WeChat.launchMiniProgram({
userName: 'gh_d39d10000000', userName: 'gh_d39d10000000',
miniProgramType: 1 miniProgramType: 1,
}) });
```
#### ChooseInvoice (ChooseInvoice) 跳到小程序
ChooseInvoice
| name | type | description |
| --------- | ------ | ----------- |
| cardSign | String | 签名 |
| signType | String | 签名类型 |
| timeStamp | Number | 当前时间戳 |
| nonceStr | String | 随机字符串 |
Invoice
| name | type | description |
| ----------- | ------ | ----------- |
| appId | String | |
| cardId | String | 发票 Id |
| encryptCode | String | 加密串 |
Return:
| name | type | description |
| ------- | --------- | ----------------------------------- |
| errCode | Number | 0 if authorization succeed |
| cards | Invoice[] | 发票数据 |
| errStr | String | Error message if any error occurred |
```js
import * as WeChat from 'react-native-wechat-lib';
// ios 什么都不填都可以，android可以填写以下假的内容都可以正常运行，具体参数获取可以去看微信文档
WeChat.chooseInvoice({
cardSign: 'cardSign',
signType: 'SHA256',
timeStamp: Date.now(),
nonceStr: `${Date.now()}`,
});
``` ```
#### pay(payload) 支付 #### pay(payload) 支付
- `payload` {Object} the payment data - `payload` {Object} the payment data
- `partnerId` {String} 商家向财付通申请的商家ID - `partnerId` {String} 商家向财付通申请的商家 ID
- `prepayId` {String} 预支付订单ID - `prepayId` {String} 预支付订单 ID
- `nonceStr` {String} 随机串 - `nonceStr` {String} 随机串
- `timeStamp` {String} 时间戳 - `timeStamp` {String} 时间戳
- `package` {String} 商家根据财付通文档填写的数据和签名 - `package` {String} 商家根据财付通文档填写的数据和签名
@ -365,7 +404,7 @@ WeChat.launchMiniProgram({
Sends request for proceeding payment, then returns an object: Sends request for proceeding payment, then returns an object:
| name | type | description | | name | type | description |
|---------|--------|-------------------------------------| | ------- | ------ | ----------------------------------- |
| errCode | Number | 0 if authorization succeed | | errCode | Number | 0 if authorization succeed |
| errStr | String | Error message if any error occurred | | errStr | String | Error message if any error occurred |
@ -373,15 +412,16 @@ Sends request for proceeding payment, then returns an object:
- returns {Object} - returns {Object}
| name | type | description |
| name | type | description | | ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|---------|--------|-------------------------------------| | scene | Number | 重定向后会带上 scene 参数，开发者可以填 0-10000 的整形值，用来标识订阅场值 |
| scene | Number | 重定向后会带上 scene 参数，开发者可以填 0-10000 的整形值，用来标识订阅场值 | | templateId | String | 订阅消息模板 ID，在微信开放平台提交应用审核通过后获得 |
| templateId | String | 订阅消息模板 ID，在微信开放平台提交应用审核通过后获得 | | reserved | String | 用于保持请求和回调的状态，授权请后原样带回给第三方。该参数可用于防止 csrf 攻击（跨站请求伪造攻击），建议第三方带上该参数，可设置为简单的随机数加 session 进行校验，开发者可以填写 a-zA-Z0-9 的参数值，最多 128 字节，要求做 urlencode |
| reserved | String | 用于保持请求和回调的状态，授权请后原样带回给第三方。该参数可用于防止 csrf 攻击（跨站请求伪造攻击），建议第三方带上该参数，可设置为简单的随机数加 session 进行校验，开发者可以填写 a-zA-Z0-9 的参数值，最多 128 字节，要求做 urlencode |
#### 回调事件订阅 #### 回调事件订阅
从小程序回到APP，或者支付成功回到APP都会触发回调事件来返回相应信息，请在触发相应方法前提前添加事件队列。
从小程序回到 APP，或者支付成功回到 APP 都会触发回调事件来返回相应信息，请在触发相应方法前提前添加事件队列。
``` ```
WeChat.registerApp(Global.APP_ID, Global.UNIVERSAL_LINK); WeChat.registerApp(Global.APP_ID, Global.UNIVERSAL_LINK);
DeviceEventEmitter.addListener('WeChat_Req', req => { DeviceEventEmitter.addListener('WeChat_Req', req => {