Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/OpenFlutter/fluwx
Flutter版微信SDK.WeChat SDK for flutter.
https://github.com/OpenFlutter/fluwx
flutter wechat wechatsdk wxsdk
Last synced: about 1 month ago
JSON representation
Flutter版微信SDK.WeChat SDK for flutter.
- Host: GitHub
- URL: https://github.com/OpenFlutter/fluwx
- Owner: OpenFlutter
- License: apache-2.0
- Created: 2018-08-10T07:08:03.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-16T13:27:29.000Z (about 2 months ago)
- Last Synced: 2024-10-18T08:41:58.425Z (about 2 months ago)
- Topics: flutter, wechat, wechatsdk, wxsdk
- Language: Dart
- Homepage:
- Size: 52.3 MB
- Stars: 3,095
- Watchers: 57
- Forks: 501
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starts - OpenFlutter/fluwx - Flutter版微信SDK.WeChat SDK for flutter. (Dart)
README
# Fluwx
[](https://pub.dartlang.org/packages/fluwx)
[](https://github.com/OpenFlutter/fluwx/stargazers)
[](https://github.com/OpenFlutter/fluwx/network)
[](https://github.com/OpenFlutter/fluwx/blob/master/LICENSE)
[](https://github.com/OpenFlutter/fluwx/issues)
---
[中文请移步此处](./README_CN.md)
## What's Fluwx
`Fluwx` is flutter plugin for [WeChatSDK](https://developers.weixin.qq.com/doc/oplatform/Mobile_App/Resource_Center_Homepage.html) which allows developers to call
[WeChatSDK](https://developers.weixin.qq.com/doc/oplatform/Mobile_App/Resource_Center_Homepage.html) native APIs.
> Join QQ Group now: 1003811176
## Capability
- Share images, texts, music and so on to WeChat, including session, favorite and timeline.
- Payment with WeChat.
- Get auth code before you login in with WeChat.
- Launch mini program in WeChat.
- Subscribe Message.
- Just open WeChat app.
- Launch app From wechat link.
## Preparation
[Migrate to V4 now](./doc/MIGRATE_TO_V4_CN.md)
> Breaking changes ：*Fluwx* won't request permission(WRITE_EXTERNAL_STORAGE) since 4.5.0. That means you will need to handle permission when sharing images, if FileProvider is not supported.
`Fluwx` is good but not God. You'd better read [official documents](https://developers.weixin.qq.com/doc/oplatform/Mobile_App/Resource_Center_Homepage.html) before
integrating `Fluwx`. Then you'll understand how to generate Android signature, what's universal link for iOS, how to add URL schema for iOS and so on.
## Install
Add the following dependencies in your `pubspec.yaml` file:
`Fluwx` with pay:
```yaml
dependencies:
fluwx: ^${latestVersion}
```
`Fluwx` without pay:
> Developers who need to exclude payment for iOS can enable `no_pay` in [pubspec.yaml](./example/pubspec.yaml#L86).
> NOTE: Never forget to replace ^${latestVersion} with actual version.
## Configurations
`Fluwx` enables multiple configurations in the section `fluwx` of `pubspec.yaml` from v4, you can reference [pubspec.yaml](./example/pubspec.yaml#L10)
for more details.
> For iOS, some configurations, such as url_scheme，universal_link, LSApplicationQueriesSchemes, can be configured by `fluwx`,
> what you need to do is to fill configurations in `pubspec.yaml`
- app_id. Recommend. It'll be used to generate scheme on iOS。This is not used to init WeChat SDK so you still need to call `fluwx.registerApi` manually.
- debug_logging. Optional. Enable logs by setting it `true`.
- flutter_activity. Optional. This is usually used by cold boot from WeChat on Android. `Fluwx` will try to launch launcher activity if not set.
- universal_link. Recommend for iOS. It'll be used to generate universal link on your projects.
- scene_delegate. Optional. Use `AppDelegate` or `SceneDelegate`. See [official documents](https://developers.weixin.qq.com/doc/oplatform/Mobile_App/Access_Guide/iOS.html) for more details.
- For iOS
If you are failing `cannot load such file -- plist` on iOS, please do the following steps:
```shell
# step.1 install missing dependencies
sudo gem install plist
# step.2 enter iOS folder(example/ios/,ios/)
cd example/ios/
# step.3 execute
pod install
```
- On OpenHarmony, to check if WeChat is installed, add the following to the module.json5 in your project
```json5
{
"module": {
"querySchemes": [
"weixin"
],
}
}
```
## Register WxAPI
Register your app via `fluwx` if necessary.
```dart
Fluwx fluwx = Fluwx();
fluwx.registerApi(appId: "wxd930ea5d5a228f5f",universalLink: "https://your.univerallink.com/link/");
```
The param `universalLink` only works with iOS. You can read [this document](https://developers.weixin.qq.com/doc/oplatform/Mobile_App/Access_Guide/iOS.html) to learn
how to create universalLink. You can also learn how to add URL schema, how to add `LSApplicationQueriesSchemes` in your iOS project. This is essential.
For Android, you shall know to how generate signature for your app in [this page](https://developers.weixin.qq.com/doc/oplatform/Downloads/Android_Resource.html).
And you have to understand the difference between debug signature and release signature. Once the signature is incorrect, then you'll get `errCode = -1`.
It' better to register your API as early as possible.
## Capability Document
- [Basic knowledge](./doc/BASIC_KNOWLEDGE.md)
- [Share](./doc/SHARE.md)
- [Payment](./doc/PAYMENT.md)
- [Auth](./doc/AUTH.md)
- [Launch app from h5](./doc/LAUNCH_APP_FROM_H5.md)
For more capabilities, you can read the public functions of `fluwx`.
## QA
[These questions maybe help](./doc/QA_CN.md)
## Donate
Buy the writer a cup of coffee。
## Subscribe Us On WeChat
## Star history
## LICENSE
Copyright 2023 OpenFlutter Project
Licensed to the Apache Software Foundation (ASF) under one or more contributor
license agreements. See the NOTICE file distributed with this work for
additional information regarding copyright ownership. The ASF licenses this
file to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.