Package com.github.jamesnetherton.zulip.client.api.user.request

Class AddAlertWordsApiRequest

java.lang.Object

com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

com.github.jamesnetherton.zulip.client.api.user.request.AddAlertWordsApiRequest

All Implemented Interfaces:

ExecutableApiRequest<List<String>>

public class AddAlertWordsApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<String>>

Zulip API request builder for adding user alert words.

See Also:

• https://zulip.com/api/add-alert-words

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALERT_WORDS

Constructor Summary

Constructors

Constructor	Description
AddAlertWordsApiRequest(ZulipHttpClient client, String... alertWords)	Constructs a AddAlertWordsApiRequest.

Method Summary

Modifier and Type	Method	Description
List<String>	execute()	Executes the Zulip API request for adding user alert words.

Methods inherited from class com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

client, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject

Methods inherited from class java.lang.Object

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

Field Details

ALERT_WORDS

public static final String ALERT_WORDS

See Also:

• Constant Field Values

Constructor Details

AddAlertWordsApiRequest

public AddAlertWordsApiRequest(ZulipHttpClient client,
 String... alertWords)

Constructs a AddAlertWordsApiRequest.

Parameters:

client - The Zulip HTTP client

alertWords - Add words (or phrases) to the user's set of configured alert words.

Method Details

execute

public List<String> execute()
                     throws ZulipClientException

Executes the Zulip API request for adding user alert words.

Specified by:

execute in interface ExecutableApiRequest<List<String>>

Returns:

List of user alert word strings

Throws:

ZulipClientException - if the request was not successful