cn.jmessage.api.sensitiveword

Class SensitiveWordClient

java.lang.Object

cn.jmessage.api.common.BaseClient

cn.jmessage.api.sensitiveword.SensitiveWordClient

public class SensitiveWordClient
extends BaseClient

Field Summary

Fields inherited from class cn.jmessage.api.common.BaseClient

_baseUrl, _gson, _httpClient

Constructor Summary

Constructors

Constructor and Description
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

Method Summary

Methods

Modifier and Type	Method and Description
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

Methods inherited from class cn.jmessage.api.common.BaseClient

setHttpClient

Methods inherited from class java.lang.Object

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

Constructor Detail

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

Parameters:

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.

Method Detail

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

Parameters:

words - String array

Returns:

No content

Throws:

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

Parameters:

words - String Set

Returns:

No content

Throws:

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

Parameters:

newWord - new word

oldWord - old word

Returns:

No content

Throws:

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

Parameters:

word - word to be deleted

Returns:

No content

Throws:

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

Parameters:

start - the begin of the list

count - the count of the list

Returns:

SensitiveWordListResult

Throws:

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

Parameters:

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

Returns:

No content

Throws:

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

Returns:

status of sensitive word

Throws:

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

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