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

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>>

public class GetMessageEventsApiRequest
extends ZulipApiRequest
implements TimeoutableApiRequest<List<MessageEvent>>

Zulip API request builder for receiving events from an event queue.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LAST_EVENT_ID
static final String	QUEUE_ID

Constructor Summary

Constructors

Constructor	Description
GetMessageEventsApiRequest(ZulipHttpClient client)	Constructs a ZulipApiRequest.

Method Summary

Modifier and Type	Method	Description
List<MessageEvent>	execute(int responseTimeoutSeconds)	Executes the Zulip API request for receiving events from an event queue.
GetMessageEventsApiRequest	withLastEventId(long lastEventId)	Sets the queue name to events from.
GetMessageEventsApiRequest	withQueueId(String queueId)	Sets the id of the queue to receieve events from.

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

QUEUE_ID

public static final String QUEUE_ID

See Also:

• Constant Field Values

LAST_EVENT_ID

public static final String LAST_EVENT_ID

See Also:

• Constant Field Values

Constructor Details

GetMessageEventsApiRequest

public GetMessageEventsApiRequest(ZulipHttpClient client)

Constructs a ZulipApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

withQueueId

public GetMessageEventsApiRequest withQueueId(String queueId)

Sets the id of the queue to receieve events from.

Parameters:

queueId - The id of the queue to receive events from

Returns:

This GetMessageEventsApiRequest instance

withLastEventId

public GetMessageEventsApiRequest withLastEventId(long lastEventId)

Sets the queue name to events from.

Parameters:

lastEventId - The event id of the last consumed event

Returns:

This GetMessageEventsApiRequest instance

execute

public List<MessageEvent> execute(int responseTimeoutSeconds)
                           throws ZulipClientException

Executes the Zulip API request for receiving events from an event queue.

Specified by:

execute in interface TimeoutableApiRequest<List<MessageEvent>>

Parameters:

responseTimeoutSeconds - The timeout value in seconds for the response to timeout

Returns:

MessageEvent containing new messages

Throws:

ZulipClientException - if the request was not successful