推送模板

此SDK已停止维护，请开发者对接 RestApi V2

本章介绍了node.js的推送模板，推送模板结合推送方式即可完成整套推送方案。

1. 点击通知打开应用模板

1.1 描述

在通知栏显示一条含图标、标题等的通知，用户点击后激活您的应用。（激活后，打开应用的首页，如果只要求点击通知唤起应用，不要求到哪个指定页面就可以用此功能。）

1.2 应用场景

场景1：针对沉默用户，发送推送消息，点击消息栏的通知可直接激活启动应用，提升应用的转化率。

1.3 参数说明（NotificationTemplate）

1.4 代码实例

var NotificationTemplate = require('./getui/template/NotificationTemplate');
    var template = new NotificationTemplate({
        appId: APPID,
        appKey: APPKEY,
        title: '请填写通知标题',
        text: '请填写通知内容',
        logoUrl: 'http://wwww.igetui.com/logo.png',
        isRing: true,
        isVibrate: true,
        isClearable: false,
        transmissionType: 2,
        transmissionContent: '测试离线'
    });

2. 点击通知打开网页模板

2.1 描述

在通知栏显示一条含图标、标题等的通知，用户点击可打开您指定的网页。

2.2 应用场景

场景1：推送广促销活动，用户点击通知栏信息，直接打开到指定的促销活动页面，推送直接到达指定页面，免去了中间过程的用户流失。

2.3 接口参数（LinkTemplate）

2.4 代码实例

var LinkTemplate = require('./getui/template/LinkTemplate');
    var template = new LinkTemplate({
        appId: APPID,
        appKey: APPKEY,
        title: '请填写通知标题',
        text: '请填写通知内容',
        logoUrl: '请填写logo链接地址',
        isRing: true,
        isVibrate: true,
        isClearable: false,
        url: '请填写链接地址'
    });

3. 点击通知弹框下载模板

3.1 描述

消息以弹框的形式展现，点击弹框内容可启动下载任务。(iOS不使用该模板)

3.2 应用场景

场景1：应用有更新，点击推送的更新通知，弹出下载弹窗，点击可启动应用更新下载。

3.3 接口描述

3.4 代码实例

var NotyPopLoadTemplate = require('./getui/template/NotyPopLoadTemplate');
    var template = new NotyPopLoadTemplate({
        appId: APPID,
        appKey: APPKEY,
        notyTitle: '请填写通知标题',
        notyContent: '请填写通知内容',
        notyIcon: '请填写通知栏logo链接地址',    // 通知栏logo
        isRing: false,
        isVibrate: false,
        isClearable: true,
        popTitle: '弹框标题',
        setPopContent: '弹框内容',
        popImage: '',
        popButton1: '下载',                             // 左键
        popButton2: '取消',                             // 右键
        loadIcon: '请填写弹框图片链接地址', // 弹框图片
        loadUrl: '请填写下载链接地址',
        loadTitle: '请填写下载标题',
        autoInstall: false,
        actived: true
});
        //template.setDuration("2015-01-16 11:40:00", "2015-01-16 12:24:00");

4. 透传消息模板

4.1 描述

透传消息是指消息传递到客户端只有消息内容，展现形式由客户端自行定义。客户端可自定义通知的展现形式，也可自定义通知到达之后的动作，或者不做任何展现。

4.2 应用场景

场景1：自定义通知栏样式不想使用默认的通知栏样式，即可使用消息透传的形式，自定义通知栏展现形式，使发送的通知更醒目，更突出。

场景2：自定义通知到达之后的动作希望用户点击通知后启动应用直接到和通知相关的界面，免去中间跳转的流失。如用户预订更新的某本图书有更新，点击通知直接启动应用到对应图书的页面，免去用户打开应用后的查找，节省中间环节，提高转化。

场景3：仅传递信息，不做任何展示推送一串代码给应用，该代码仅此app可以解析。收到透传消息时，界面不作任何展示，用户无感知，应用收到命令后按代码执行操作。

4.3 接口参数

4.4 代码实例

var TransmissionTemplate = require('./getui/template/TransmissionTemplate');
    var template =  new TransmissionTemplate({
        appId: APPID,
        appKey: APPKEY,
        transmissionType: 1,
        transmissionContent: '请填写透传内容'
    });
    //iOS推送需要设置的setApnInfo字段
//    var payload = new APNPayload();
//    var alertMsg = new DictionaryAlertMsg();
//    alertMsg.body = "";
//    alertMsg.actionLocKey = "";
//    alertMsg.locKey = "";
//    alertMsg.locArgs = Array("");
//    alertMsg.launchImage = "";
//    //ios8.2以上版本支持
//    alertMsg.title = "Title";
//    alertMsg.titleLocKey = "TitleLocKey";
//    alertMsg.titleLocArgs = Array("TitleLocArg");
//
////    payload.alertMsg=alertMsg;
//    payload.badge=5;
////    payload.contentAvailable =1;
////    payload.category="";
////    payload.sound="";
////    payload.customMsg.payload1="payload";
//    template.setApnInfo(payload);
//    template.setDuration("2015-01-16 11:40:00", "2015-01-16 12:24:00");

4.4 iOS推送说明

iOS推送需要在代码中通过TransmissionTemplate的setAPNInfo接口设置相应的APNs通知参数。
透传模板传输的数据最大为是2KB，APNs传输数据最大支持2KB。

4.4.1 参数描述

setApnInfo具体参数含义详见苹果APNs文档：
https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html

4.4.2 参数说明

4.4.3 代码实例

function getTemplate() {}
    var template = new TransmissionTemplate();
    template.setAppId(APPID);
    template.setAppkey(APPKEY);
    template.setTransmissionContent("请填写透传内容");
    template.setTransmissionType(2);
    var payload = new APNPayload();
    payload.badge=5;
    payload.contentAvailable =1;
    payload.category="ACTIONABLE";
    payload.sound="test1.wav";
    payload.customMsg.payload1="payload";
     //简单模式使用
    var alertMsg = new SimpleAlertMsg();
    alertMsg.alertMsg="AlertMsg";
    payload.alertMsg = alertMsg;

    //字典模式使用下者
    //payload.alertMsg = getDictionaryAlertMsg();
    template.setApnInfo(payload);
    //template.setDuration("2015-01-16 11:40:00", "2015-01-16 12:24:00");
    return template;
}

function getDictionaryAlertMsg() {
    var alertMsg = new DictionaryAlertMsg();
    alertMsg.body = " 请填写body";
    alertMsg.actionLocKey = "ActionLockey";
    alertMsg.locKey = "LocKey";
    alertMsg.locArgs = "loc-args";
    alertMsg.launchImage = "launch-image";
    // iOS8.2以上版本支持
    alertMsg.title = "Title";
    alertMsg.titleLocKey = "TitleLocKey";
    alertMsg.titleLocArgs = "TitleLocArg";
    return alertMsg;
}