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, cn.jiguang.common.connection.HttpProxy proxy, cn.jiguang.common.ClientConfig conf) Create a Device Client by client configuration.
DeviceClient(String masterSecret, String appKey, int maxRetryTimes) 已过时。
DeviceClient(String masterSecret, String appKey, int maxRetryTimes, cn.jiguang.common.connection.HttpProxy proxy) 已过时。

方法概要

限定符和类型	方法和说明
cn.jiguang.common.resp.DefaultResult	addRemoveDevicesFromTag(String theTag, Set<String> toAddUsers, Set<String> toRemoveUsers)
cn.jiguang.common.resp.DefaultResult	bindMobile(String registrationId, String mobile)
cn.jiguang.common.resp.DefaultResult	deleteAlias(String alias, String platform)
cn.jiguang.common.resp.DefaultResult	deleteTag(String theTag, String platform)
AliasDeviceListResult	getAliasDeviceList(String alias, String platform)
TagAliasResult	getDeviceTagAlias(String registrationId)
TagListResult	getTagList()
Map<String,OnlineStatus>	getUserOnlineStatus(String... registrationIds)
cn.jiguang.common.resp.BooleanResult	isDeviceInTag(String theTag, String registrationID)
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)

从类继承的方法 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 ClientConfig{jiguang-common cn.jiguang.common.ClientConfig#setMaxRetryTimes} instead of this constructor.

参数:

masterSecret - API access secret of the appKey.

appKey - The KEY of one application on JPush.

maxRetryTimes - The max retry times.

DeviceClient

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

已过时。

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

参数:

masterSecret - API access secret of the appKey.

appKey - The KEY of one application on JPush.

maxRetryTimes - The max retry times.

proxy - The HTTP proxy.

DeviceClient

public DeviceClient(String masterSecret,
                    String appKey,
                    cn.jiguang.common.connection.HttpProxy proxy,
                    cn.jiguang.common.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 cn.jiguang.common.resp.APIConnectionException,
                                        cn.jiguang.common.resp.APIRequestException

抛出:

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

抛出:

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

抛出:

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

抛出:

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

抛出:

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

抛出:

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

抛出:

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

抛出:

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

抛出:

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

抛出:

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

抛出:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException