cn.jpush.api

Class JPushClient

java.lang.Object

cn.jpush.api.JPushClient

public class JPushClient
extends Object

The global entrance of JPush API library.

Constructor Summary

Constructors

Constructor and Description
JPushClient(String masterSecret, String appKey) Create a JPush Client.
JPushClient(String masterSecret, String appKey, boolean apnsProduction, long timeToLive) Deprecated.
JPushClient(String masterSecret, String appKey, cn.jiguang.common.connection.HttpProxy proxy, cn.jiguang.common.ClientConfig conf) Create a JPush Client by custom Client configuration.
JPushClient(String masterSecret, String appKey, int maxRetryTimes) Deprecated.
JPushClient(String masterSecret, String appKey, int maxRetryTimes, cn.jiguang.common.connection.HttpProxy proxy) Deprecated.
JPushClient(String masterSecret, String appKey, int maxRetryTimes, cn.jiguang.common.connection.HttpProxy proxy, cn.jiguang.common.ClientConfig conf) Deprecated.
JPushClient(String masterSecret, String appKey, int maxRetryTimes, cn.jiguang.common.connection.HttpProxy proxy, cn.jiguang.common.ClientConfig conf, boolean apnsProduction, long timeToLive) Deprecated.

Method Summary

Modifier and Type	Method and Description
cn.jiguang.common.resp.DefaultResult	addRemoveDevicesFromTag(String theTag, Set<String> toAddUsers, Set<String> toRemoveUsers)
BatchPushResult	batchSendPushByAlias(List<PushPayload> pushPayloadList)
BatchPushResult	batchSendPushByRegId(List<PushPayload> pushPayloadList)
cn.jiguang.common.resp.DefaultResult	bindMobile(String registrationId, String mobile)
void	close()
ScheduleResult	createDailySchedule(String name, String start, String end, String time, int frequency, PushPayload push, String masterSecret, String appKey) Create a daily schedule push with a custom frequency.
ScheduleResult	createDailySchedule(String name, String start, String end, String time, PushPayload push, String masterSecret, String appKey) Create a daily schedule push everyday.
ScheduleResult	createMonthlySchedule(String name, String start, String end, String time, int frequency, String[] points, PushPayload push, String masterSecret, String appKey) Create a monthly schedule push with a custom frequency at the appointed days.
ScheduleResult	createMonthlySchedule(String name, String start, String end, String time, String[] points, PushPayload push, String masterSecret, String appKey) Create a monthly schedule push every month at the appointed days.
ScheduleResult	createSingleSchedule(String name, String time, PushPayload push, String masterSecret, String appKey) Create a single schedule.
ScheduleResult	createWeeklySchedule(String name, String start, String end, String time, int frequency, cn.jiguang.common.Week[] days, PushPayload push, String masterSecret, String appKey) Create a weekly schedule push with a custom frequency at the appointed days.
ScheduleResult	createWeeklySchedule(String name, String start, String end, String time, cn.jiguang.common.Week[] days, PushPayload push, String masterSecret, String appKey) Create a weekly schedule push every week at the appointed days.
cn.jiguang.common.resp.DefaultResult	deleteAlias(String alias, String platform)
cn.jiguang.common.resp.DefaultResult	deletePush(String msgId) Delete a push by msgId.
void	deleteSchedule(String scheduleId) Delete a schedule by id.
cn.jiguang.common.resp.DefaultResult	deleteTag(String theTag, String platform)
ScheduleResult	disableSchedule(String scheduleId) Disable the schedule.
ScheduleResult	enableSchedule(String scheduleId) Enable the schedule.
AliasDeviceListResult	getAliasDeviceList(String alias, String platform)
CIDResult	getCidList(int count, String type) Get cid list, the data form of cid is appKey-uuid.
TagAliasResult	getDeviceTagAlias(String registrationId)
GroupMessageDetailResult	getGroupMessagesDetail(String groupMsgIds)
GroupUsersResult	getGroupReportUsers(cn.jiguang.common.TimeUnit timeUnit, String start, int duration)
MessageDetailResult	getMessagesDetail(String msgIds)
Map<String,MessageStatus>	getMessageStatus(CheckMessagePayload payload)
PushClient	getPushClient()
ReceivedsResult	getReceivedsDetail(String msgIds)
MessagesResult	getReportMessages(String msgIds)
ReceivedsResult	getReportReceiveds(String msgIds) Get received report.
UsersResult	getReportUsers(cn.jiguang.common.TimeUnit timeUnit, String start, int duration)
ScheduleResult	getSchedule(String scheduleId) Get the schedule information by the schedule id.
ScheduleListResult	getScheduleList() Get the schedule list size and the first page.
ScheduleListResult	getScheduleList(int page) Get the schedule list by the page.
ScheduleMsgIdsResult	getScheduleMsgIds(String scheduleId) Get the message id by the schedule id.
TagListResult	getTagList()
Map<String,OnlineStatus>	getUserOnlineStatus(String... registrationIds)
cn.jiguang.common.resp.BooleanResult	isDeviceInTag(String theTag, String registrationID)
cn.jiguang.common.resp.DefaultResult	removeDevicesFromAlias(String alias, Set<String> toRemoveDevice)
PushResult	sendAndroidMessageWithAlias(String title, String msgContent, SMS sms, String... alias) Send an Android message with alias.
PushResult	sendAndroidMessageWithAlias(String title, String msgContent, String... alias)
PushResult	sendAndroidMessageWithRegistrationID(String title, String msgContent, SMS sms, String... registrationID) Send an Android message with registration id.
PushResult	sendAndroidMessageWithRegistrationID(String title, String msgContent, String... registrationID)
PushResult	sendAndroidNotificationWithAlias(String title, String alert, Map<String,String> extras, String... alias)
PushResult	sendAndroidNotificationWithAlias(String title, String alert, SMS sms, Map<String,String> extras, String... alias) Send a notification to Android with alias.
PushResult	sendAndroidNotificationWithRegistrationID(String title, String alert, Map<String,String> extras, String... registrationID)
PushResult	sendAndroidNotificationWithRegistrationID(String title, String alert, SMS sms, Map<String,String> extras, String... registrationID) Send a notification to Android with RegistrationID.
PushResult	sendFilePush(PushPayload pushPayload) Send a file push with PushPayload object.
PushResult	sendIosMessageWithAlias(String title, String msgContent, SMS sms, String... alias) Send an iOS message with alias.
PushResult	sendIosMessageWithAlias(String title, String msgContent, String... alias)
PushResult	sendIosMessageWithRegistrationID(String title, String msgContent, SMS sms, String... registrationID) Send an iOS message with registration id.
PushResult	sendIosMessageWithRegistrationID(String title, String msgContent, String... registrationID)
PushResult	sendIosNotificationWithAlias(IosAlert alert, Map<String,String> extras, String... alias) Send an iOS notification with alias.
PushResult	sendIosNotificationWithAlias(IosAlert alert, SMS sms, Map<String,String> extras, String... alias) Send an iOS notification with alias.
PushResult	sendIosNotificationWithAlias(com.google.gson.JsonObject alert, Map<String,String> extras, String... alias) Send an iOS notification with alias.
PushResult	sendIosNotificationWithAlias(com.google.gson.JsonObject alert, SMS sms, Map<String,String> extras, String... alias) Send an iOS notification with alias.
PushResult	sendIosNotificationWithAlias(String alert, Map<String,String> extras, String... alias)
PushResult	sendIosNotificationWithAlias(String alert, SMS sms, Map<String,String> extras, String... alias) Send a notification to iOS with alias.
PushResult	sendIosNotificationWithRegistrationID(IosAlert alert, Map<String,String> extras, String... registrationID) Send an iOS notification with registrationIds.
PushResult	sendIosNotificationWithRegistrationID(IosAlert alert, SMS sms, Map<String,String> extras, String... registrationID) Send an iOS notification with registrationIds.
PushResult	sendIosNotificationWithRegistrationID(com.google.gson.JsonObject alert, Map<String,String> extras, String... registrationID) Send an iOS notification with registrationIds.
PushResult	sendIosNotificationWithRegistrationID(com.google.gson.JsonObject alert, SMS sms, Map<String,String> extras, String... registrationID) Send an iOS notification with registrationIds.
PushResult	sendIosNotificationWithRegistrationID(String alert, Map<String,String> extras, String... registrationID)
PushResult	sendIosNotificationWithRegistrationID(String alert, SMS sms, Map<String,String> extras, String... registrationID) Send an iOS notification with registrationIds.
PushResult	sendMessageAll(String msgContent)
PushResult	sendMessageAll(String msgContent, SMS sms) Send a message to all If it doesn't received within the delay time,JPush will send a SMS to the corresponding users.
PushResult	sendMessageWithRegistrationID(String title, String msgContent, SMS sms, String... registrationID) Send a message with registrationIds.
PushResult	sendMessageWithRegistrationID(String title, String msgContent, String... registrationID)
PushResult	sendNotificationAll(String alert)
PushResult	sendNotificationAll(String alert, SMS sms) Send a notification to all.
PushResult	sendPush(PushPayload pushPayload) Send a push with PushPayload object.
PushResult	sendPush(String payloadString) Send a push with JSON string.
PushResult	sendPushValidate(PushPayload payload) Validate a push action, but do NOT send it actually.
PushResult	sendPushValidate(String payloadString)
cn.jiguang.common.resp.DefaultResult	updateDeviceTagAlias(String registrationId, boolean clearAlias, boolean clearTag)
cn.jiguang.common.resp.DefaultResult	updateDeviceTagAlias(String registrationId, String alias, Set<String> tagsToAdd, Set<String> tagsToRemove)
ScheduleResult	updateSchedule(String scheduleId, SchedulePayload payload) Update a schedule by the id.
ScheduleResult	updateScheduleName(String scheduleId, String name) Update the schedule name
ScheduleResult	updateSchedulePush(String scheduleId, PushPayload push) Update the push content of the schedule.
ScheduleResult	updateScheduleTrigger(String scheduleId, TriggerPayload trigger) Update the trigger of the schedule.

Methods inherited from class java.lang.Object

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

Constructor Detail

JPushClient

public JPushClient(String masterSecret,
                   String appKey)

Create a JPush Client.

Parameters:

masterSecret - API access secret of the appKey.

appKey - The KEY of one application on JPush.

JPushClient

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

Create a JPush Client by custom Client 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.

JPushClient

@Deprecated
public JPushClient(String masterSecret,
                               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 max retry times.

JPushClient

@Deprecated
public JPushClient(String masterSecret,
                               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 max retry times.

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

JPushClient

@Deprecated
public JPushClient(String masterSecret,
                               String appKey,
                               int maxRetryTimes,
                               cn.jiguang.common.connection.HttpProxy proxy,
                               cn.jiguang.common.ClientConfig conf)

Deprecated.

Create a JPush Client by custom Client configuration. If you are using JPush privacy cloud, maybe this constructor is what you needed. 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 - Client request retry times.

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

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

JPushClient

@Deprecated
public JPushClient(String masterSecret,
                               String appKey,
                               int maxRetryTimes,
                               cn.jiguang.common.connection.HttpProxy proxy,
                               cn.jiguang.common.ClientConfig conf,
                               boolean apnsProduction,
                               long timeToLive)

Deprecated.

Create a JPush Client by custom Client configuration with global settings. If you are using JPush privacy cloud, and you want different settings from default globally, maybe this constructor is what you needed. This will be removed in the future. Please use ClientConfig{jiguang-common cn.jiguang.common.ClientConfig#setGlobalPushSetting} instead of this constructor.

Parameters:

masterSecret - API access secret of the appKey.

appKey - The KEY of one application on JPush.

maxRetryTimes - Client request retry times.

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

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

apnsProduction - Global APNs environment setting. It will override PushPayload Options.

timeToLive - Global time_to_live setting. It will override PushPayload Options.

JPushClient

@Deprecated
public JPushClient(String masterSecret,
                               String appKey,
                               boolean apnsProduction,
                               long timeToLive)

Deprecated.

Create a JPush Client with global settings. If you want different settings from default globally, this constructor is what you needed. This will be removed in the future. Please use ClientConfig{jiguang-common cn.jiguang.common.ClientConfig#setGlobalPushSetting} instead of this constructor.

Parameters:

masterSecret - API access secret of the appKey.

appKey - The KEY of one application on JPush.

apnsProduction - Global APNs environment setting. It will override PushPayload Options.

timeToLive - Global time_to_live setting. It will override PushPayload Options.

Method Detail

getPushClient

public PushClient getPushClient()

sendPush

public PushResult sendPush(PushPayload pushPayload)
                    throws cn.jiguang.common.resp.APIConnectionException,
                           cn.jiguang.common.resp.APIRequestException

Send a push with PushPayload object.

Parameters:

pushPayload - payload object of a push.

Returns:

PushResult The result object of a Push. Can be printed to a JSON.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendPush

public PushResult sendPush(String payloadString)
                    throws cn.jiguang.common.resp.APIConnectionException,
                           cn.jiguang.common.resp.APIRequestException

Send a push with JSON string. You can send a push JSON string directly with this method. Attention: globally settings cannot be affect this type of Push.

Parameters:

payloadString - payload of a push.

Returns:

PushResult. Can be printed to a JSON.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendFilePush

public PushResult sendFilePush(PushPayload pushPayload)
                        throws cn.jiguang.common.resp.APIConnectionException,
                               cn.jiguang.common.resp.APIRequestException

Send a file push with PushPayload object.

Parameters:

pushPayload - payload object of a push.

Returns:

PushResult The result object of a Push. Can be printed to a JSON.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendPushValidate

public PushResult sendPushValidate(PushPayload payload)
                            throws cn.jiguang.common.resp.APIConnectionException,
                                   cn.jiguang.common.resp.APIRequestException

Validate a push action, but do NOT send it actually.

Parameters:

payload - payload of a push.

Returns:

PushResult. Can be printed to a JSON.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendPushValidate

public PushResult sendPushValidate(String payloadString)
                            throws cn.jiguang.common.resp.APIConnectionException,
                                   cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

batchSendPushByRegId

public BatchPushResult batchSendPushByRegId(List<PushPayload> pushPayloadList)
                                     throws cn.jiguang.common.resp.APIConnectionException,
                                            cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

batchSendPushByAlias

public BatchPushResult batchSendPushByAlias(List<PushPayload> pushPayloadList)
                                     throws cn.jiguang.common.resp.APIConnectionException,
                                            cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getCidList

public CIDResult getCidList(int count,
                            String type)
                     throws cn.jiguang.common.resp.APIConnectionException,
                            cn.jiguang.common.resp.APIRequestException

Get cid list, the data form of cid is appKey-uuid.

Parameters:

count - the count of cid list, from 1 to 1000. default is 1.

type - default is push, option: schedule

Returns:

CIDResult, an array of cid

Throws:

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

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

getReportReceiveds

public ReceivedsResult getReportReceiveds(String msgIds)
                                   throws cn.jiguang.common.resp.APIConnectionException,
                                          cn.jiguang.common.resp.APIRequestException

Get received report.

Parameters:

msgIds - 100 msgids to batch getting is supported.

Returns:

ReceivedResult. Can be printed to JSON.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

getReportUsers

public UsersResult getReportUsers(cn.jiguang.common.TimeUnit timeUnit,
                                  String start,
                                  int duration)
                           throws cn.jiguang.common.resp.APIConnectionException,
                                  cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getReportMessages

public MessagesResult getReportMessages(String msgIds)
                                 throws cn.jiguang.common.resp.APIConnectionException,
                                        cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getMessageStatus

public Map<String,MessageStatus> getMessageStatus(CheckMessagePayload payload)
                                           throws cn.jiguang.common.resp.APIConnectionException,
                                                  cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getReceivedsDetail

public ReceivedsResult getReceivedsDetail(String msgIds)
                                   throws cn.jiguang.common.resp.APIConnectionException,
                                          cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getMessagesDetail

public MessageDetailResult getMessagesDetail(String msgIds)
                                      throws cn.jiguang.common.resp.APIConnectionException,
                                             cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getGroupMessagesDetail

public GroupMessageDetailResult getGroupMessagesDetail(String groupMsgIds)
                                                throws cn.jiguang.common.resp.APIConnectionException,
                                                       cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getGroupReportUsers

public GroupUsersResult getGroupReportUsers(cn.jiguang.common.TimeUnit timeUnit,
                                            String start,
                                            int duration)
                                     throws cn.jiguang.common.resp.APIConnectionException,
                                            cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

sendNotificationAll

public PushResult sendNotificationAll(String alert)
                               throws cn.jiguang.common.resp.APIConnectionException,
                                      cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

sendNotificationAll

public PushResult sendNotificationAll(String alert,
                                      SMS sms)
                               throws cn.jiguang.common.resp.APIConnectionException,
                                      cn.jiguang.common.resp.APIRequestException

Send a notification to all. If it doesn't received within the delay time,JPush will send a SMS to the corresponding users.

Parameters:

alert - The notification content.

sms - The SMS content and delay time. If null, sms doesn't work, no effect on Push feature.

Returns:

push result

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendAndroidNotificationWithAlias

public PushResult sendAndroidNotificationWithAlias(String title,
                                                   String alert,
                                                   Map<String,String> extras,
                                                   String... alias)
                                            throws cn.jiguang.common.resp.APIConnectionException,
                                                   cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

sendAndroidNotificationWithAlias

public PushResult sendAndroidNotificationWithAlias(String title,
                                                   String alert,
                                                   SMS sms,
                                                   Map<String,String> extras,
                                                   String... alias)
                                            throws cn.jiguang.common.resp.APIConnectionException,
                                                   cn.jiguang.common.resp.APIRequestException

Send a notification to Android with alias. If it doesn't received within the delay time,JPush will send a SMS to the corresponding users.

Parameters:

title - The notification title.

alert - The notification content.

sms - The SMS content and delay time. If null, sms doesn't work, no effect on Push feature.

extras - The extra parameter.

alias - The users' alias.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendAndroidNotificationWithRegistrationID

public PushResult sendAndroidNotificationWithRegistrationID(String title,
                                                            String alert,
                                                            Map<String,String> extras,
                                                            String... registrationID)
                                                     throws cn.jiguang.common.resp.APIConnectionException,
                                                            cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

sendAndroidNotificationWithRegistrationID

public PushResult sendAndroidNotificationWithRegistrationID(String title,
                                                            String alert,
                                                            SMS sms,
                                                            Map<String,String> extras,
                                                            String... registrationID)
                                                     throws cn.jiguang.common.resp.APIConnectionException,
                                                            cn.jiguang.common.resp.APIRequestException

Send a notification to Android with RegistrationID. If it doesn't received within the delay time,JPush will send a SMS to the corresponding users.

Parameters:

title - The notification title.

alert - The notification content.

sms - The SMS content and delay time. If null, sms doesn't work, no effect on Push feature.

extras - The extra parameter.

registrationID - The registration id generated by JPush.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendIosNotificationWithAlias

public PushResult sendIosNotificationWithAlias(String alert,
                                               Map<String,String> extras,
                                               String... alias)
                                        throws cn.jiguang.common.resp.APIConnectionException,
                                               cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

sendIosNotificationWithAlias

public PushResult sendIosNotificationWithAlias(String alert,
                                               SMS sms,
                                               Map<String,String> extras,
                                               String... alias)
                                        throws cn.jiguang.common.resp.APIConnectionException,
                                               cn.jiguang.common.resp.APIRequestException

Send a notification to iOS with alias. If it doesn't received within the delay time,JPush will send a SMS to the corresponding users.

Parameters:

alert - The notification content.

sms - The SMS content and delay time. If null, sms doesn't work, no effect on Push feature.

extras - The extra parameter.

alias - The users' alias.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendIosNotificationWithAlias

public PushResult sendIosNotificationWithAlias(IosAlert alert,
                                               Map<String,String> extras,
                                               String... alias)
                                        throws cn.jiguang.common.resp.APIConnectionException,
                                               cn.jiguang.common.resp.APIRequestException

Send an iOS notification with alias. If you want to send alert as a Json object, maybe this method is what you needed.

Parameters:

alert - The wrapper of APNs alert.

extras - The extra params.

alias - The alias list.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendIosNotificationWithAlias

public PushResult sendIosNotificationWithAlias(IosAlert alert,
                                               SMS sms,
                                               Map<String,String> extras,
                                               String... alias)
                                        throws cn.jiguang.common.resp.APIConnectionException,
                                               cn.jiguang.common.resp.APIRequestException

Send an iOS notification with alias. If you want to send alert as a Json object, maybe this method is what you needed. If it doesn't received within the delay time,JPush will send a SMS to the corresponding users.

Parameters:

alert - The wrapper of APNs alert.

sms - The SMS content and delay time. If null, sms doesn't work, no effect on Push feature.

extras - The extra params.

alias - The alias list.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendIosNotificationWithAlias

public PushResult sendIosNotificationWithAlias(com.google.gson.JsonObject alert,
                                               Map<String,String> extras,
                                               String... alias)
                                        throws cn.jiguang.common.resp.APIConnectionException,
                                               cn.jiguang.common.resp.APIRequestException

Send an iOS notification with alias. If you want to send alert as a Json object, maybe this method is what you needed.

Parameters:

alert - The JSON object of APNs alert.

extras - The extra params.

alias - The alias list.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendIosNotificationWithAlias

public PushResult sendIosNotificationWithAlias(com.google.gson.JsonObject alert,
                                               SMS sms,
                                               Map<String,String> extras,
                                               String... alias)
                                        throws cn.jiguang.common.resp.APIConnectionException,
                                               cn.jiguang.common.resp.APIRequestException

Send an iOS notification with alias. If you want to send alert as a Json object, maybe this method is what you needed. If it doesn't received within the delay time,JPush will send a SMS to the corresponding users.

Parameters:

alert - The JSON object of APNs alert.

sms - The SMS content and delay time. If null, sms doesn't work, no effect on Push feature.

extras - The extra params.

alias - The alias list.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendIosNotificationWithRegistrationID

public PushResult sendIosNotificationWithRegistrationID(String alert,
                                                        Map<String,String> extras,
                                                        String... registrationID)
                                                 throws cn.jiguang.common.resp.APIConnectionException,
                                                        cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

sendIosNotificationWithRegistrationID

public PushResult sendIosNotificationWithRegistrationID(String alert,
                                                        SMS sms,
                                                        Map<String,String> extras,
                                                        String... registrationID)
                                                 throws cn.jiguang.common.resp.APIConnectionException,
                                                        cn.jiguang.common.resp.APIRequestException

Send an iOS notification with registrationIds. If it doesn't received within the delay time,JPush will send a SMS to the corresponding users.

Parameters:

alert - The notification content.

sms - The SMS content and delay time. If null, sms doesn't work, no effect on Push feature.

extras - The extra params.

registrationID - The alias list.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendIosNotificationWithRegistrationID

public PushResult sendIosNotificationWithRegistrationID(IosAlert alert,
                                                        Map<String,String> extras,
                                                        String... registrationID)
                                                 throws cn.jiguang.common.resp.APIConnectionException,
                                                        cn.jiguang.common.resp.APIRequestException

Send an iOS notification with registrationIds. If you want to send alert as a Json object, maybe this method is what you needed.

Parameters:

alert - The wrapper of APNs alert.

extras - The extra params.

registrationID - The registration ids.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendIosNotificationWithRegistrationID

public PushResult sendIosNotificationWithRegistrationID(IosAlert alert,
                                                        SMS sms,
                                                        Map<String,String> extras,
                                                        String... registrationID)
                                                 throws cn.jiguang.common.resp.APIConnectionException,
                                                        cn.jiguang.common.resp.APIRequestException

Send an iOS notification with registrationIds. If you want to send alert as a Json object, maybe this method is what you needed. If it doesn't received within the delay time,JPush will send a SMS to the corresponding users.

Parameters:

alert - The wrapper of APNs alert.

sms - The SMS content and delay time. If null, sms doesn't work, no effect on Push feature.

extras - The extra params.

registrationID - The registration ids.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendIosNotificationWithRegistrationID

public PushResult sendIosNotificationWithRegistrationID(com.google.gson.JsonObject alert,
                                                        Map<String,String> extras,
                                                        String... registrationID)
                                                 throws cn.jiguang.common.resp.APIConnectionException,
                                                        cn.jiguang.common.resp.APIRequestException

Send an iOS notification with registrationIds. If you want to send alert as a Json object, maybe this method is what you needed.

Parameters:

alert - The wrapper of APNs alert.

extras - The extra params.

registrationID - The registration ids.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendIosNotificationWithRegistrationID

public PushResult sendIosNotificationWithRegistrationID(com.google.gson.JsonObject alert,
                                                        SMS sms,
                                                        Map<String,String> extras,
                                                        String... registrationID)
                                                 throws cn.jiguang.common.resp.APIConnectionException,
                                                        cn.jiguang.common.resp.APIRequestException

Send an iOS notification with registrationIds. If you want to send alert as a Json object, maybe this method is what you needed. If it doesn't received within the delay time,JPush will send a SMS to the corresponding users.

Parameters:

alert - The JSON object of APNs alert.

sms - The SMS content and delay time. If null, sms doesn't work, no effect on Push feature.

extras - The extra params.

registrationID - The registration ids.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendMessageAll

public PushResult sendMessageAll(String msgContent)
                          throws cn.jiguang.common.resp.APIConnectionException,
                                 cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

sendMessageAll

public PushResult sendMessageAll(String msgContent,
                                 SMS sms)
                          throws cn.jiguang.common.resp.APIConnectionException,
                                 cn.jiguang.common.resp.APIRequestException

Send a message to all If it doesn't received within the delay time,JPush will send a SMS to the corresponding users.

Parameters:

msgContent - The message content.

sms - The SMS content and delay time. If null, sms doesn't work, no effect on Push feature.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendAndroidMessageWithAlias

public PushResult sendAndroidMessageWithAlias(String title,
                                              String msgContent,
                                              String... alias)
                                       throws cn.jiguang.common.resp.APIConnectionException,
                                              cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

sendAndroidMessageWithAlias

public PushResult sendAndroidMessageWithAlias(String title,
                                              String msgContent,
                                              SMS sms,
                                              String... alias)
                                       throws cn.jiguang.common.resp.APIConnectionException,
                                              cn.jiguang.common.resp.APIRequestException

Send an Android message with alias. If it doesn't received within the delay time,JPush will send a SMS to the corresponding users.

Parameters:

title - The message title.

msgContent - The message content.

sms - The SMS content and delay time. If null, sms doesn't work, no effect on Push feature.

alias - The alias list.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendAndroidMessageWithRegistrationID

public PushResult sendAndroidMessageWithRegistrationID(String title,
                                                       String msgContent,
                                                       String... registrationID)
                                                throws cn.jiguang.common.resp.APIConnectionException,
                                                       cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

sendAndroidMessageWithRegistrationID

public PushResult sendAndroidMessageWithRegistrationID(String title,
                                                       String msgContent,
                                                       SMS sms,
                                                       String... registrationID)
                                                throws cn.jiguang.common.resp.APIConnectionException,
                                                       cn.jiguang.common.resp.APIRequestException

Send an Android message with registration id. If it doesn't received within the delay time,JPush will send a SMS to the corresponding users.

Parameters:

title - The message title.

msgContent - The message content.

sms - The SMS content and delay time. If null, sms doesn't work, no effect on Push feature.

registrationID - The registration id list.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendIosMessageWithAlias

public PushResult sendIosMessageWithAlias(String title,
                                          String msgContent,
                                          String... alias)
                                   throws cn.jiguang.common.resp.APIConnectionException,
                                          cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

sendIosMessageWithAlias

public PushResult sendIosMessageWithAlias(String title,
                                          String msgContent,
                                          SMS sms,
                                          String... alias)
                                   throws cn.jiguang.common.resp.APIConnectionException,
                                          cn.jiguang.common.resp.APIRequestException

Send an iOS message with alias. If it doesn't received within the delay time,JPush will send a SMS to the corresponding users.

Parameters:

title - The message title.

msgContent - The message content.

sms - The SMS content and delay time. If null, sms doesn't work, no effect on Push feature.

alias - The alias list.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendIosMessageWithRegistrationID

public PushResult sendIosMessageWithRegistrationID(String title,
                                                   String msgContent,
                                                   String... registrationID)
                                            throws cn.jiguang.common.resp.APIConnectionException,
                                                   cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

sendIosMessageWithRegistrationID

public PushResult sendIosMessageWithRegistrationID(String title,
                                                   String msgContent,
                                                   SMS sms,
                                                   String... registrationID)
                                            throws cn.jiguang.common.resp.APIConnectionException,
                                                   cn.jiguang.common.resp.APIRequestException

Send an iOS message with registration id. If it doesn't received within the delay time,JPush will send a SMS to the corresponding users.

Parameters:

title - The message title.

msgContent - The message content.

sms - The SMS content and delay time. If null, sms doesn't work, no effect on Push feature.

registrationID - The registrationIds generated by JPush.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

sendMessageWithRegistrationID

public PushResult sendMessageWithRegistrationID(String title,
                                                String msgContent,
                                                String... registrationID)
                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

sendMessageWithRegistrationID

public PushResult sendMessageWithRegistrationID(String title,
                                                String msgContent,
                                                SMS sms,
                                                String... registrationID)
                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                cn.jiguang.common.resp.APIRequestException

Send a message with registrationIds. If it doesn't received within the delay time,JPush will send a SMS to the corresponding users.

Parameters:

title - The message title.

msgContent - The message content.

sms - The SMS content and delay time. If null, sms doesn't work, no effect on Push feature.

registrationID - The registrationIds generated by JPush.

Returns:

push result.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

deletePush

public cn.jiguang.common.resp.DefaultResult deletePush(String msgId)
                                                throws cn.jiguang.common.resp.APIConnectionException,
                                                       cn.jiguang.common.resp.APIRequestException

Delete a push by msgId.

Parameters:

msgId - The message id

Returns:

delete result

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs

getDeviceTagAlias

public TagAliasResult getDeviceTagAlias(String registrationId)
                                 throws cn.jiguang.common.resp.APIConnectionException,
                                        cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

updateDeviceTagAlias

public cn.jiguang.common.resp.DefaultResult updateDeviceTagAlias(String registrationId,
                                                                 boolean clearAlias,
                                                                 boolean clearTag)
                                                          throws cn.jiguang.common.resp.APIConnectionException,
                                                                 cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

updateDeviceTagAlias

public cn.jiguang.common.resp.DefaultResult updateDeviceTagAlias(String registrationId,
                                                                 String alias,
                                                                 Set<String> tagsToAdd,
                                                                 Set<String> tagsToRemove)
                                                          throws cn.jiguang.common.resp.APIConnectionException,
                                                                 cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getTagList

public TagListResult getTagList()
                         throws cn.jiguang.common.resp.APIConnectionException,
                                cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

isDeviceInTag

public cn.jiguang.common.resp.BooleanResult isDeviceInTag(String theTag,
                                                          String registrationID)
                                                   throws cn.jiguang.common.resp.APIConnectionException,
                                                          cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

addRemoveDevicesFromTag

public cn.jiguang.common.resp.DefaultResult addRemoveDevicesFromTag(String theTag,
                                                                    Set<String> toAddUsers,
                                                                    Set<String> toRemoveUsers)
                                                             throws cn.jiguang.common.resp.APIConnectionException,
                                                                    cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

deleteTag

public cn.jiguang.common.resp.DefaultResult deleteTag(String theTag,
                                                      String platform)
                                               throws cn.jiguang.common.resp.APIConnectionException,
                                                      cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getAliasDeviceList

public AliasDeviceListResult getAliasDeviceList(String alias,
                                                String platform)
                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

deleteAlias

public cn.jiguang.common.resp.DefaultResult deleteAlias(String alias,
                                                        String platform)
                                                 throws cn.jiguang.common.resp.APIConnectionException,
                                                        cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

removeDevicesFromAlias

public cn.jiguang.common.resp.DefaultResult removeDevicesFromAlias(String alias,
                                                                   Set<String> toRemoveDevice)
                                                            throws cn.jiguang.common.resp.APIConnectionException,
                                                                   cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getUserOnlineStatus

public Map<String,OnlineStatus> getUserOnlineStatus(String... registrationIds)
                                             throws cn.jiguang.common.resp.APIConnectionException,
                                                    cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

bindMobile

public cn.jiguang.common.resp.DefaultResult bindMobile(String registrationId,
                                                       String mobile)
                                                throws cn.jiguang.common.resp.APIConnectionException,
                                                       cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

createSingleSchedule

public ScheduleResult createSingleSchedule(String name,
                                           String time,
                                           PushPayload push,
                                           String masterSecret,
                                           String appKey)
                                    throws cn.jiguang.common.resp.APIConnectionException,
                                           cn.jiguang.common.resp.APIRequestException

Create a single schedule.

Parameters:

name - The schedule name.

time - The push time, format is 'yyyy-MM-dd HH:mm:ss'

push - The push payload.

masterSecret - master secret

appKey - app key

Returns:

The created scheduleResult instance.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

createDailySchedule

public ScheduleResult createDailySchedule(String name,
                                          String start,
                                          String end,
                                          String time,
                                          PushPayload push,
                                          String masterSecret,
                                          String appKey)
                                   throws cn.jiguang.common.resp.APIConnectionException,
                                          cn.jiguang.common.resp.APIRequestException

Create a daily schedule push everyday.

Parameters:

name - The schedule name.

start - The schedule comes into effect date, format 'yyyy-MM-dd HH:mm:ss'.

end - The schedule expiration date, format 'yyyy-MM-dd HH:mm:ss'.

time - The push time, format 'HH:mm:ss'

push - The push payload.

masterSecret - master secret

appKey - app key

Returns:

The created scheduleResult instance.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

createDailySchedule

public ScheduleResult createDailySchedule(String name,
                                          String start,
                                          String end,
                                          String time,
                                          int frequency,
                                          PushPayload push,
                                          String masterSecret,
                                          String appKey)
                                   throws cn.jiguang.common.resp.APIConnectionException,
                                          cn.jiguang.common.resp.APIRequestException

Create a daily schedule push with a custom frequency.

Parameters:

name - The schedule name.

start - The schedule comes into effect date, format 'yyyy-MM-dd HH:mm:ss'.

end - The schedule expiration date, format 'yyyy-MM-dd HH:mm:ss'.

time - The push time, format 'HH:mm:ss'

frequency - The custom frequency.

push - The push payload.

masterSecret - master secret

appKey - app key

Returns:

The created scheduleResult instance.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

createWeeklySchedule

public ScheduleResult createWeeklySchedule(String name,
                                           String start,
                                           String end,
                                           String time,
                                           cn.jiguang.common.Week[] days,
                                           PushPayload push,
                                           String masterSecret,
                                           String appKey)
                                    throws cn.jiguang.common.resp.APIConnectionException,
                                           cn.jiguang.common.resp.APIRequestException

Create a weekly schedule push every week at the appointed days.

Parameters:

name - The schedule name.

start - The schedule comes into effect date, format 'yyyy-MM-dd HH:mm:ss'.

end - The schedule expiration date, format 'yyyy-MM-dd HH:mm:ss'.

time - The push time, format 'HH:mm:ss'

days - The appointed days.

push - The push payload.

masterSecret - master secret

appKey - app key

Returns:

The created scheduleResult instance.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

createWeeklySchedule

public ScheduleResult createWeeklySchedule(String name,
                                           String start,
                                           String end,
                                           String time,
                                           int frequency,
                                           cn.jiguang.common.Week[] days,
                                           PushPayload push,
                                           String masterSecret,
                                           String appKey)
                                    throws cn.jiguang.common.resp.APIConnectionException,
                                           cn.jiguang.common.resp.APIRequestException

Create a weekly schedule push with a custom frequency at the appointed days.

Parameters:

name - The schedule name.

start - The schedule comes into effect date, format 'yyyy-MM-dd HH:mm:ss'.

end - The schedule expiration date, format 'yyyy-MM-dd HH:mm:ss'.

time - The push time, format 'HH:mm:ss'.

frequency - The custom frequency.

days - The appointed days.

push - The push payload.

masterSecret - master secret

appKey - app key

Returns:

The created scheduleResult instance.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

createMonthlySchedule

public ScheduleResult createMonthlySchedule(String name,
                                            String start,
                                            String end,
                                            String time,
                                            String[] points,
                                            PushPayload push,
                                            String masterSecret,
                                            String appKey)
                                     throws cn.jiguang.common.resp.APIConnectionException,
                                            cn.jiguang.common.resp.APIRequestException

Create a monthly schedule push every month at the appointed days.

Parameters:

name - The schedule name.

start - The schedule comes into effect date, format 'yyyy-MM-dd HH:mm:ss'.

end - The schedule expiration date, format 'yyyy-MM-dd HH:mm:ss'.

time - The push time, format 'HH:mm:ss'.

points - The appointed days.

push - The push payload.

masterSecret - master secret

appKey - app key

Returns:

The created scheduleResult instance.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

createMonthlySchedule

public ScheduleResult createMonthlySchedule(String name,
                                            String start,
                                            String end,
                                            String time,
                                            int frequency,
                                            String[] points,
                                            PushPayload push,
                                            String masterSecret,
                                            String appKey)
                                     throws cn.jiguang.common.resp.APIConnectionException,
                                            cn.jiguang.common.resp.APIRequestException

Create a monthly schedule push with a custom frequency at the appointed days.

Parameters:

name - The schedule name.

start - The schedule comes into effect date, format 'yyyy-MM-dd HH:mm:ss'.

end - The schedule expiration date, format 'yyyy-MM-dd HH:mm:ss'.

time - The push time, format 'HH:mm:ss'.

frequency - The custom frequency.

points - The appointed days.

push - The push payload.

masterSecret - master secret

appKey - app key

Returns:

The created scheduleResult instance.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

getSchedule

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

Get the schedule information by the schedule id.

Parameters:

scheduleId - The schedule id.

Returns:

The schedule information.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

getScheduleMsgIds

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

Get the message id by the schedule id.

Parameters:

scheduleId - The schedule id.

Returns:

The message id list.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

getScheduleList

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

Get the schedule list size and the first page.

Returns:

The schedule list size and the first page.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

getScheduleList

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

Get the schedule list by the page.

Parameters:

page - The page to search.

Returns:

The schedule list of the appointed page.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

updateScheduleName

public ScheduleResult updateScheduleName(String scheduleId,
                                         String name)
                                  throws cn.jiguang.common.resp.APIConnectionException,
                                         cn.jiguang.common.resp.APIRequestException

Update the schedule name

Parameters:

scheduleId - The schedule id.

name - The new name.

Returns:

The schedule information after updated.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

enableSchedule

public ScheduleResult enableSchedule(String scheduleId)
                              throws cn.jiguang.common.resp.APIConnectionException,
                                     cn.jiguang.common.resp.APIRequestException

Enable the schedule.

Parameters:

scheduleId - The schedule id.

Returns:

The schedule information after updated.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

disableSchedule

public ScheduleResult disableSchedule(String scheduleId)
                               throws cn.jiguang.common.resp.APIConnectionException,
                                      cn.jiguang.common.resp.APIRequestException

Disable the schedule.

Parameters:

scheduleId - The schedule id.

Returns:

The schedule information after updated.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

updateScheduleTrigger

public ScheduleResult updateScheduleTrigger(String scheduleId,
                                            TriggerPayload trigger)
                                     throws cn.jiguang.common.resp.APIConnectionException,
                                            cn.jiguang.common.resp.APIRequestException

Update the trigger of the schedule.

Parameters:

scheduleId - The schedule id.

trigger - The new trigger.

Returns:

The schedule information after updated.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

updateSchedulePush

public ScheduleResult updateSchedulePush(String scheduleId,
                                         PushPayload push)
                                  throws cn.jiguang.common.resp.APIConnectionException,
                                         cn.jiguang.common.resp.APIRequestException

Update the push content of the schedule.

Parameters:

scheduleId - The schedule id.

push - The new push payload.

Returns:

The schedule information after updated.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

updateSchedule

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

Update a schedule by the id.

Parameters:

scheduleId - The schedule id to update.

payload - The new schedule payload.

Returns:

The new schedule information.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

deleteSchedule

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

Delete a schedule by id.

Parameters:

scheduleId - The schedule id.

Throws:

cn.jiguang.common.resp.APIConnectionException - if a remote or network exception occurs.

cn.jiguang.common.resp.APIRequestException - if a request exception occurs.

close

public void close()