cn.jmessage.api.sensitiveword

类 SensitiveWordClient

java.lang.Object

cn.jmessage.api.common.BaseClient

cn.jmessage.api.sensitiveword.SensitiveWordClient

public class SensitiveWordClient
extends BaseClient

字段概要

从类继承的字段 cn.jmessage.api.common.BaseClient

_baseUrl, _gson, _httpClient

构造器概要

构造器

构造器和说明
SensitiveWordClient(java.lang.String appKey, java.lang.String masterSecret)
SensitiveWordClient(java.lang.String appkey, java.lang.String masterSecret, cn.jiguang.common.connection.HttpProxy proxy, JMessageConfig config) Create a JMessage Base Client

方法概要

限定符和类型	方法和说明
cn.jiguang.common.resp.ResponseWrapper	addSensitiveWords(java.util.Set<java.lang.String> words) Add sensitive words
cn.jiguang.common.resp.ResponseWrapper	addSensitiveWords(java.lang.String... words) Add sensitive words
cn.jiguang.common.resp.ResponseWrapper	deleteSensitiveWord(java.lang.String word) Delete sensitive word
SensitiveWordListResult	getSensitiveWordList(int start, int count) Get sensitive word list
SensitiveWordStatusResult	getSensitiveWordStatus() Get sensitive word status
cn.jiguang.common.resp.ResponseWrapper	updateSensitiveWord(java.lang.String newWord, java.lang.String oldWord) Update sensitive word
cn.jiguang.common.resp.ResponseWrapper	updateSensitiveWordStatus(int status) Update sensitive word status

从类继承的方法 cn.jmessage.api.common.BaseClient

setHttpClient

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

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

构造器详细资料

SensitiveWordClient

public SensitiveWordClient(java.lang.String appKey,
                           java.lang.String masterSecret)

SensitiveWordClient

public SensitiveWordClient(java.lang.String appkey,
                           java.lang.String masterSecret,
                           cn.jiguang.common.connection.HttpProxy proxy,
                           JMessageConfig config)

Create a JMessage Base Client

参数:

appkey - The KEY of one application on JPush.

masterSecret - API access secret of the appKey.

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

config - The client configuration. Can use JMessageConfig.getInstance() as default.

方法详细资料

addSensitiveWords

public cn.jiguang.common.resp.ResponseWrapper addSensitiveWords(java.lang.String... words)
                                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                                cn.jiguang.common.resp.APIRequestException

Add sensitive words

参数:

words - String array

返回:

No content

抛出:

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

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

addSensitiveWords

public cn.jiguang.common.resp.ResponseWrapper addSensitiveWords(java.util.Set<java.lang.String> words)
                                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                                cn.jiguang.common.resp.APIRequestException

Add sensitive words

参数:

words - String Set

返回:

No content

抛出:

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

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

updateSensitiveWord

public cn.jiguang.common.resp.ResponseWrapper updateSensitiveWord(java.lang.String newWord,
                                                                  java.lang.String oldWord)
                                                           throws cn.jiguang.common.resp.APIConnectionException,
                                                                  cn.jiguang.common.resp.APIRequestException

Update sensitive word

参数:

newWord - new word

oldWord - old word

返回:

No content

抛出:

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

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

deleteSensitiveWord

public cn.jiguang.common.resp.ResponseWrapper deleteSensitiveWord(java.lang.String word)
                                                           throws cn.jiguang.common.resp.APIConnectionException,
                                                                  cn.jiguang.common.resp.APIRequestException

Delete sensitive word

参数:

word - word to be deleted

返回:

No content

抛出:

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

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

getSensitiveWordList

public SensitiveWordListResult getSensitiveWordList(int start,
                                                    int count)
                                             throws cn.jiguang.common.resp.APIConnectionException,
                                                    cn.jiguang.common.resp.APIRequestException

Get sensitive word list

参数:

start - the begin of the list

count - the count of the list

返回:

SensitiveWordListResult

抛出:

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

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

updateSensitiveWordStatus

public cn.jiguang.common.resp.ResponseWrapper updateSensitiveWordStatus(int status)
                                                                 throws cn.jiguang.common.resp.APIConnectionException,
                                                                        cn.jiguang.common.resp.APIRequestException

Update sensitive word status

参数:

status - 1 represent turn on filtering, 0 represent turn off.

返回:

No content

抛出:

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

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

getSensitiveWordStatus

public SensitiveWordStatusResult getSensitiveWordStatus()
                                                 throws cn.jiguang.common.resp.APIConnectionException,
                                                        cn.jiguang.common.resp.APIRequestException

Get sensitive word status

返回:

status of sensitive word

抛出:

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

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