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

Class EventPoller

java.lang.Object

com.github.jamesnetherton.zulip.client.api.event.EventPoller

public class EventPoller
extends Object

Polls Zulip for real-time events. At present this is limited to consuming new message events. Note that this implementation is highly experimental and subject to change or removal.

See Also:

• https://zulip.com/api/real-time-events

Constructor Summary

Constructors

Constructor	Description
EventPoller(ZulipHttpClient client, MessageEventListener listener, Narrow[] narrows)	Constructs a EventPoller.
EventPoller(ZulipHttpClient client, MessageEventListener listener, Narrow[] narrows, ExecutorService eventListenerExecutorService)	Constructs a EventPoller.

Method Summary

Modifier and Type	Method	Description
boolean	isStarted()
void	start()	Starts event message polling.
void	stop()	Stops message polling.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EventPoller

public EventPoller(ZulipHttpClient client,
 MessageEventListener listener,
 Narrow[] narrows)

Constructs a EventPoller.

Parameters:

client - The Zulip HTTP client

listener - The MessageEventListener to be invoked on each message event

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

EventPoller

public EventPoller(ZulipHttpClient client,
 MessageEventListener listener,
 Narrow[] narrows,
 ExecutorService eventListenerExecutorService)

Constructs a EventPoller.

Parameters:

client - The Zulip HTTP client

listener - The MessageEventListener to be invoked on each message event

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

eventListenerExecutorService - Custom ExecutorService to use for message event listener execution

Method Details

start

public void start()
           throws ZulipClientException

Starts event message polling.

Throws:

ZulipClientException - if the event polling request was not successful

stop

public void stop()

Stops message polling.

isStarted

public boolean isStarted()