jpush_flutter/README.md

62 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2025-02-20 19:07:11 +08:00
[![QQ Group](https://img.shields.io/badge/QQ%20Group-862401307-red.svg)]()
# JPush Flutter Plugin
2025-02-20 10:57:43 +00:00
2025-02-20 19:07:11 +08:00
### 安装
2025-02-20 10:57:43 +00:00
2025-02-20 19:07:11 +08:00
在工程 pubspec.yaml 中加入 dependencies
2025-02-20 10:57:43 +00:00
```
2025-02-20 19:07:11 +08:00
//github 集成
dependencies:
jpush_flutter:
git:
2025-02-20 19:10:17 +08:00
url: git@code-internal.star-lock.cn:StarlockTeam/jpush_flutter_sdk.git
ref: main
2025-02-20 19:07:11 +08:00
// pub 集成
dependencies:
2025-02-20 19:10:17 +08:00
jpush_flutter_sdk: 2.5.8
2025-02-20 10:57:43 +00:00
```
2025-02-20 19:07:11 +08:00
### 配置
##### Android:
`/android/app/build.gradle` 中添加下列代码:
```groovy
android: {
....
defaultConfig {
applicationId "替换成自己应用 ID"
...
ndk {
//选择要添加的对应 cpu 类型的 .so 库。
abiFilters 'armeabi', 'armeabi-v7a', 'x86', 'x86_64', 'mips', 'mips64', 'arm64-v8a',
}
manifestPlaceholders = [
JPUSH_PKGNAME : applicationId,
JPUSH_APPKEY : "appkey", // NOTE: JPush 上注册的包名对应的 Appkey.
JPUSH_CHANNEL : "developer-default", //暂时填写默认值即可.
]
}
```
##### iOS:
2025-02-20 10:57:43 +00:00
2025-02-20 19:07:11 +08:00
- 在 xcode8 之后需要点开推送选项: TARGETS -> Capabilities -> Push Notification 设为 on 状态
2025-02-20 10:57:43 +00:00
2025-02-20 19:07:11 +08:00
### 使用
2025-02-20 10:57:43 +00:00
2025-02-20 19:07:11 +08:00
```dart
2025-02-20 19:10:17 +08:00
import 'package:jpush_flutter_sdk/jpush_flutter.dart';
2025-02-20 19:07:11 +08:00
```
2025-02-20 10:57:43 +00:00
2025-02-20 19:07:11 +08:00
### APIs
2025-02-20 10:57:43 +00:00
2025-02-20 19:07:11 +08:00
**注意** : 需要先调用 JPush.setup 来初始化插件,才能保证其他功能正常工作。
2025-02-20 10:57:43 +00:00
2025-02-20 19:07:11 +08:00
[参考](./documents/APIs.md)
2025-02-20 10:57:43 +00:00