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

Class GetMessageRemindersApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.message.request.GetMessageRemindersApiRequest

All Implemented Interfaces:

ExecutableApiRequest<List<MessageReminder>>

public class GetMessageRemindersApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<MessageReminder>>

Zulip API request builder for getting all message reminders for the current user.

See Also:

• https://zulip.com/api/get-reminders

Constructor Summary

Constructors

Constructor	Description
GetMessageRemindersApiRequest(ZulipHttpClient client)	Constructs a GetMessageRemindersApiRequest.

Method Summary

Modifier and Type	Method	Description
List<MessageReminder>	execute()	Executes the Zulip API request for getting all message reminders for the current user.

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

client, getParam, 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

GetMessageRemindersApiRequest

public GetMessageRemindersApiRequest(ZulipHttpClient client)

Constructs a GetMessageRemindersApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

execute

public List<MessageReminder> execute()
                              throws ZulipClientException

Executes the Zulip API request for getting all message reminders for the current user.

Specified by:

execute in interface ExecutableApiRequest<List<MessageReminder>>

Returns:

List of MessageReminder

Throws:

ZulipClientException - if the request was not successful