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

Class GetScheduledMessagesApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<List<ScheduledMessage>>

public class GetScheduledMessagesApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<ScheduledMessage>>

Zulip API request builder for getting scheduled messages for the current user.

See Also:

• https://zulip.com/api/get-scheduled-messages

Constructor Summary

Constructors

Constructor	Description
GetScheduledMessagesApiRequest(ZulipHttpClient client)	Constructs a GetScheduledMessagesApiRequest

Method Summary

Modifier and Type	Method	Description
List<ScheduledMessage>	execute()	Executes the Zulip API request for getting scheduled messages for the current user.

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

GetScheduledMessagesApiRequest

public GetScheduledMessagesApiRequest(ZulipHttpClient client)

Constructs a GetScheduledMessagesApiRequest

Parameters:

client - The Zulip HTTP client

Method Details

execute

public List<ScheduledMessage> execute()
                               throws ZulipClientException

Executes the Zulip API request for getting scheduled messages for the current user.

Specified by:

execute in interface ExecutableApiRequest<List<ScheduledMessage>>

Returns:

List of ScheduledMessage objects

Throws:

ZulipClientException - if the request was not successful