消息收发接口- 其他-客户化文档
目录

消息收发接口

产品提供了系统消息功能。通过消息收发接口可进行客户化的消息收发处理。例如开发者调用消息收发接口在需要进行消息处理时执行消息发送、删除、获取消息等操作。

消息收发接口类

实现类为：com.geezn.message.service.MessageService

通过调用该接口类的相关方法进行消息的发送、接收等处理。

下面详细介绍该接口提供的方法。

发送消息

方法为sendMessage(JSONObject message)。

  • 参数： message – json 格式字符串，包含消息接收人列表、消息类型，可能扩展其他属性，例如发送人等，具体格式为
{
   "receivers":{users:[user1,user2,…],orgs:[org1, org2, …],roles:[role1, role2, …]},//消息接受者，可以为用户个人users,也可以为机构orgs或角色roles
   "type":"消息类型",  //消息类型，根据不同类型会做不同发送处理
   "content": //消息内容
}
  • 返回值：result - json字符串。
{status:"success/fail", msg:"错误信息"}，如果status为fail,msg为错误信息

获取消息

方法为getMessages(JSONObject conditions)。

  • 参数： conditions – JSON格式字符串，包含用户名、消息类型，可能扩展其他属性，例如，发送人等，具体格式为
{
     receiver:userid,//待查消息的用户ID
     type: 消息类型 //消息类型，同发送消息的type
 }
  • 返回值：result - json字符串。
{
     messages:[
              {
                  id: 消息唯一标识,
                  content: 消息内容HTML（可以是消息内容本身，也可以使用消息解析器进行解析）
               },…
      ]
}

删除一条消息

方法为removeMessage(JSONObject conditions)。

  • 参数：conditions – json数组格式字符串，包含消息id，消息类型，具体格式为
{
      id: 消息唯一标识,
      type: 消息类型 ////消息类型，同发送消息的type   
}
  • 返回值：result - json字符串。
{status:"success/fail", msg:"错误信息"}，如果status为fail,msg为错误信息

清空某一个用户的某类消息

方法为removeMessages(JSONObject conditions)。

  • 参数： conditions – JSON格式字符串，包含用户名、消息类型，具体格式为
{
     user:userid,//待清空消息的用户ID
     type: 消息类型 //消息类型，同发送消息的type
 }
  • 返回值：result - json字符串。
{status:"success/fail", msg:"错误信息"}，如果status为fail,msg为错误信息

获取历史消息

方法为getHistoryMessages(JSONObject conditions)。

参数：同getMessages

返回值：同getMessages

删除历史消息

方法为removeHistoryMessages(JSONObject conditions)。

参数：同removeMessages

返回值：removeMessages

已关闭消息的清除

对于已关闭的系统消息，系统会自动定期清除。

servlet层接口

使用统一servlet入口。实现类：com.geezn.message.servlet.MessageModuleEntry。模块名称：MessageModule

参数：action – 动作标识，可取值有：

  • action=0，调用sendMessage
  • action=1，调用getMessages
  • action=2，调用removeMessage
  • action=3，调用removeMessages
  • action=4，调用getHistoryMessages
  • action=5，调用removeHistoryMessages

其他参数 – 同service层方法参数