cn.jpush.api.device

类 DeviceClient

java.lang.Object

cn.jpush.api.device.DeviceClient

public class DeviceClient
extends Object

构造器概要

构造器

构造器和说明
DeviceClient(String masterSecret, String appKey)
DeviceClient(String masterSecret, String appKey, HttpProxy proxy, ClientConfig conf) Create a Device Client by client configuration.
DeviceClient(String masterSecret, String appKey, int maxRetryTimes) 已过时。
DeviceClient(String masterSecret, String appKey, int maxRetryTimes, HttpProxy proxy) 已过时。

方法概要

方法

限定符和类型	方法和说明
DefaultResult	addRemoveDevicesFromTag(String theTag, Set<String> toAddUsers, Set<String> toRemoveUsers)
DefaultResult	bindMobile(String registrationId, String mobile)
DefaultResult	deleteAlias(String alias, String platform)
DefaultResult	deleteTag(String theTag, String platform)
AliasDeviceListResult	getAliasDeviceList(String alias, String platform)
TagAliasResult	getDeviceTagAlias(String registrationId)
TagListResult	getTagList()
Map<String,OnlineStatus>	getUserOnlineStatus(String... registrationIds)
BooleanResult	isDeviceInTag(String theTag, String registrationID)
DefaultResult	updateDeviceTagAlias(String registrationId, boolean clearAlias, boolean clearTag)
DefaultResult	updateDeviceTagAlias(String registrationId, String alias, Set<String> tagsToAdd, Set<String> tagsToRemove)

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

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

构造器详细资料

DeviceClient

public DeviceClient(String masterSecret,
            String appKey)

DeviceClient

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

已过时。

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

DeviceClient

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

已过时。

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

DeviceClient

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

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

方法详细资料

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

bindMobile

public DefaultResult bindMobile(String registrationId,
                       String mobile)
                         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