Package cn.jpush.api.schedule

Class ScheduleClient

java.lang.Object

cn.jpush.api.schedule.ScheduleClient

public class ScheduleClient
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
ScheduleClient(java.lang.String masterSecret, java.lang.String appkey)
ScheduleClient(java.lang.String masterSecret, java.lang.String appKey, int maxRetryTimes)	Deprecated.
ScheduleClient(java.lang.String masterSecret, java.lang.String appKey, int maxRetryTimes, cn.jiguang.common.connection.HttpProxy proxy)	Deprecated.
ScheduleClient(java.lang.String masterSecret, java.lang.String appKey, cn.jiguang.common.connection.HttpProxy proxy, cn.jiguang.common.ClientConfig conf)	Create a Schedule Client with custom configuration.

Method Summary

Modifier and Type	Method	Description
ScheduleResult	createSchedule(SchedulePayload payload)
void	deleteSchedule(java.lang.String scheduleId)
ScheduleResult	getSchedule(java.lang.String scheduleId)
ScheduleListResult	getScheduleList(int page)
ScheduleMsgIdsResult	getScheduleMsgIds(java.lang.String scheduleId)
ScheduleResult	updateSchedule(java.lang.String scheduleId, SchedulePayload payload)

Methods inherited from class java.lang.Object

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

Constructor Detail

ScheduleClient

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

ScheduleClient

@Deprecated
public ScheduleClient(java.lang.String masterSecret,
                      java.lang.String appKey,
                      int maxRetryTimes)

Deprecated.

This will be removed in the future. Please use ClientConfig{jiguang-common cn.jiguang.common.ClientConfig#setMaxRetryTimes} instead of this constructor.

Parameters:

masterSecret - API access secret of the appKey.

appKey - The KEY of one application on JPush.

maxRetryTimes - The mas retry times.

ScheduleClient

@Deprecated
public ScheduleClient(java.lang.String masterSecret,
                      java.lang.String appKey,
                      int maxRetryTimes,
                      cn.jiguang.common.connection.HttpProxy proxy)

Deprecated.

This will be removed in the future. Please use ClientConfig{jiguang-common cn.jiguang.common.ClientConfig#setMaxRetryTimes} instead of this constructor.

Parameters:

masterSecret - API access secret of the appKey.

appKey - The KEY of one application on JPush.

maxRetryTimes - The mas retry times.

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

ScheduleClient

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

Create a Schedule Client with custom configuration.

Parameters:

masterSecret - API access secret of the appKey.

appKey - The KEY of one application on JPush.

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

conf - The client configuration. Can use ClientConfig.getInstance() as default.

Method Detail

createSchedule

public ScheduleResult createSchedule(SchedulePayload payload)
                              throws cn.jiguang.common.resp.APIConnectionException,
                                     cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getScheduleList

public ScheduleListResult getScheduleList(int page)
                                   throws cn.jiguang.common.resp.APIConnectionException,
                                          cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getSchedule

public ScheduleResult getSchedule(java.lang.String scheduleId)
                           throws cn.jiguang.common.resp.APIConnectionException,
                                  cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getScheduleMsgIds

public ScheduleMsgIdsResult getScheduleMsgIds(java.lang.String scheduleId)
                                       throws cn.jiguang.common.resp.APIConnectionException,
                                              cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

updateSchedule

public ScheduleResult updateSchedule(java.lang.String scheduleId,
                                     SchedulePayload payload)
                              throws cn.jiguang.common.resp.APIConnectionException,
                                     cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

deleteSchedule

public void deleteSchedule(java.lang.String scheduleId)
                    throws cn.jiguang.common.resp.APIConnectionException,
                           cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException