Class RegisterEventQueueApiRequest
java.lang.Object
com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest
com.github.jamesnetherton.zulip.client.api.event.request.RegisterEventQueueApiRequest
- All Implemented Interfaces:
ExecutableApiRequest<EventQueue>
public class RegisterEventQueueApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<EventQueue>
Zulip API request builder for registering an event queue.
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionRegisterEventQueueApiRequest(ZulipHttpClient client, Narrow... narrows) Constructs aZulipApiRequest. -
Method Summary
Modifier and TypeMethodDescriptionexecute()Executes the Zulip API request for registering an event queue.withAllPublicStreams(boolean allPublicStreams) Whether to request message events from all public channels.withEventTypes(Collection<String> eventTypes) Sets the event types to receive.withIdleQueueTimeout(int idleQueueTimeoutSeconds) Sets the minimum number of seconds that the server should keep the event queue alive when it is not being polled.Methods inherited from class ZulipApiRequest
client, getParam, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject
-
Field Details
-
ALL_PUBLIC_STREAMS
- See Also:
-
CLIENT_CAPABILITIES
- See Also:
-
EVENT_TYPES
- See Also:
-
FETCH_EVENT_TYPES
- See Also:
-
FETCHED_EVENTS
-
IDLE_QUEUE_TIMEOUT
- See Also:
-
NARROW
- See Also:
-
MONITORED_EVENTS
-
-
Constructor Details
-
RegisterEventQueueApiRequest
Constructs aZulipApiRequest.- Parameters:
client- The Zulip HTTP clientnarrows- optionalNarrowexpressions to filter which message events are captured. E.g messages from a specific stream
-
-
Method Details
-
withEventTypes
Sets the event types to receive.- Parameters:
eventTypes- The event type names to receive. E.g.message,reaction- Returns:
- This
RegisterEventQueueApiRequestinstance
-
withIdleQueueTimeout
Sets the minimum number of seconds that the server should keep the event queue alive when it is not being polled.- Parameters:
idleQueueTimeoutSeconds- The idle queue timeout in seconds- Returns:
- This
RegisterEventQueueApiRequestinstance
-
withAllPublicStreams
Whether to request message events from all public channels.- Parameters:
allPublicStreams-trueto request message events from all public channels.falseto not include message events from all public channels- Returns:
- This
RegisterEventQueueApiRequestinstance
-
execute
Executes the Zulip API request for registering an event queue.- Specified by:
executein interfaceExecutableApiRequest<EventQueue>- Returns:
- the created
EventQueue - Throws:
ZulipClientException- if the request was not successful
-