docs: improve
This commit is contained in:
Tom Xu
parent
0646908238
commit
1a4cd68c5d
148
README.md
148
README.md
@ -93,7 +93,7 @@ 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,32 +102,29 @@ 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) 分享图片
|
||||||
@ -135,26 +132,24 @@ WeChat.shareText({
|
|||||||
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) 分享本地图片
|
||||||
@ -162,35 +157,50 @@ WeChat.shareImage({
|
|||||||
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 |
|
||||||
@ -203,11 +213,10 @@ ShareMusicMetadata
|
|||||||
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,9 +224,8 @@ 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) 分享视频
|
||||||
@ -225,7 +233,7 @@ WeChat.shareMusic({
|
|||||||
ShareVideoMetadata
|
ShareVideoMetadata
|
||||||
|
|
||||||
| name | type | description |
|
| name | type | description |
|
||||||
|---------|--------|-------------------------------------|
|
| --------------- | ------ | --------------------------------- |
|
||||||
| title | String | 标题 |
|
| title | String | 标题 |
|
||||||
| description | String | 描述 |
|
| description | String | 描述 |
|
||||||
| thumbImageUrl | String | 缩略图地址，本库会自动压缩到 32KB |
|
| thumbImageUrl | String | 缩略图地址，本库会自动压缩到 32KB |
|
||||||
@ -236,11 +244,10 @@ ShareVideoMetadata
|
|||||||
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,9 +255,8 @@ 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) 分享网页
|
||||||
@ -258,7 +264,7 @@ WeChat.shareVideo({
|
|||||||
ShareWebpageMetadata
|
ShareWebpageMetadata
|
||||||
|
|
||||||
| name | type | description |
|
| name | type | description |
|
||||||
|---------|--------|-------------------------------------|
|
| ------------- | ------ | --------------------------------- |
|
||||||
| title | String | 标题 |
|
| title | String | 标题 |
|
||||||
| description | String | 描述 |
|
| description | String | 描述 |
|
||||||
| thumbImageUrl | String | 缩略图地址，本库会自动压缩到 32KB |
|
| thumbImageUrl | String | 缩略图地址，本库会自动压缩到 32KB |
|
||||||
@ -268,11 +274,10 @@ ShareWebpageMetadata
|
|||||||
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,9 +285,8 @@ 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) 分享小程序
|
||||||
@ -290,7 +294,7 @@ WeChat.shareWebpage({
|
|||||||
ShareMiniProgram
|
ShareMiniProgram
|
||||||
|
|
||||||
| name | type | description |
|
| name | type | description |
|
||||||
|---------|--------|-------------------------------------|
|
| --------------- | ------ | ---------------------------------------------------------------------------------- |
|
||||||
| title | String | 标题 |
|
| title | String | 标题 |
|
||||||
| description | String | 描述 |
|
| description | String | 描述 |
|
||||||
| thumbImageUrl | String | 缩略图地址，本库会自动压缩到 32KB |
|
| thumbImageUrl | String | 缩略图地址，本库会自动压缩到 32KB |
|
||||||
@ -305,11 +309,10 @@ ShareMiniProgram
|
|||||||
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,9 +321,8 @@ 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) 跳到小程序
|
||||||
@ -328,7 +330,7 @@ WeChat.shareMiniProgram({
|
|||||||
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" |
|
||||||
@ -336,19 +338,56 @@ LaunchMiniProgramMetadata
|
|||||||
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) 支付
|
||||||
@ -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 => {
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user