cn.jpush.api

类 JPushClient

java.lang.Object

cn.jpush.api.JPushClient

public class JPushClient
extends Object

The global entrance of JPush API library.

构造器概要

构造器

构造器和说明
JPushClient(String masterSecret, String appKey) Create a JPush Client.
JPushClient(String masterSecret, String appKey, boolean apnsProduction, long timeToLive) 已过时。
JPushClient(String masterSecret, String appKey, HttpProxy proxy, ClientConfig conf) Create a JPush Client by custom Client configuration.
JPushClient(String masterSecret, String appKey, int maxRetryTimes) 已过时。
JPushClient(String masterSecret, String appKey, int maxRetryTimes, HttpProxy proxy) 已过时。
JPushClient(String masterSecret, String appKey, int maxRetryTimes, HttpProxy proxy, ClientConfig conf) 已过时。
JPushClient(String masterSecret, String appKey, int maxRetryTimes, HttpProxy proxy, ClientConfig conf, boolean apnsProduction, long timeToLive) 已过时。

方法概要

方法

限定符和类型	方法和说明
DefaultResult	addRemoveDevicesFromTag(String theTag, Set<String> toAddUsers, Set<String> toRemoveUsers)
DefaultResult	bindMobile(String registrationId, String mobile)
ScheduleResult	createDailySchedule(String name, String start, String end, String time, int frequency, PushPayload push) Create a daily schedule push with a custom frequency.
ScheduleResult	createDailySchedule(String name, String start, String end, String time, PushPayload push) Create a daily schedule push everyday.
ScheduleResult	createMonthlySchedule(String name, String start, String end, String time, int frequency, String[] points, PushPayload push) 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) Create a monthly schedule push every month at the appointed days.
ScheduleResult	createSingleSchedule(String name, String time, PushPayload push) Create a single schedule.
ScheduleResult	createWeeklySchedule(String name, String start, String end, String time, int frequency, Week[] days, PushPayload push) Create a weekly schedule push with a custom frequency at the appointed days.
ScheduleResult	createWeeklySchedule(String name, String start, String end, String time, Week[] days, PushPayload push) Create a weekly schedule push every week at the appointed days.
DefaultResult	deleteAlias(String alias, String platform)
void	deleteSchedule(String scheduleId) Delete a schedule by id.
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)
TagAliasResult	getDeviceTagAlias(String registrationId)
MessagesResult	getReportMessages(String msgIds)
ReceivedsResult	getReportReceiveds(String msgIds) Get received report.
UsersResult	getReportUsers(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.
TagListResult	getTagList()
Map<String,OnlineStatus>	getUserOnlineStatus(String... registrationIds)
BooleanResult	isDeviceInTag(String theTag, String registrationID)
PushResult	sendAndroidMessageWithAlias(String title, String msgContent, SMS sms, String... alias) Send an Android message with alias.
PushResult	sendAndroidMessageWithAlias(String title, String msgContent, String... alias) Shortcut
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) Shortcut
PushResult	sendAndroidNotificationWithAlias(String title, String alert, Map<String,String> extras, String... alias) Shortcut
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) Shortcut
PushResult	sendAndroidNotificationWithRegistrationID(String title, String alert, SMS sms, Map<String,String> extras, String... registrationID) Send a notification to Android with RegistrationID.
PushResult	sendIosMessageWithAlias(String title, String msgContent, SMS sms, String... alias) Send an iOS message with alias.
PushResult	sendIosMessageWithAlias(String title, String msgContent, String... alias) Shortcut
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) Shortcut
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) Shortcut
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) Shortcut
PushResult	sendIosNotificationWithRegistrationID(String alert, SMS sms, Map<String,String> extras, String... registrationID) Send an iOS notification with registrationIds.
PushResult	sendMessageAll(String msgContent) Shortcut
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) Shortcut
PushResult	sendNotificationAll(String alert) Shortcut
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 paylaod) Validate a push action, but do NOT send it actually.
PushResult	sendPushValidate(String payloadString)
DefaultResult	updateDeviceTagAlias(String registrationId, boolean clearAlias, boolean clearTag)
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.

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

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

构造器详细资料

JPushClient

public JPushClient(String masterSecret,
           String appKey)

Create a JPush Client.

参数:

masterSecret - API access secret of the appKey.

appKey - The KEY of one application on JPush.

JPushClient

public JPushClient(String masterSecret,
           String appKey,
           HttpProxy proxy,
           ClientConfig conf)

Create a JPush Client by custom Client configuration.

参数:

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)

已过时。

This will be removed in the future. Please use ClientConfigClientConfig.setMaxRetryTimes(int) instead of this constructor.

JPushClient

@Deprecated
public JPushClient(String masterSecret,
                      String appKey,
                      int maxRetryTimes,
                      HttpProxy proxy)

已过时。

This will be removed in the future. Please use ClientConfigClientConfig.setMaxRetryTimes(int) instead of this constructor.

JPushClient

@Deprecated
public JPushClient(String masterSecret,
                      String appKey,
                      int maxRetryTimes,
                      HttpProxy proxy,
                      ClientConfig conf)

已过时。

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 ClientConfigClientConfig.setMaxRetryTimes(int) instead of this constructor.

参数:

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,
                      HttpProxy proxy,
                      ClientConfig conf,
                      boolean apnsProduction,
                      long timeToLive)

已过时。

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 ClientConfigClientConfig.setGlobalPushSetting(boolean, long) instead of this constructor.

参数:

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)

已过时。

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 ClientConfigClientConfig.setGlobalPushSetting(boolean, long) instead of this constructor.

参数:

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.

方法详细资料

sendPush

public PushResult sendPush(PushPayload pushPayload)
                    throws APIConnectionException,
                           APIRequestException

Send a push with PushPayload object.

参数:

pushPayload - payload object of a push.

返回:

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

抛出:

APIConnectionException

APIRequestException

sendPush

public PushResult sendPush(String payloadString)
                    throws APIConnectionException,
                           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.

参数:

payloadString - payload of a push.

返回:

PushResult. Can be printed to a JSON.

抛出:

APIConnectionException

APIRequestException

sendPushValidate

public PushResult sendPushValidate(PushPayload paylaod)
                            throws APIConnectionException,
                                   APIRequestException

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

参数:

paylaod -

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendPushValidate

public PushResult sendPushValidate(String payloadString)
                            throws APIConnectionException,
                                   APIRequestException

抛出:

APIConnectionException

APIRequestException

getReportReceiveds

public ReceivedsResult getReportReceiveds(String msgIds)
                                   throws APIConnectionException,
                                          APIRequestException

Get received report.

参数:

msgIds - 100 msgids to batch getting is supported.

返回:

ReceivedResult. Can be printed to JSON.

抛出:

APIConnectionException

APIRequestException

getReportUsers

public UsersResult getReportUsers(TimeUnit timeUnit,
                         String start,
                         int duration)
                           throws APIConnectionException,
                                  APIRequestException

抛出:

APIConnectionException

APIRequestException

getReportMessages

public MessagesResult getReportMessages(String msgIds)
                                 throws APIConnectionException,
                                        APIRequestException

抛出:

APIConnectionException

APIRequestException

sendNotificationAll

public PushResult sendNotificationAll(String alert)
                               throws APIConnectionException,
                                      APIRequestException

Shortcut

抛出:

APIConnectionException

APIRequestException

sendNotificationAll

public PushResult sendNotificationAll(String alert,
                             SMS sms)
                               throws APIConnectionException,
                                      APIRequestException

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

参数:

alert - The notification content.

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

返回:

push result

抛出:

APIConnectionException

APIRequestException

sendAndroidNotificationWithAlias

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

Shortcut

抛出:

APIConnectionException

APIRequestException

sendAndroidNotificationWithAlias

public PushResult sendAndroidNotificationWithAlias(String title,
                                          String alert,
                                          SMS sms,
                                          Map<String,String> extras,
                                          String... alias)
                                            throws APIConnectionException,
                                                   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.

参数:

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.

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendAndroidNotificationWithRegistrationID

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

Shortcut

抛出:

APIConnectionException

APIRequestException

sendAndroidNotificationWithRegistrationID

public PushResult sendAndroidNotificationWithRegistrationID(String title,
                                                   String alert,
                                                   SMS sms,
                                                   Map<String,String> extras,
                                                   String... registrationID)
                                                     throws APIConnectionException,
                                                            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.

参数:

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.

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendIosNotificationWithAlias

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

Shortcut

抛出:

APIConnectionException

APIRequestException

sendIosNotificationWithAlias

public PushResult sendIosNotificationWithAlias(String alert,
                                      SMS sms,
                                      Map<String,String> extras,
                                      String... alias)
                                        throws APIConnectionException,
                                               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.

参数:

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.

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendIosNotificationWithAlias

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

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

参数:

alert - The wrapper of APNs alert.

extras - The extra params.

alias - The alias list.

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendIosNotificationWithAlias

public PushResult sendIosNotificationWithAlias(IosAlert alert,
                                      SMS sms,
                                      Map<String,String> extras,
                                      String... alias)
                                        throws APIConnectionException,
                                               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.

参数:

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.

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendIosNotificationWithAlias

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

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

参数:

alert - The JSON object of APNs alert.

extras - The extra params.

alias - The alias list.

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendIosNotificationWithAlias

public PushResult sendIosNotificationWithAlias(com.google.gson.JsonObject alert,
                                      SMS sms,
                                      Map<String,String> extras,
                                      String... alias)
                                        throws APIConnectionException,
                                               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.

参数:

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.

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendIosNotificationWithRegistrationID

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

Shortcut

抛出:

APIConnectionException

APIRequestException

sendIosNotificationWithRegistrationID

public PushResult sendIosNotificationWithRegistrationID(String alert,
                                               SMS sms,
                                               Map<String,String> extras,
                                               String... registrationID)
                                                 throws APIConnectionException,
                                                        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.

参数:

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.

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendIosNotificationWithRegistrationID

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

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

参数:

alert - The wrapper of APNs alert.

extras - The extra params.

registrationID - The registration ids.

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendIosNotificationWithRegistrationID

public PushResult sendIosNotificationWithRegistrationID(IosAlert alert,
                                               SMS sms,
                                               Map<String,String> extras,
                                               String... registrationID)
                                                 throws APIConnectionException,
                                                        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.

参数:

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.

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendIosNotificationWithRegistrationID

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

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

参数:

alert - The wrapper of APNs alert.

extras - The extra params.

registrationID - The registration ids.

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendIosNotificationWithRegistrationID

public PushResult sendIosNotificationWithRegistrationID(com.google.gson.JsonObject alert,
                                               SMS sms,
                                               Map<String,String> extras,
                                               String... registrationID)
                                                 throws APIConnectionException,
                                                        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.

参数:

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.

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendMessageAll

public PushResult sendMessageAll(String msgContent)
                          throws APIConnectionException,
                                 APIRequestException

Shortcut

抛出:

APIConnectionException

APIRequestException

sendMessageAll

public PushResult sendMessageAll(String msgContent,
                        SMS sms)
                          throws APIConnectionException,
                                 APIRequestException

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

参数:

msgContent - The message content.

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

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendAndroidMessageWithAlias

public PushResult sendAndroidMessageWithAlias(String title,
                                     String msgContent,
                                     String... alias)
                                       throws APIConnectionException,
                                              APIRequestException

Shortcut

抛出:

APIConnectionException

APIRequestException

sendAndroidMessageWithAlias

public PushResult sendAndroidMessageWithAlias(String title,
                                     String msgContent,
                                     SMS sms,
                                     String... alias)
                                       throws APIConnectionException,
                                              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.

参数:

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.

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendAndroidMessageWithRegistrationID

public PushResult sendAndroidMessageWithRegistrationID(String title,
                                              String msgContent,
                                              String... registrationID)
                                                throws APIConnectionException,
                                                       APIRequestException

Shortcut

抛出:

APIConnectionException

APIRequestException

sendAndroidMessageWithRegistrationID

public PushResult sendAndroidMessageWithRegistrationID(String title,
                                              String msgContent,
                                              SMS sms,
                                              String... registrationID)
                                                throws APIConnectionException,
                                                       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.

参数:

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.

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendIosMessageWithAlias

public PushResult sendIosMessageWithAlias(String title,
                                 String msgContent,
                                 String... alias)
                                   throws APIConnectionException,
                                          APIRequestException

Shortcut

抛出:

APIConnectionException

APIRequestException

sendIosMessageWithAlias

public PushResult sendIosMessageWithAlias(String title,
                                 String msgContent,
                                 SMS sms,
                                 String... alias)
                                   throws APIConnectionException,
                                          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.

参数:

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.

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendIosMessageWithRegistrationID

public PushResult sendIosMessageWithRegistrationID(String title,
                                          String msgContent,
                                          String... registrationID)
                                            throws APIConnectionException,
                                                   APIRequestException

Shortcut

抛出:

APIConnectionException

APIRequestException

sendIosMessageWithRegistrationID

public PushResult sendIosMessageWithRegistrationID(String title,
                                          String msgContent,
                                          SMS sms,
                                          String... registrationID)
                                            throws APIConnectionException,
                                                   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.

参数:

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.

返回:

push result.

抛出:

APIConnectionException

APIRequestException

sendMessageWithRegistrationID

public PushResult sendMessageWithRegistrationID(String title,
                                       String msgContent,
                                       String... registrationID)
                                         throws APIConnectionException,
                                                APIRequestException

Shortcut

抛出:

APIConnectionException

APIRequestException

sendMessageWithRegistrationID

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

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

参数:

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.

返回:

push result.

抛出:

APIConnectionException

APIRequestException

getDeviceTagAlias

public TagAliasResult getDeviceTagAlias(String registrationId)
                                 throws APIConnectionException,
                                        APIRequestException

抛出:

APIConnectionException

APIRequestException

updateDeviceTagAlias

public DefaultResult updateDeviceTagAlias(String registrationId,
                                 boolean clearAlias,
                                 boolean clearTag)
                                   throws APIConnectionException,
                                          APIRequestException

抛出:

APIConnectionException

APIRequestException

updateDeviceTagAlias

public DefaultResult updateDeviceTagAlias(String registrationId,
                                 String alias,
                                 Set<String> tagsToAdd,
                                 Set<String> tagsToRemove)
                                   throws APIConnectionException,
                                          APIRequestException

抛出:

APIConnectionException

APIRequestException

getTagList

public TagListResult getTagList()
                         throws APIConnectionException,
                                APIRequestException

抛出:

APIConnectionException

APIRequestException

isDeviceInTag

public BooleanResult isDeviceInTag(String theTag,
                          String registrationID)
                            throws APIConnectionException,
                                   APIRequestException

抛出:

APIConnectionException

APIRequestException

addRemoveDevicesFromTag

public DefaultResult addRemoveDevicesFromTag(String theTag,
                                    Set<String> toAddUsers,
                                    Set<String> toRemoveUsers)
                                      throws APIConnectionException,
                                             APIRequestException

抛出:

APIConnectionException

APIRequestException

deleteTag

public DefaultResult deleteTag(String theTag,
                      String platform)
                        throws APIConnectionException,
                               APIRequestException

抛出:

APIConnectionException

APIRequestException

getAliasDeviceList

public AliasDeviceListResult getAliasDeviceList(String alias,
                                       String platform)
                                         throws APIConnectionException,
                                                APIRequestException

抛出:

APIConnectionException

APIRequestException

deleteAlias

public DefaultResult deleteAlias(String alias,
                        String platform)
                          throws APIConnectionException,
                                 APIRequestException

抛出:

APIConnectionException

APIRequestException

getUserOnlineStatus

public Map<String,OnlineStatus> getUserOnlineStatus(String... registrationIds)
                                             throws APIConnectionException,
                                                    APIRequestException

抛出:

APIConnectionException

APIRequestException

bindMobile

public DefaultResult bindMobile(String registrationId,
                       String mobile)
                         throws APIConnectionException,
                                APIRequestException

抛出:

APIConnectionException

APIRequestException

createSingleSchedule

public ScheduleResult createSingleSchedule(String name,
                                  String time,
                                  PushPayload push)
                                    throws APIConnectionException,
                                           APIRequestException

Create a single schedule.

参数:

name - The schedule name.

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

push - The push payload.

返回:

The created scheduleResult instance.

抛出:

APIConnectionException

APIRequestException

createDailySchedule

public ScheduleResult createDailySchedule(String name,
                                 String start,
                                 String end,
                                 String time,
                                 PushPayload push)
                                   throws APIConnectionException,
                                          APIRequestException

Create a daily schedule push everyday.

参数:

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.

返回:

The created scheduleResult instance.

抛出:

APIConnectionException

APIRequestException

createDailySchedule

public ScheduleResult createDailySchedule(String name,
                                 String start,
                                 String end,
                                 String time,
                                 int frequency,
                                 PushPayload push)
                                   throws APIConnectionException,
                                          APIRequestException

Create a daily schedule push with a custom frequency.

参数:

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.

返回:

The created scheduleResult instance.

抛出:

APIConnectionException

APIRequestException

createWeeklySchedule

public ScheduleResult createWeeklySchedule(String name,
                                  String start,
                                  String end,
                                  String time,
                                  Week[] days,
                                  PushPayload push)
                                    throws APIConnectionException,
                                           APIRequestException

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

参数:

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.

返回:

The created scheduleResult instance.

抛出:

APIConnectionException

APIRequestException

createWeeklySchedule

public ScheduleResult createWeeklySchedule(String name,
                                  String start,
                                  String end,
                                  String time,
                                  int frequency,
                                  Week[] days,
                                  PushPayload push)
                                    throws APIConnectionException,
                                           APIRequestException

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

参数:

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.

返回:

The created scheduleResult instance.

抛出:

APIConnectionException

APIRequestException

createMonthlySchedule

public ScheduleResult createMonthlySchedule(String name,
                                   String start,
                                   String end,
                                   String time,
                                   String[] points,
                                   PushPayload push)
                                     throws APIConnectionException,
                                            APIRequestException

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

参数:

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.

返回:

The created scheduleResult instance.

抛出:

APIConnectionException

APIRequestException

createMonthlySchedule

public ScheduleResult createMonthlySchedule(String name,
                                   String start,
                                   String end,
                                   String time,
                                   int frequency,
                                   String[] points,
                                   PushPayload push)
                                     throws APIConnectionException,
                                            APIRequestException

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

参数:

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.

返回:

The created scheduleResult instance.

抛出:

APIConnectionException

APIRequestException

getSchedule

public ScheduleResult getSchedule(String scheduleId)
                           throws APIConnectionException,
                                  APIRequestException

Get the schedule information by the schedule id.

参数:

scheduleId - The schedule id.

返回:

The schedule information.

抛出:

APIConnectionException

APIRequestException

getScheduleList

public ScheduleListResult getScheduleList()
                                   throws APIConnectionException,
                                          APIRequestException

Get the schedule list size and the first page.

返回:

The schedule list size and the first page.

抛出:

APIConnectionException

APIRequestException

getScheduleList

public ScheduleListResult getScheduleList(int page)
                                   throws APIConnectionException,
                                          APIRequestException

Get the schedule list by the page.

参数:

page - The page to search.

返回:

The schedule list of the appointed page.

抛出:

APIConnectionException

APIRequestException

updateScheduleName

public ScheduleResult updateScheduleName(String scheduleId,
                                String name)
                                  throws APIConnectionException,
                                         APIRequestException

Update the schedule name

参数:

scheduleId - The schedule id.

name - The new name.

返回:

The schedule information after updated.

抛出:

APIConnectionException

APIRequestException

enableSchedule

public ScheduleResult enableSchedule(String scheduleId)
                              throws APIConnectionException,
                                     APIRequestException

Enable the schedule.

参数:

scheduleId - The schedule id.

返回:

The schedule information after updated.

抛出:

APIConnectionException

APIRequestException

disableSchedule

public ScheduleResult disableSchedule(String scheduleId)
                               throws APIConnectionException,
                                      APIRequestException

Disable the schedule.

参数:

scheduleId - The schedule id.

返回:

The schedule information after updated.

抛出:

APIConnectionException

APIRequestException

updateScheduleTrigger

public ScheduleResult updateScheduleTrigger(String scheduleId,
                                   TriggerPayload trigger)
                                     throws APIConnectionException,
                                            APIRequestException

Update the trigger of the schedule.

参数:

scheduleId - The schedule id.

trigger - The new trigger.

返回:

The schedule information after updated.

抛出:

APIConnectionException

APIRequestException

updateSchedulePush

public ScheduleResult updateSchedulePush(String scheduleId,
                                PushPayload push)
                                  throws APIConnectionException,
                                         APIRequestException

Update the push content of the schedule.

参数:

scheduleId - The schedule id.

push - The new push payload.

返回:

The schedule information after updated.

抛出:

APIConnectionException

APIRequestException

updateSchedule

public ScheduleResult updateSchedule(String scheduleId,
                            SchedulePayload payload)
                              throws APIConnectionException,
                                     APIRequestException

Update a schedule by the id.

参数:

scheduleId - The schedule id to update.

payload - The new schedule payload.

返回:

The new schedule information.

抛出:

APIConnectionException

APIRequestException

deleteSchedule

public void deleteSchedule(String scheduleId)
                    throws APIConnectionException,
                           APIRequestException

Delete a schedule by id.

参数:

scheduleId - The schedule id.

抛出:

APIConnectionException

APIRequestException