diff --git a/README.md b/README.md new file mode 100644 index 0000000..96d225b --- /dev/null +++ b/README.md @@ -0,0 +1,76 @@ +*** + +title: Tpns + +description: 腾讯移动推送插件 + +*** + +# cordova-plugin-tpns + +腾讯移动推送插件 + +## Installation + +```bash + cordova plugin add cordova-plugin-tpns --variable XG_ACCESS_ID=${XG_ACCESS_ID} --variable XG_ACCESS_KEY=${XG_ACCESS_KEY} +``` + +## Supported Platforms + +* Android + +> 当前版本仅支持**魅族**和**小米**的厂商通道 + +## Get Started + +### Usage + +##### 1.注册推送服务 + +```javascript +/** + * 注册消息推送 + * @param {*} other 厂商通道? 为空时不开启 格式如下: + * { + * "MZ":{"APP_ID":魅族APP_ID,"APP_KEY":魅族APP_KEY}, + * "OPPO":{"appKey":OPPO appKey,"appSecret": OPPO appSecret}, + * "MI":{"APPID":小米APPID,"APPKEY":小米APPKEY}, + * "HW":{},"RY":{} + * } + * @param {*} successCallback + * @param {*} errorCallback + */ +Tpns.registerPush(null,function(token){ + //TODO 获取到TPNS的token之后的操作 +},console.error); +``` + +##### 2. 绑定账号信息 + +```javascript +/** + * 添加或更新账号。若原来没有该类型账号,则添加;若原来有,则覆盖。可以同时添加多个账号,一个账号对应一个账号类型。 + * @param {*} params 账户数组[{"account":elva, "accountType":1001}, {"account":jay, "accountType":1002}] + * @param {*} successCallback + * @param {*} errorCallback + */ +Tpns.upsertAccounts([{ +"account":elva, "accountType":1001 +}],console.log,console.error); +``` + +##### 3. 绑定标签 + +```javascript +/** + * 覆盖多个标签 一次设置多个标签,会覆盖这个设备之前设置的标签。 + * @param {*} operateName 操作名称 全局唯一,类似于全局序列 + * @param {*} tags 标签数组["tag1","tag2"] + * @param {*} successCallback + * @param {*} errorCallback + */ +Tpns.clearAndAppendTags(new nanoId(),['tag1','tag2'],console.log,console.error); +``` + +##### 5.其他方法参考js注释