# push-flutter-plugin

**Repository Path**: loverain1997/push-flutter-plugin

## Basic Information

- **Project Name**: push-flutter-plugin
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-05
- **Last Updated**: 2023-12-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# flutter_plugin_engagelab

### 安装

在工程 pubspec.yaml 中加入 dependencies

```
  
//github  集成
dependencies:
  flutter_plugin_engagelab:
    git:
      url: git://github.com/DevEngageLab/push-flutter-plugin.git
      ref: main
      
// pub 集成
dependencies:
  flutter_plugin_engagelab: 1.1.0
```

### 配置

##### Android:

在 `/android/app/build.gradle` 中添加下列代码：

```groovy
android: {
  ....
  defaultConfig {
    applicationId "替换成自己应用 ID"
    ....
    manifestPlaceholders = [
                ENGAGELAB_PRIVATES_APPKEY : "你的appkey",
                ENGAGELAB_PRIVATES_CHANNEL: "developer",
                ENGAGELAB_PRIVATES_PROCESS: ":remote",
                XIAOMI_GLOBAL_APPID            : "",//小米厂商，有就填MI-自己的，没有就不用填，保留为""
                XIAOMI_GLOBAL_APPKEY           : "",//小米厂商，有就填MI-自己的，没有就不用填，保留为""
                MEIZU_APPID            : "",//魅族厂商，有就填MZ-自己的，没有就不用填，保留为""
                MEIZU_APPKEY           : "",//魅族厂商，有就填MZ-自己的，没有就不用填，保留为""
                OPPO_APPID             : "",//OPPO厂商，有就填OP-自己的，没有就不用填，保留为""
                OPPO_APPKEY            : "",//OPPO厂商，有就填OP-自己的，没有就不用填，保留为""
                OPPO_APPSECRET         : "",//OPPO厂商，有就填OP-自己的，没有就不用填，保留为""
                VIVO_APPID             : "",//VIVO厂商，有就填自己的，没有就不用填，保留为""
                VIVO_APPKEY            : "",//VIVO厂商，有就填自己的，没有就不用填，保留为""
                HONOR_APPID            : "",//荣耀厂商，有就填自己的，没有就不用填，保留为""
                APP_TCP_SSL            : "",//android tcp连接是否加密，填true为加密，其他为不加密，可保留为""，这个数据要生效需在AndroidManifest.xml中的application添加android:name="com.engagelab.privates.flutter_plugin_engagelab.MTApplication"，或继承该对象
                APP_DEBUG            : ""//android log debug模式，填true为debug模式，其他为非debug模式，可保留为""，这个数据要生效需在AndroidManifest.xml中的application添加android:name="com.engagelab.privates.flutter_plugin_engagelab.MTApplication"，或继承该对象
        ]
  }    
}
```

##### iOS:

- 在 xcode8 之后需要点开推送选项： TARGETS -> Capabilities -> Push Notification 设为 on 状态

### 使用

```dart
import 'package:flutter_plugin_engagelab/flutter_plugin_engagelab.dart';
```

### APIs

**注意** : 需要先调用 FlutterPluginEngagelab.init 来初始化插件，才能保证其他功能正常工作。

 [参考](./documents/APIs.md)