提交 eea69923 authored 作者: nelson1110's avatar nelson1110

update docs

上级 766a4aca
......@@ -4,8 +4,8 @@
## 使用需知
使用```Fluwx```之前,强烈建议先阅读[微信SDK官方文档](https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&t=resource/res_list&verify=1)
这有助于你使用```Fluwx```
使用`Fluwx`之前,强烈建议先阅读[微信SDK官方文档](https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&t=resource/res_list&verify=1)
这有助于你使用`Fluwx`
### 目前功能
* 文本分享。
......@@ -17,7 +17,7 @@
* 发送Auth认证。
## 技术参数
Android部分使用到了```kotlin-1.2.60```。以下是Android部分所涉及到的技术:
Android部分使用到了`kotlin-1.2.60`。以下是Android部分所涉及到的技术:
```gradle
implementation 'com.tencent.mm.opensdk:wechat-sdk-android-with-mta:5.1.4'
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:0.24.0'
......@@ -30,7 +30,7 @@
s.dependency 'WechatOpenSDK','~> 1.8.2'
```
## 引入
在```pubspec.yaml```文件中添加如下代码:
在`pubspec.yaml`文件中添加如下代码:
```yaml
dependencies:
fluwx: ^0.0.3
......@@ -38,16 +38,16 @@ dependencies:
## 初始化
使用```Fluwx```前,需要进行初始化操作:
使用`Fluwx`前,需要进行初始化操作:
```dart
Fluwx.registerApp(RegisterModel(appId: "your app id", doOnAndroid: true, doOnIOS: true));
```
- ```appId```:在微信平台申请的appId。
- ```doOnAndroid```:是否在android平台上执行此操作。
- ```doOnIOS```:是否在平台上执行此操作。</br>
每一个字段都是非必须的,但是如果不传```appId```或```doOnAndroid: false```或者```doOnIOS: false```,在使用前请务必手动注册```WXApi```,以保证
```Fluwx```正常工作。
注册完成后,请在使用```Fluwx```前在对应平台添加如下代码:
- `appId`:在微信平台申请的appId。
- `doOnAndroid`:是否在android平台上执行此操作。
- `doOnIOS`:是否在平台上执行此操作。</br>
每一个字段都是非必须的,但是如果不传`appId`或`doOnAndroid: false`或者`doOnIOS: false`,在使用前请务必手动注册`WXApi`,以保证
`Fluwx`正常工作。
注册完成后,请在使用`Fluwx`前在对应平台添加如下代码:
Android上:
```kotlin
FluwxShareHandler.setWXApi(wxapi)
......
......@@ -8,7 +8,7 @@
FluwxResponseHandler.handleResponse(resp)
}
```
你也可以直接继承```FluwxWXEntryActivity```
你也可以直接继承`FluwxWXEntryActivity`
### iOS
在你的`AppDelegate`中重写下面方法:
......
## 发送Auth验证
```Fluwx```目前只支持获取```code```,若要获取```access_token```请在服务器端完成。
`Fluwx`目前只支持获取`code`,若要获取`access_token`请在服务器端完成。
```dart
fluwx.sendAuth(WeChatSendAuthModel(
scope: "snsapi_userinfo",
......
### 简述
目前```Fluwx```并不是支持所有的分享类型,目前仅支持文本分享、图片分享、网址分享
目前`Fluwx`并不是支持所有的分享类型,目前仅支持文本分享、图片分享、网址分享
音乐、视频以及小程序的分享。未来会考虑增加更多支持。
> 注意:目前分享中涉及到图片的地方仅支持```png```和```jpg```,支持网络图片及```assets```图片。<br>
> 使用```assets```图片需要添加```assets://```。<br>
> 也可以在```assets```图片添加```?package=package_name```以读取指定包的图片。<br>
> 未来可能支持```file://```,目前以```file://```图片不会做任何处理。<br>
> 注意:目前分享中涉及到图片的地方仅支持`png`和`jpg`,支持网络图片及`assets`图片。<br>
> 使用`assets`图片需要添加`assets://`。<br>
> 也可以在`assets`图片添加`?package=package_name`以读取指定包的图片。<br>
> 未来可能支持`file://`,目前以`file://`图片不会做任何处理。<br>
> 如果不指定schema或者schema错误,将会被处理为网络图片,请谨慎。<br>
> 由于微信的限制,一般的缩略图要小于32k(小程序的缩略图要小于120k),所以在使用缩略的时候<br>
> 很有必要使用一张合格的缩略图,否则```Fluwx```进行压缩,其结果可能并不是你所预期的。
> 很有必要使用一张合格的缩略图,否则`Fluwx`进行压缩,其结果可能并不是你所预期的。
### 分享去处
绝大部分分享可以分享到会话,朋友圈,收藏(小程序目前只能分享到会话)。默认分享到会话。
......@@ -25,7 +25,7 @@
}
```
### 返回值处理
```fluwx.share(model)```返回的是一个```Map```:
`fluwx.share(model)`返回的是一个`Map`
```dart
{
"platform":"Android",//或者iOS
......@@ -50,7 +50,7 @@
scene: scene,
description: "image"));
```
> 注意:如果`不指定 ```thumbnail```,那么```Fluwx```将尝试从```image```中获取缩略图。
> 注意:如果`不指定 `thumbnail`,那么`Fluwx`将尝试从`image`中获取缩略图。
### 分享音乐
```dart
......@@ -64,8 +64,8 @@
fluwx.share(model);
```
音乐的分享有两种:```musicUrl``````musicLowBandUrl```。这两种形式是不共存的,如果
都二者都进行了赋值,那么只会读取```musicUrl```
音乐的分享有两种:`musicUrl``musicLowBandUrl`。这两种形式是不共存的,如果
都二者都进行了赋值,那么只会读取`musicUrl`
### 分享视频
```dart
var model = new WeChatShareVideoModel(
......@@ -78,5 +78,5 @@
);
fluwx.share(model);
```
视频的分享有两种:```videoUrl``````videoLowBandUrl```。这两种形式是不共存的,如果
都二者都进行了赋值,那么只会读取```videoUrl```
\ No newline at end of file
视频的分享有两种:`videoUrl``videoLowBandUrl`。这两种形式是不共存的,如果
都二者都进行了赋值,那么只会读取`videoUrl`
\ No newline at end of file
......@@ -19,7 +19,7 @@ fluwx.pay(WeChatPayModel(
### 返回值处理
注:此返回值是此方法调用的直接返回值,并非支付之后的回调,回调请查看[相关文档](docs/RESPONSE.md)
```fluwx.pay(model)```返回的是一个```Map```:
`fluwx.pay(model)`返回的是一个`Map`
```dart
{
"platform":"Android",//或者iOS
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论