C# 推送模板

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

本章介绍了C# API的推送模板实例，推送模板结合推送方式即可完成整套推送方案。

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

1.1 模板说明

1.2 模板参数说明

1.3 NotificationTemplate代码实例

public static NotificationTemplate NotificationTemplateDemo()
{
    NotificationTemplate template = new NotificationTemplate();
    template.AppId = APPID;
    template.AppKey = APPKEY;
     //通知栏标题
    template.Title = "请填写通知标题";    
    //通知栏内容    
    template.Text = "请填写通知内容"; 
    //通知栏显示本地图片 
    template.Logo = "";               
    //通知栏显示网络图标
    template.LogoURL = "";            
    //应用启动类型，1：强制应用启动  2：等待应用启动 
    template.TransmissionType = 1;          
    //透传内容
    template.TransmissionContent = "请填写透传内容";   
    //接收到消息是否响铃，true：响铃 false：不响铃
    template.IsRing = true;                
    //接收到消息是否震动，true：震动 false：不震动
    template.IsVibrate = true;               
    //接收到消息是否可清除，true：可清除 false：不可清除
    template.IsClearable = true; 
    //设置客户端展示时间
    //String begin = "2015-03-06 14:36:10";
    //String end = "2015-03-06 14:46:20";
    //template.setDuration(begin, end);            
    return template;
}

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

2.1 模板说明

2.2 模板参数说明

2.3 LinkTemplate代码实例

public static LinkTemplate LinkTemplateDemo()
{
    LinkTemplate template =new LinkTemplate();
    template.AppId = APPID;
    template.AppKey = APPKEY;
    //通知栏标题
    template.Title = "请填写通知标题";       
    //通知栏内容 
    template.Text = "请填写通知内容";       
    //通知栏显示本地图片 
    template.Logo = "";               
    //通知栏显示网络图标，如无法读取，则显示本地默认图标，可为空
    template.LogoURL = "";  
    //打开的链接地址    
    template.Url="http://www.baidu.com";      
    //接收到消息是否响铃，true：响铃 false：不响铃   
    template.IsRing = true;
    //接收到消息是否震动，true：震动 false：不震动   
    template.IsVibrate = true;              
    //接收到消息是否可清除，true：可清除 false：不可清除
    template.IsClearable = true;             
    return template;
}

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

3.1 模板说明

3.2 模板参数说明

3.3 NotyPopLoadTemplate代码实例

public static NotyPopLoadTemplate NotyPopLoadTemplateDemo()
{
    NotyPopLoadTemplate template = new NotyPopLoadTemplate();
    template.AppId = APPID;
    template.AppKey = APPKEY;
    //通知栏标题
    template.NotyTitle = "请填写通知标题";     
    //通知栏内容
    template.NotyContent = "请填写通知内容";   
    //通知栏显示本地图片
    template.NotyIcon = "icon.png";           
    //通知栏显示网络图标
    template.LogoURL = "";                    
    //弹框显示标题
    template.PopTitle = "弹框标题";    
    //弹框显示内容    
    template.PopContent = "弹框内容";   
    //弹框显示图片    
    template.PopImage = "";        
    //弹框左边按钮显示文本    
    template.PopButton1 = "下载";     
    //弹框右边按钮显示文本    
    template.PopButton2 = "取消";               
    //通知栏显示下载标题
    template.LoadTitle = "下载标题";           
    //通知栏显示下载图标,可为空 
    template.LoadIcon = "file://push.png";      
    //下载地址，不可为空
    template.LoadUrl = "http://www.appchina.com/market/d/425201/cop.baidu_0/com.gexin.im.apk";
    //应用安装完成后，是否自动启动
    template.IsActived = true;  
    //下载应用完成后，是否弹出安装界面，true：弹出安装界面，false：手动点击弹出安装界面 
    template.IsAutoInstall = true;              
    //接收到消息是否响铃，true：响铃 false：不响铃
    template.IsBelled = true;            
    //接收到消息是否震动，true：震动 false：不震动   
    template.IsVibrationed = true;              
    //接收到消息是否可清除，true：可清除 false：不可清除    
    template.IsCleared = true;            
    return template;
}

4. 透传消息模板

4.1 模板说明

4.2 模板参数说明

4.3 TransmissionTemplate代码实例

public  static TransmissionTemplate TransmissionTemplateDemo()
{
    TransmissionTemplate template = new TransmissionTemplate();
    template.AppId = APPID;
    template.AppKey = APPKEY;
     //应用启动类型，1：强制应用启动 2：等待应用启动
    template.TransmissionType = 1;          
    //透传内容  
    template.TransmissionContent = "透传内容";  

    return template;
}

4.4 iOS推送说明

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

4.4.1 对应接口

setAPNInfo(payload)；

4.4.2 参数描述

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

4.4.3 参数说明：

4.4.4 代码示例

public  static TransmissionTemplate TransmissionTemplateDemo()
{
    TransmissionTemplate template = new TransmissionTemplate();
    template.AppId = APPID;
    template.AppKey = APPKEY;
    template.TransmissionType = 1;            //应用启动类型，1：强制应用启动 2：等待应用启动
    template.TransmissionContent = "";  //透传内容

    //iOS简单推送
    //APNPayload apnpayload = new APNPayload();
    //SimpleAlertMsg alertMsg = new SimpleAlertMsg("alertMsg");
    //apnpayload.AlertMsg = alertMsg;
    //apnpayload.Badge = 11;
    //apnpayload.ContentAvailable = 1;
    //apnpayload.Category = "";
    //apnpayload.Sound = "";
    //apnpayload.addCustomMsg("", "");
    //template.setAPNInfo(apnpayload);

    //APN高级推送
    APNPayload apnpayload = new APNPayload();
    DictionaryAlertMsg alertMsg = new DictionaryAlertMsg();
    alertMsg.Body = "Body";
    alertMsg.ActionLocKey = "ActionLocKey";
    alertMsg.LocKey = "LocKey";
    alertMsg.addLocArg("LocArg");
    alertMsg.LaunchImage = "LaunchImage";
    //iOS8.2支持字段
    alertMsg.Title = "Title";
    alertMsg.TitleLocKey = "TitleLocKey";
    alertMsg.addTitleLocArg("TitleLocArg");

    apnpayload.AlertMsg = alertMsg;
    apnpayload.Badge = 10;
    apnpayload.ContentAvailable = 1;
    //apnpayload.Category = "";
    apnpayload.Sound = "test1.wav";
    apnpayload.addCustomMsg("payload", "payload");
    //多媒体
    MultiMedia multiMedia = new MultiMedia();
    multiMedia.rid="xxx-1";
    multiMedia.url = "";
    multiMedia.setIsOnlyWifi(false);
    multiMedia.type = MultiMedia.MediaType.pic;

    List<MultiMedia> list = new List<MultiMedia>();
    list.Add(multiMedias);
    apnpayload.MultiMedias = list;    
    template.setAPNInfo(apnpayload);


    //设置客户端展示时间
    //String begin = "2015-03-06 14:28:10";
    //String end = "2015-03-06 14:38:20";
    //template.setDuration(begin, end);

    return template;
}

5.5 对应接口

参数描述

参数经SDK传给您的客户端，客户端根据参数对应实现撤回机制

参数说明

RevokeTemplate代码示例

使用方式和其他模板类似

private static String HOST = "http://api.getui.com/apiex.htm";
private static String APPID = "";
private static String APPKEY = "";
private static String MASTERSECRET = "";
private static String RevokeTASKID = "";
private static String CLIENTID1 = "";
private static String CLIENTID2 = "";

private static void pushMessageToApp()
        {

            IGtPush push = new IGtPush(HOST, APPKEY, MASTERSECRET);
            AppMessage message = new AppMessage();

            RevokeTemplate template = RevokeTemplateDemo();
            message.IsOffline = false;
            message.OfflineExpireTime = 1000 * 3600 * 12;
            message.Data = template;
            List<String> appIdList = new List<string>();
            appIdList.Add(APPID);
            message.AppIdList = appIdList;

            String pushResult = push.pushMessageToApp(message);
            System.Console.WriteLine("-----------------------------------------------");
            System.Console.WriteLine(pushResult);
        }
public static RevokeTemplate RevokeTemplateDemo()
        {
            RevokeTemplate template = new RevokeTemplate();
            template.AppId = APPID;
            template.AppKey = APPKEY;
            template.OldTaskId = RevokeTASKID;
            template.setForce(true);

            return template;
        }