# getui2

> Node wrapper for getui OS SDK API

Latest version **0.1.10** (published 2019-02-19) · 0 weekly downloads

## Install

```sh
npm install getui2
pnpm add getui2
yarn add getui2
bun add getui2
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.10 |
| Published | 2019-02-19 |
| First published | 2017-07-10 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 136.2 KB |
| Known vulnerabilities | 0 (+13 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 6 |
| Author | getui.com |
| Maintainers | qianzhang |
| Keywords | getui, sdk, push, os, android |

## Links

- npm: https://www.npmjs.com/package/getui2
- Repository: https://github.com/TIME-GATE/getui2
- Homepage: https://github.com/TIME-GATE/getui2#readme
- Issues: https://github.com/TIME-GATE/getui2/issues
- npm.io page: https://npm.io/package/getui2

## Dependencies (4)

- [util](https://npm.io/package/util.md) ^0.10.3
- [crypto](https://npm.io/package/crypto.md) 0.0.3
- [request](https://npm.io/package/request.md) ^2.51.0
- [protobufjs](https://npm.io/package/protobufjs.md) ^3.8.2

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [@temporal-architect/claude-plugin](https://npm.io/package/@temporal-architect/claude-plugin.md) — 335 weekly downloads

## Recent versions

- 0.1.10 (latest) — 2019-02-19
- 0.1.9 — 2019-02-19
- 0.1.8 — 2018-06-26
- 1.0.1 — 2018-06-21
- 0.1.7 — 2017-07-20
- 0.1.6 — 2017-07-20
- 0.1.5 — 2017-07-19
- 0.1.4 — 2017-07-19
- 0.1.3 — 2017-07-19
- 0.1.2 — 2017-07-19
- 0.1.1 — 2017-07-19
- 0.0.2 — 2017-07-10
- 0.0.1 — 2017-07-10

## README

## Installation

`npm install getui2 --save`

## Tests

`npm test`

## Examples :

```js

/**
 * 个推配置
 * config {Obj}: 
 *  HOST：必选
 *  APPID: 必选 
 *  APPKEY: 必选 
 *  MASTERSECRET: 必选 
 */
const getui = require('getui2').GeTuiDecorator({
  HOST: 'http://sdk.open.api.igexin.com/apiex.htm',
  APPID: '',
  APPKEY: '',
  MASTERSECRET: '',
})

/**
 * 个推调用 返回promise对象,
 * message {Obj}: 
 *  title：必选 推送标题
 *  text: 必选 推送正文,
 *  url: 必选 跳转, 
 *  uidList: 可选 分组推送时用户uid
 */
const message = {
  title: '推送标题',
  text: '推送正文',
  url: `http://www.baidu.com`,
  uidList: ['777'],
}

/**
 * 透传消息 推送所有用户
 **/
getui.pushMessage(message, 'transmission', 'pushMessageToApp') 

/**
 * 跳转链接 推送给所有用户
 **/
getui.pushMessage(message, 'link', 'pushMessageToApp')

/**
 * 通知消息 推送给所有用户
 **/
getui.pushMessage(message, 'notification', 'pushMessageToApp')

/**
 * 透传消息 推送给分组用户 需要设置别名
 **/
getui.pushMessage(message, 'transmission', 'pushMessageToList')

/**
 * 通知消息 推送给分组用户 需要设置别名
 **/
getui.pushMessage(message, 'notification', 'pushMessageToList')
```

## Contributors

  - [qian.zhang](https://github.com/TIME-GATE)

## MIT Licenced

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