cn.jmessage.api.message

Class MessageClient

java.lang.Object

cn.jmessage.api.common.BaseClient

cn.jmessage.api.message.MessageClient

public class MessageClient
extends BaseClient

Field Summary

Fields inherited from class cn.jmessage.api.common.BaseClient

_baseUrl, _gson, _httpClient

Constructor Summary

Constructors

Constructor and Description
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)

Method Summary

Methods

Modifier and Type	Method and Description
MessageListResult	getMessageList(int count, java.lang.String begin_time, java.lang.String end_time) Deprecated.
MessageListResult	getMessageListByCursor(java.lang.String cursor) Deprecated.
MessageListResult	getUserMessages(java.lang.String username, int count, java.lang.String begin_time, java.lang.String end_time) Deprecated.
MessageListResult	getUserMessagesByCursor(java.lang.String username, java.lang.String cursor) Deprecated.
cn.jiguang.common.resp.ResponseWrapper	retractMessage(java.lang.String username, long messageId) retract message 消息撤回
SendMessageResult	sendMessage(MessagePayload payload)

Methods inherited from class cn.jmessage.api.common.BaseClient

setHttpClient

Methods inherited from class java.lang.Object

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

Constructor Detail

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)

Method Detail

sendMessage

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

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getMessageList

@Deprecated
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

Deprecated.

Please use ReportClient.v2GetMessageList(int, String, String) Get message list from history, messages will store 60 days.

Parameters:

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'

Returns:

MessageListResult

Throws:

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

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

getMessageListByCursor

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

Deprecated.

Please use ReportClient.v2GetUserMessagesByCursor(String, String) Get message list with cursor, the cursor will effective in 120 seconds. And will return same count of messages as first request.

Parameters:

cursor - First request will return cursor

Returns:

MessageListResult

Throws:

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

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

getUserMessages

@Deprecated
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

Deprecated.

Please use ReportClient.v2GetUserMessages(String, int, String, String) Get message list from user's record, messages will store 60 days.

Parameters:

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'

Returns:

MessageListResult

Throws:

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

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

getUserMessagesByCursor

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

Deprecated.

Please use ReportClient.v2GetUserMessagesByCursor(java.lang.String, java.lang.String) Get user's message list with cursor, the cursor will effective in 120 seconds. And will return same count of messages as first request.

Parameters:

username - Necessary parameter.

cursor - First request will return cursor

Returns:

MessageListResult

Throws:

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 消息撤回

Parameters:

username - 用户名

messageId - message id

Returns:

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

Throws:

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

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