cn.jmessage.api.message

类 MessageClient

java.lang.Object

cn.jmessage.api.common.BaseClient

cn.jmessage.api.message.MessageClient

public class MessageClient
extends BaseClient

字段概要

从类继承的字段 cn.jmessage.api.common.BaseClient

_baseUrl, _gson, _httpClient

构造器概要

构造器

构造器和说明
MessageClient(java.lang.String appkey, java.lang.String masterSecret)
MessageClient(java.lang.String appkey, java.lang.String masterSecret, cn.jiguang.common.connection.HttpProxy proxy, JMessageConfig config)

方法概要

限定符和类型	方法和说明
MessageListResult	getMessageList(int count, java.lang.String begin_time, java.lang.String end_time) Get message list from history, messages will store 60 days.
MessageListResult	getMessageListByCursor(java.lang.String cursor) Get message list with cursor, the cursor will effective in 120 seconds.
MessageListResult	getUserMessages(java.lang.String username, int count, java.lang.String begin_time, java.lang.String end_time) Get message list from user's record, messages will store 60 days.
MessageListResult	getUserMessagesByCursor(java.lang.String username, java.lang.String cursor) Get user's message list with cursor, the cursor will effective in 120 seconds.
cn.jiguang.common.resp.ResponseWrapper	retractMessage(java.lang.String username, long messageId) retract message 消息撤回
SendMessageResult	sendMessage(MessagePayload payload)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

MessageClient

public MessageClient(java.lang.String appkey,
                     java.lang.String masterSecret)

MessageClient

public MessageClient(java.lang.String appkey,
                     java.lang.String masterSecret,
                     cn.jiguang.common.connection.HttpProxy proxy,
                     JMessageConfig config)

方法详细资料

sendMessage

public SendMessageResult sendMessage(MessagePayload payload)
                              throws cn.jiguang.common.resp.APIConnectionException,
                                     cn.jiguang.common.resp.APIRequestException

抛出:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getMessageList

public MessageListResult getMessageList(int count,
                                        java.lang.String begin_time,
                                        java.lang.String end_time)
                                 throws cn.jiguang.common.resp.APIConnectionException,
                                        cn.jiguang.common.resp.APIRequestException

Get message list from history, messages will store 60 days.

参数:

count - Necessary parameter. The count of the message list.

begin_time - Necessary parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'

end_time - Necessary parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'

返回:

MessageListResult

抛出:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getMessageListByCursor

public MessageListResult getMessageListByCursor(java.lang.String cursor)
                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                cn.jiguang.common.resp.APIRequestException

Get message list with cursor, the cursor will effective in 120 seconds. And will return same count of messages as first request.

参数:

cursor - First request will return cursor

返回:

MessageListResult

抛出:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getUserMessages

public MessageListResult getUserMessages(java.lang.String username,
                                         int count,
                                         java.lang.String begin_time,
                                         java.lang.String end_time)
                                  throws cn.jiguang.common.resp.APIConnectionException,
                                         cn.jiguang.common.resp.APIRequestException

Get message list from user's record, messages will store 60 days.

参数:

username - Necessary parameter.

count - Necessary parameter. The count of the message list.

begin_time - Optional parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'

end_time - Optional parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'

返回:

MessageListResult

抛出:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getUserMessagesByCursor

public MessageListResult getUserMessagesByCursor(java.lang.String username,
                                                 java.lang.String cursor)
                                          throws cn.jiguang.common.resp.APIConnectionException,
                                                 cn.jiguang.common.resp.APIRequestException

Get user's message list with cursor, the cursor will effective in 120 seconds. And will return same count of messages as first request.

参数:

username - Necessary parameter.

cursor - First request will return cursor

返回:

MessageListResult

抛出:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

retractMessage

public cn.jiguang.common.resp.ResponseWrapper retractMessage(java.lang.String username,
                                                             long messageId)
                                                      throws cn.jiguang.common.resp.APIConnectionException,
                                                             cn.jiguang.common.resp.APIRequestException

retract message 消息撤回

参数:

username - 用户名

messageId - message id

返回:

No Content， Error Code： 855001 out of retract message time, the effective time is within 3 minutes after sending message 855003 the retract message is not exist 855004 the message had been retracted

抛出:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception