cn.jpush.api.push

类 PushClient

java.lang.Object

cn.jpush.api.push.PushClient

public class PushClient
extends Object

Entrance for sending Push. For the following parameters, you can set them by instance creation. This action will override setting in PushPayload Optional. * apnsProduction If not present, the default is true. * timeToLive If not present, the default is 86400(s) (one day). Can be used directly.

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
PushResult	sendPush(PushPayload pushPayload)
PushResult	sendPush(String payloadString)
PushResult	sendPushValidate(PushPayload pushPayload)
PushResult	sendPushValidate(String payloadString)
void	setBaseUrl(String baseUrl)
void	setDefaults(boolean apnsProduction, long timeToLive) 已过时。

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

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

构造器详细资料

PushClient

public PushClient(String masterSecret,
                  String appKey)

Create a Push Client.

参数:

masterSecret - API access secret of the appKey.

appKey - The KEY of one application on JPush.

PushClient

@Deprecated
public PushClient(String masterSecret,
                               String appKey,
                               int maxRetryTimes)

已过时。

This will be removed in the future. Please use ClientConfigClientConfig instead of this constructor.

参数:

masterSecret - API access secret of the appKey.

appKey - The KEY of one application on JPush.

maxRetryTimes - The max retry times.

PushClient

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

已过时。

Create a Push Client with max retry times. This will be removed in the future. Please use ClientConfigClientConfig instead of this constructor.

参数:

masterSecret - API access secret of the appKey.

appKey - The KEY of one application on JPush.

maxRetryTimes - max retry times

proxy - The max retry times.

PushClient

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

PushClient

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

已过时。

Create a Push 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 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.

方法详细资料

setDefaults

@Deprecated
public void setDefaults(boolean apnsProduction,
                                     long timeToLive)

已过时。

This will be removed in the future. Please use ClientConfigClientConfig.setGlobalPushSetting(boolean, long) instead of this method.

参数:

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

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

setBaseUrl

public void setBaseUrl(String baseUrl)

sendPush

public PushResult sendPush(PushPayload pushPayload)
                    throws APIConnectionException,
                           APIRequestException

抛出:

APIConnectionException

APIRequestException

sendPushValidate

public PushResult sendPushValidate(PushPayload pushPayload)
                            throws APIConnectionException,
                                   APIRequestException

抛出:

APIConnectionException

APIRequestException

sendPush

public PushResult sendPush(String payloadString)
                    throws APIConnectionException,
                           APIRequestException

抛出:

APIConnectionException

APIRequestException

sendPushValidate

public PushResult sendPushValidate(String payloadString)
                            throws APIConnectionException,
                                   APIRequestException

抛出:

APIConnectionException

APIRequestException