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

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:

• https://zulip.com/api/register-queue

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALL_PUBLIC_STREAMS
static final String	EVENT_TYPES
static final String	FETCH_EVENT_TYPES
static final String[]	FETCHED_EVENTS
static final String[]	MONITORED_EVENTS
static final String	NARROW

Constructor Summary

Constructors

Constructor	Description
RegisterEventQueueApiRequest(ZulipHttpClient client, Narrow... narrows)	Constructs a ZulipApiRequest.

Method Summary

Modifier and Type	Method	Description
EventQueue	execute()	Executes the Zulip API request for registering an event queue.
RegisterEventQueueApiRequest	withAllPublicStreams(boolean allPublicStreams)	Whether to request message events from all public channels.

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

ALL_PUBLIC_STREAMS

public static final String ALL_PUBLIC_STREAMS

See Also:

• Constant Field Values

EVENT_TYPES

public static final String EVENT_TYPES

See Also:

• Constant Field Values

FETCH_EVENT_TYPES

public static final String FETCH_EVENT_TYPES

See Also:

• Constant Field Values

FETCHED_EVENTS

public static final String[] FETCHED_EVENTS

NARROW

public static final String NARROW

See Also:

• Constant Field Values

MONITORED_EVENTS

public static final String[] MONITORED_EVENTS

Constructor Details

RegisterEventQueueApiRequest

public RegisterEventQueueApiRequest(ZulipHttpClient client,
 Narrow... narrows)

Constructs a ZulipApiRequest.

Parameters:

client - The Zulip HTTP client

narrows - optional Narrow expressions to filter which message events are captured. E.g messages from a specific stream

Method Details

withAllPublicStreams

public RegisterEventQueueApiRequest withAllPublicStreams(boolean allPublicStreams)

Whether to request message events from all public channels.

Parameters:

allPublicStreams - true to request message events from all public channels. false to not include message events from all public channels

Returns:

This RegisterEventQueueApiRequest instance

execute

public EventQueue execute()
                   throws ZulipClientException

Executes the Zulip API request for registering an event queue.

Specified by:

execute in interface ExecutableApiRequest<EventQueue>

Returns:

the created EventQueue

Throws:

ZulipClientException - if the request was not successful