# cordova-plugin-cnpush

> Cordova Push Plugin

Latest version **1.2.0** (published 2020-11-12) · Apache License license · 0 weekly downloads

## Install

```sh
npm install cordova-plugin-cnpush
pnpm add cordova-plugin-cnpush
yarn add cordova-plugin-cnpush
bun add cordova-plugin-cnpush
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2020-11-12 |
| First published | 2019-06-11 |
| Weekly downloads | 0 |
| License | Apache License |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | waitaction |
| Maintainers | waitaction |
| Keywords | cordova, cordova-android, device, push, ecosystem:cordova |

## Links

- npm: https://www.npmjs.com/package/cordova-plugin-cnpush
- Repository: https://github.com/waitaction/cordova-plugin-cnpush
- Homepage: https://github.com/waitaction/cordova-plugin-cnpush#readme
- Issues: https://github.com/waitaction/cordova-plugin-cnpush/issues
- npm.io page: https://npm.io/package/cordova-plugin-cnpush

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.2.0 (latest) — 2020-11-12
- 1.1.0 — 2020-11-11
- 1.0.0 — 2020-09-04
- 2.6.7 — 2019-09-14
- 2.6.6 — 2019-07-17
- 2.6.5 — 2019-07-08
- 2.6.4 — 2019-07-02
- 2.6.3 — 2019-06-16
- 2.6.2 — 2019-06-11
- 2.6.1 — 2019-06-11

## README

# 统一推送

安装 `cordova-plugin-cnpush`
 
``` shell
 cordova plugin add cordova-plugin-cnpush
```

> cordova应用统一推送，可以安装下列插件，`cordova-plugin-cnpush`会根据手机型号优先使用`厂商sdk`的cordova插件

## 安卓手机推送(非厂商sdk)

其它安卓手机使用推送，安装 `极光推送安卓版本(免费版)` 插件

``` shell
cordova plugin add cordova-plugin-android-jpush --variable APP_KEY=your_jpush_appkey
```

## 华为推送(厂商sdk)

如需在`华为手机`使用系统级推送，请安装 `华为推送` 插件

``` shell
cordova plugin add cordova-plugin-huawei-push
```

## OPPO推送(厂商sdk)

如需在`OPPO手机`使用系统级推送，请安装 `OPPO推送` 插件

``` shell
cordova plugin add cordova-plugin-oppo-push --variable  APP_KEY=YOUR_APP_KEY --variable APP_SECRET=YOUR_APP_SECRET
```


> 各依赖插件的配置，请参考插件官方文档

## 使用

使用前需注册，以获取 `token` ，你可以将 `token` 与你的app用户信息关联后上传到服务器

``` js
// 注册推送
cnPush.register(function(token) {
    console.log(token);
}, function(err) {
    console.log(err);
}, []);

// 接收token
cnPush.onNewToken(function(token) {
    console.log(token); // 会多次接收到token
});
```

注册完成后，需要监听 `messageReceived` 事件

``` js
document.addEventListener("messageReceived", function(result) {
    console.log(result);
}, false);
```

---
_Source: https://npm.io/package/cordova-plugin-cnpush · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
