cn.jmessage.api.reportv2

Class ReportClient

java.lang.Object

cn.jmessage.api.common.BaseClient

cn.jmessage.api.reportv2.ReportClient

public class ReportClient
extends BaseClient

Rest Report V2 相关接口, 文档链接： https://docs.jiguang.cn/jmessage/server/rest_api_im_report_v2/ 之前 MessageClient 下的获取历史消息接口全部转移到这里

Field Summary

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

_baseUrl, _gson, _httpClient

Constructor Summary

Constructors

Constructor and Description
ReportClient(java.lang.String appKey, java.lang.String masterSecret)
ReportClient(java.lang.String appKey, java.lang.String masterSecret, cn.jiguang.common.connection.HttpProxy proxy)
ReportClient(java.lang.String appKey, java.lang.String masterSecret, cn.jiguang.common.connection.HttpProxy proxy, JMessageConfig config) Create a JMessage Base Client

Method Summary

Methods

Modifier and Type	Method and Description
GroupStatListResult	getGroupStatistic(java.lang.String start, int duration) Get group statistic, time unit only supports DAY now.
MessageStatListResult	getMessageStatistic(java.lang.String timeUnit, java.lang.String start, int duration) Get message statistic.
UserStatListResult	getUserStatistic(java.lang.String startTime, int duration) Get user statistic, now time unit only supports DAY
MessageListResult	v2GetGroupMessageList(long groupId, int count, java.lang.String begin_time, java.lang.String end_time) Get group message list
MessageListResult	v2GetMessageList(int count, java.lang.String begin_time, java.lang.String end_time) Get message list from history, messages will store 60 days.
MessageListResult	v2GetMessageListByCursor(java.lang.String cursor) Get message list with cursor, the cursor will effective in 120 seconds.
MessageListResult	v2GetUserMessages(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	v2GetUserMessagesByCursor(java.lang.String username, java.lang.String cursor) Get user's message list with cursor, the cursor will effective in 120 seconds.

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

ReportClient

public ReportClient(java.lang.String appKey,
            java.lang.String masterSecret)

ReportClient

public ReportClient(java.lang.String appKey,
            java.lang.String masterSecret,
            cn.jiguang.common.connection.HttpProxy proxy)

ReportClient

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

Create a JMessage Base Client

Parameters:

appKey - The KEY of one application on JPush.

masterSecret - API access secret of the appKey.

proxy - The proxy, if there is no proxy, should be null.

config - The client configuration. Can use JMessageConfig.getInstance() as default.

Method Detail

v2GetMessageList

public MessageListResult v2GetMessageList(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.

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

v2GetMessageListByCursor

public MessageListResult v2GetMessageListByCursor(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.

Parameters:

cursor - First request will return cursor

Returns:

MessageListResult

Throws:

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

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

v2GetUserMessages

public MessageListResult v2GetUserMessages(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.

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

v2GetUserMessagesByCursor

public MessageListResult v2GetUserMessagesByCursor(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.

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

v2GetGroupMessageList

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

Get group message list

Parameters:

groupId - group id

count - message list count

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

getUserStatistic

public UserStatListResult getUserStatistic(java.lang.String startTime,
                                  int duration)
                                    throws cn.jiguang.common.resp.APIConnectionException,
                                           cn.jiguang.common.resp.APIRequestException

Get user statistic, now time unit only supports DAY

Parameters:

startTime - start time, format: yyyy-MM-dd

duration - 0-60

Returns:

UserStatListResult

Throws:

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

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

getMessageStatistic

public MessageStatListResult getMessageStatistic(java.lang.String timeUnit,
                                        java.lang.String start,
                                        int duration)
                                          throws cn.jiguang.common.resp.APIConnectionException,
                                                 cn.jiguang.common.resp.APIRequestException

Get message statistic. Detail instructions please refer to https://docs.jiguang.cn/jmessage/server/rest_api_im_report_v2/#_6

Parameters:

timeUnit - MUST be one of HOUR, DAY, MONTH

start - start time, when timeUnit is HOUR, format: yyyy-MM-dd HH,

duration - depends on timeUnit, the duration has limit

Returns:

MessageStatListResult

Throws:

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

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

getGroupStatistic

public GroupStatListResult getGroupStatistic(java.lang.String start,
                                    int duration)
                                      throws cn.jiguang.common.resp.APIConnectionException,
                                             cn.jiguang.common.resp.APIRequestException

Get group statistic, time unit only supports DAY now.

Parameters:

start - Format: yyyy-MM-dd

duration - duration must between 0 and 60

Returns:

GroupStatListResult

Throws:

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

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