2 Star 2 Fork 2

冷月轩 / cordova-plugin-xgpush

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

腾讯信鸽推送 for Cordova

安装方法

打开控制台,进入 Cordova 项目目录,输入:

  1. 创建一个cordova项目,并添加Android平台:
cordova create TestProject com.example.testproject TestProject
cd ./TestProject
cordova platform add android

或者使用已有项目

  1. 项目添加xml2js依赖
npm install xml2js
  1. 添加推送平台配置项,修改根目录当config.xml, 添加各个平台的id和key(小米的appID 和appKEY前需要加_前缀 ),如下:
  <platform name="android">
      <preference name="XG_ACCESS_ID" value="" />
      <preference name="XG_ACCESS_KEY" value="" />
      <preference name="XM_APP_ID" value="" />
      <preference name="XM_APP_KEY" value="" />
      <preference name="MZ_APP_ID" value="" />
      <preference name="MZ_APP_KEY" value="" />
      <preference name="HW_APP_ID" value="" />
  </platform>
  <platform name="ios">
      <edit-config file="*-Info.plist" mode="merge" target="XGPushMeta">
          <dict>
              <key>AccessID</key>
              <integer></integer>
          </dict>
           <dict>
              <key>AccessKey</key>
              <string></string>
          </dict>
      </edit-config>
  </platform>
  1. 添加插件:
cordova plugin add https://gitee.com/lengyuexuan/cordova-plugin-xgpush.git

iOS 特别处理

iOS需要在根目录的config.xml

iOS版本需要在xCode里面手动开启,[Push Notifications]和[Background Modes]。方法如下 http://xg.qq.com /docs/ios_access/ios_access_guide.html

示例

      document.addEventListener("deviceready", onDeviceReady, false);

      function onDeviceReady() {
            xgpush.registerPush('account',function(s){
                console.log(s)
            },function(e){
                console.log(e)
            })

            xgpush.on("register", function (data) {
                console.log("register:", data);
            });

            xgpush.on("click", function (data) {
                alert("click:" + JSON.stringify(data));
            });

            xgpush.getLaunchInfo(function (data) {
                alert("getLaunchInfo:" + JSON.stringify(data));
            }); 
      }

API

方法

方法 方法名 参数说明 成功回调 失败回调
registerPush(account,success,error) 绑定账号注册 account:绑定的账号,绑定后可以针对账号发送推送消息 {data:"设备的token"} {data:"",code:"",message:""} //android Only
unRegisterPush(account,success,error) 反注册 account:绑定的账号 {flag:0} {flag:0}
setTag(tagName) 设置标签 tagName:待设置的标签名称
deleteTag(tagName) 删除标签 tagName:待设置的标签名称
addLocalNotification(type,title,content,success,error) 添加本地通知 type:1通知,2消息 title:标题 content:内容
enableDebug(debugMode,success,error) 开启调试模式 debugMode:默认为false。如果要开启debug日志,设为true
getToken(callback) 获取设备Token 回调 设备的token
setAccessInfo(accessId,accessKey) 设置访问ID,KEY
getLaunchInfo(success) app启动自定义参数 返回的数据与click事件返回的一样
stopNotification() 终止信鸽推送服务以后,将无法通过信鸽推送服务向设备推送消息。再次启动app(即初始化插件)就会重新接收推送 iOS noly

调用例子

      xgpush.registerPush("account",function(event){},function(event){});

事件 Event

事件 事件名
register 注册账号事件
unRegister 反注册事件
message 接收到新消息时解法
click 通知被点击
show 通知成功显示
deleteTag 删除标签事件
setTag 设计标签事件
        xgpush.on("click",function(data){
          console.log(data);
          /**
           * {
           *   activity:"com.changan.test.push.MainActivity", //android Only
           * content:"这是内容",
           * customContent:"{"vvva":"789"}",
           * msgId:101217419,
           * notifactionId:0,   //android Only
           * notificationActionType:1, // android Only
           * title:"测试推送",
           * subtitle:"副标题", //iOS Only
           * type:"show"
           * }
        **/
        });
The MIT License (MIT) Copyright (c) 2016 sunlu Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

腾讯信鸽推送服务:http://xg.qq.com/  由于官方服务即将停止,此插件不再更新 展开 收起
Objective-C
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Objective-C
1
https://gitee.com/lengyuexuan/cordova-plugin-xgpush.git
git@gitee.com:lengyuexuan/cordova-plugin-xgpush.git
lengyuexuan
cordova-plugin-xgpush
cordova-plugin-xgpush
master

搜索帮助