getui-rest v0.4.7

getui-rest-sdk

个推的nodejs sdk实在是太难用了……功能要啥啥没有，于是只好用rest-api重新封一遍

接口参数参考

http://docs.getui.com/server/rest/push/

Classes

Typedefs

Getui ⇐ EventEmitter

个推RestAPI SDK

Kind: global class
Extends: EventEmitter

• Getui ⇐ EventEmitter
  • new Getui(appId, appKey, masterSecret, [interval])
  • .waitAuth() ⇒ Promise
  • .auth() ⇒ Promise.<void>
  • .unauth() ⇒ Promise.<void>
  • .pushSingle(message, template, cid, [apnsInfo], [requestId]) ⇒ Promise.<object>
  • .pushSingleAlias(message, template, alias, [apnsInfo], [requestId]) ⇒ Promise.<object>
  • .saveListBody(message, template, [apnsInfo], [taskName]) ⇒ Promise
  • .toList(cidList, taskId, [needDetail]) ⇒ Promise
  • .toListAlias(aliasList, taskId, [needDetail]) ⇒ Promise
  • .pushApp(message, template, [apnsInfo], [condition], [requestId]) ⇒ Promise
  • .stopTask(taskId) ⇒ Promise
  • .pushSingleBatch(msgList) ⇒ Promise
  • .bindAlias(aliasList) ⇒ Promise
  • .queryCid(alias) ⇒ Promise
  • .queryAlias(cid) ⇒ Promise
  • .unbindAlias(cid, alias) ⇒ Promise
  • .unbindAliasAll(alias) ⇒ Promise
  • .setTags(cid, tagList) ⇒ Promise
  • .getTags(cid) ⇒ Promise
  • .userBlkListAdd(cid) ⇒ Promise
  • .userBlkListDelete(cid) ⇒ Promise
  • .userStatus(cid) ⇒ Promise
  • .pushResult(taskIdList) ⇒ Promise
  • .queryAppUser(date) ⇒ Promise
  • .queryAppPush(date) ⇒ Promise
  • .setBadge(badge, cids) ⇒ Promise
  • .getPushResultByGroupName(groupName) ⇒ Promise
  • .getLast24HoursOnlineUsreStatistics() ⇒ Promise
  • .queryUserCount(condition) ⇒ Promise
  • .queryBiTags() ⇒ Promise
  • .getFeedbackUsers(taskId, cids) ⇒ Promise
  • "ready"
  • "refresh-token"

new Getui(appId, appKey, masterSecret, interval)

初始化个推RestAPI

getui.waitAuth() ⇒ Promise

等待认证完成

Kind: instance method of Getui

getui.auth() ⇒ Promise.<void>

认证，token有效期24小时

Kind: instance method of Getui
Throws:

• Error auth failed

Emits: ready

getui.unauth() ⇒ Promise.<void>

关闭鉴权

Kind: instance method of Getui

getui.pushSingle(message, template, cid, apnsInfo, requestId) ⇒ Promise.<object>

单推

Kind: instance method of Getui
Returns: Promise.<object> - 接口返回的json

getui.pushSingleAlias(message, template, alias, apnsInfo, requestId) ⇒ Promise.<object>

单推给alias

Kind: instance method of Getui
Returns: Promise.<object> - 接口返回的json

getui.saveListBody(message, template, apnsInfo, taskName) ⇒ Promise

保存消息共同体

Kind: instance method of Getui

getui.toList(cidList, taskId, needDetail) ⇒ Promise

群推

Kind: instance method of Getui

getui.toListAlias(aliasList, taskId, needDetail) ⇒ Promise

群推alias

Kind: instance method of Getui

getui.pushApp(message, template, apnsInfo, condition, requestId) ⇒ Promise

toapp群推

Kind: instance method of Getui

getui.stopTask(taskId) ⇒ Promise

停止群推任务

Kind: instance method of Getui

getui.pushSingleBatch(msgList) ⇒ Promise

批量单推

Kind: instance method of Getui

getui.bindAlias(aliasList) ⇒ Promise

绑定别名

Kind: instance method of Getui

getui.queryCid(alias) ⇒ Promise

别名查询

Kind: instance method of Getui

getui.queryAlias(cid) ⇒ Promise

根据cid查询别名

Kind: instance method of Getui

getui.unbindAlias(cid, alias) ⇒ Promise

单个cid和别名解绑

Kind: instance method of Getui

getui.unbindAliasAll(alias) ⇒ Promise

解绑别名所有cid

Kind: instance method of Getui

getui.setTags(cid, tagList) ⇒ Promise

设置tag

Kind: instance method of Getui

getui.getTags(cid) ⇒ Promise

获取cid的tag

Kind: instance method of Getui

getui.userBlkListAdd(cid) ⇒ Promise

添加用户黑名单

Kind: instance method of Getui

getui.userBlkListDelete(cid) ⇒ Promise

删除用户黑名单

Kind: instance method of Getui

getui.userStatus(cid) ⇒ Promise

查询用户状态

Kind: instance method of Getui

getui.pushResult(taskIdList) ⇒ Promise

获取推送结果

Kind: instance method of Getui

getui.queryAppUser(date) ⇒ Promise

获取单日用户数据

Kind: instance method of Getui

getui.queryAppPush(date) ⇒ Promise

获取单日推送数据

Kind: instance method of Getui

getui.setBadge(badge, cids) ⇒ Promise

应用角标设置接口(仅iOS)

Kind: instance method of Getui

getui.getPushResultByGroupName(groupName) ⇒ Promise

根据任务组名获取推送结果

Kind: instance method of Getui

getui.getLast24HoursOnlineUsreStatistics() ⇒ Promise

获取24小时在线用户数

Kind: instance method of Getui

getui.queryUserCount(condition) ⇒ Promise

按条件查询用户数

Kind: instance method of Getui

getui.queryBiTags() ⇒ Promise

获取可用bi标签

Kind: instance method of Getui

getui.getFeedbackUsers(taskId, cids) ⇒ Promise

获取回执的用户列表

Kind: instance method of Getui

"ready"

认证完成，准备就绪

Kind: event emitted by Getui

"refresh-token"

重新获取了token

Kind: event emitted by Getui

Message : object

Kind: global typedef
Properties

Notification : object

Kind: global typedef
Properties

Condition : object

Kind: global typedef
Properties

APNsInfo : object

Kind: global typedef
Properties