概述

Android

iOS

REST API

服务端SDK

ixintui 服务端sdk(node.js版)

VERSION 1.0

发布时间:2016-8-31
详细文档请移步REST_API_V2.md

[TOC]

概述

JSSDK包括一个demo.js及 ixintui的文件夹

demo.js列出了消息发送方式
ixintui文件夹下包含client.js,message.js, util.js

其中 client.js负责和服务端进行网络通信
message.js负责组装消息样式
util.js为内部调用使用。

对外的接口

I. client.js

  • 构造函数
var Client = require("./ixintui/client");
var IxintuiPushUrl = "http://api.ixintui.com:8300/v2/push";
client = new IxintuiClient(IxintuiPushUrl);
  • 发送消息
client.pushMessage(message,handle_res);

参数: Message子类的实例,handle_res 自定义回掉函数
返回值:无

handle_res示例:(接受参数为 http response)

function handle_res(res){
    console.log('STATUS: ' + res.statusCode);
    console.log('HEADERS: ' + JSON.stringify(res.headers));
    res.setEncoding('utf8');
    res.on("data",function(data){console.log(data);});
}

II. message.js

该文件包含两个基础类,Notification及Message
Notification有两个子类,分别是AndrodiNotification和IosNotification
Notification的子类用来设置消息Message的样式,如果不设置Notification,则为透传消息。
Message有9个子类,分别用来设置不同种类的消息的样式。具体可以参照个各类的声明。

使用方法如下:

    var Message = require("./ixintui/message");
    var message  = new Message.MessageAll(MessageContent, AndroidAppKey, AndroidSecretKey, IosAppKey, IosSecretKey)
    var AndroidNotif = new AndroidNotification(Sound,Unremovable,Title,ClickAction,Value,Vibrate,Badge);
    var IosNotif = new IosNotification(Badge,Sound,Category);
    var message->setAndroidNotification($AndroidNotif);
    var message->setIosNotification($IosNotif);

message.js 类说明:

1.android通知样式:
new AndroidNotification(Sound,Unremovable,Title,ClickAction,Value,Vibrate,Badge)

不设置可以传 undefined或者null,如:AndroidNotification(null,null,null,null,null,null,Badge)
每个属性都有set方法,如:setBadge()

2.ios通知样式:
new IosNotification(Badge,Sound,Category)

使用方法同上

3.所有消息的基类(不直接使用):

成员方法表:

方法名 说明
setPeriod(Period) 设置消息有效期
setQps(Qps) 设置发送速度
setTimed(timed,timeval) 设置定时消息
setIsNotif(IsNotif) 设置消息类型(0:透传,1:通知)
setExtra(extra) 设置extra字段
setContentAvailable(value) 设置content-available
4.ios和android广播消息:
new MessageAll(MessageContent, AndroidAppKey, AndroidSecretKey, IosAppKey,IosSecretKey)

方法:

方法名 说明
setAndroidApp(AndroidAppKey, AndroidSecretKey) 设置androidapp
setIosApp(IosAppKey, IosSecretKey) 设置iosapp
addIosApp(IosAppKey,IosSecretKey) 添加iosapp
setAndroidNotification(Notif) 设置android消息样式
setIosNotification(Notif) 设置ios消息样式
5.android广播消息
new MessageAndroid(MessageContent, AndroidAppKey, AndroidSecretKey)

方法:

方法名 说明
setAndroidApp(AndroidAppKey, AndroidSecretKey) 设置androidapp
setAndroidNotification(Notif) 设置android消息样式
6.ios广播消息
new MessageIos(MessageContent, IosAppKey, IosSecretKey)

方法:

方法名 说明
setIosApp(IosAppKey, IosSecretKey) 设置iosapp
addIosApp(IosAppKey,IosSecretKey) 添加iosapp
setIosNotification(Notif) 设置ios消息样式
7.别名中最后活跃设备发送消息
new MessageLastAliasActive(MessageContent, alias)

方法:

方法名 说明
setAlias(alias) 设置别名
setAndroidApp(AndroidAppKey, AndroidSecretKey) 设置androidapp
setIosApp(IosAppKey, IosSecretKey) 设置iosapp
addIosApp(IosAppKey,IosSecretKey) 添加iosapp
setAndroidNotification(Notif) 设置android消息样式
setIosNotification(Notif) 设置ios消息样式
8.别名发送
new MessageAlias(MessageContent, alias)

方法:

方法名 说明
setAlias(alias) 设置别名
setAndroidApp(AndroidAppKey, AndroidSecretKey) 设置androidapp
setIosApp(IosAppKey, IosSecretKey) 设置iosapp
addIosApp(IosAppKey,IosSecretKey) 添加iosapp
setAndroidNotification(Notif) 设置android消息样式
setIosNotification(Notif) 设置ios消息样式
9.点播消息
new MessageToken(MessageContent)   

方法:

方法名 说明
setAndroidApp(AndroidAppKey, AndroidSecretKey,token) 设置androidapp和token
setIosApp(IosAppKey, IosSecretKey, token) 设置iosapp和token
addIosApp(IosAppKey,IosSecretKey,token) 添加iosapp和token
setAndroidNotification(Notif) 设置android消息样式
setIosNotification(Notif) 设置ios消息样式
10.按tag过滤用户
new MessageTag(MessageContent)                  

方法:

方法名 说明
setAndroidApp(AndroidAppKey, AndroidSecretKey) 设置androidapp
setIosApp(IosAppKey, IosSecretKey) 设置iosapp
addIosApp(IosAppKey,IosSecretKey) 添加iosapp
setAndroidNotification(Notif) 设置android消息样式
setIosNotification(Notif) 设置ios消息样式
setTag(tag) 设置tag
setStag(stag) 设置stag(stag和tag只能使用一个,推荐使用stag)
11.按用户信息过滤
new MessageUserInfo(MessageContent, AndroidAppKey, AndroidSecretKey, UserInfo)

方法:

方法名 说明
setAndroidApp(AndroidAppKey, AndroidSecretKey) 设置androidapp
setAndroidNotification(Notif) 设置android消息样式
setAndroidOptFilter(optfilter) 设置用户信息过滤条件
12.同时按tag和用户信息过滤
new MessageTagAndUserInfo(MessageContent, AndroidAppKey, AndroidSecretKey,UserInfo)

方法:

方法名 说明
setAndroidApp(AndroidAppKey, AndroidSecretKey) 设置androidapp
setAndroidNotification(Notif) 设置android消息样式
setAndroidOptFilter(optfilter) 设置用户信息过滤条件
setTag(tag) 设置tag
setStag(stag) 设置stag(stag和tag只能使用一个,推荐使用stag)