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

Class GetAllAlertWordsApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<List<String>>

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

Zulip API request builder for getting all user alert words.

See Also:

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

Constructor Summary

Constructors

Constructor	Description
GetAllAlertWordsApiRequest(ZulipHttpClient client)	Constructs a GetAllAlertWordsApiRequest.

Method Summary

Modifier and Type	Method	Description
List<String>	execute()	Executes the Zulip API request for getting all 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

Constructor Details

GetAllAlertWordsApiRequest

public GetAllAlertWordsApiRequest(ZulipHttpClient client)

Constructs a GetAllAlertWordsApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

execute

public List<String> execute()
                     throws ZulipClientException

Executes the Zulip API request for getting all 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