Class GetMessageEventsApiRequest
java.lang.Object
com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest
com.github.jamesnetherton.zulip.client.api.event.request.GetMessageEventsApiRequest
- All Implemented Interfaces:
TimeoutableApiRequest<List<MessageEvent>>
@Deprecated
public class GetMessageEventsApiRequest
extends ZulipApiRequest
implements TimeoutableApiRequest<List<MessageEvent>>
Deprecated.
Zulip API request builder for receiving events from an event queue.
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionexecute(int responseTimeoutSeconds) Deprecated.Executes the Zulip API request for receiving events from an event queue.withLastEventId(long lastEventId) Deprecated.Sets the queue name to events from.withQueueId(String queueId) Deprecated.Sets the id of the queue to receieve events from.Methods inherited from class ZulipApiRequest
client, getParam, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject
-
Field Details
-
QUEUE_ID
-
LAST_EVENT_ID
-
-
Constructor Details
-
GetMessageEventsApiRequest
-
-
Method Details
-
withQueueId
Deprecated.Sets the id of the queue to receieve events from.- Parameters:
queueId- The id of the queue to receive events from- Returns:
- This
GetMessageEventsApiRequestinstance
-
withLastEventId
Deprecated.Sets the queue name to events from.- Parameters:
lastEventId- The event id of the last consumed event- Returns:
- This
GetMessageEventsApiRequestinstance
-
execute
Deprecated.Executes the Zulip API request for receiving events from an event queue.- Specified by:
executein interfaceTimeoutableApiRequest<List<MessageEvent>>- Parameters:
responseTimeoutSeconds- The timeout value in seconds for the response to timeout- Returns:
MessageEventcontaining new messages- Throws:
ZulipClientException- if the request was not successful
-
GetEventsApiRequestinstead