Class EventPollerBuilder
java.lang.Object
com.github.jamesnetherton.zulip.client.api.event.EventPollerBuilder
Builder for configuring an
EventPoller that captures one or more Zulip event types.
Note that Narrow expressions only filter message events. All other event types are received for every
message that the user has access to.- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds theEventPoller.on(EventType eventType, EventListener<Event> listener) Adds a listener for a Zulip event type.on(String eventType, EventListener<Event> listener) Adds a listener for an arbitrary Zulip event type.onDeleteMessage(EventListener<DeleteMessageEvent> listener) Adds a listener for message deletion events.onMessage(EventListener<MessageEvent> listener) Adds a listener for new message events.onReaction(EventListener<ReactionEvent> listener) Adds a listener for message reaction events.onSubmessage(EventListener<SubmessageEvent> listener) Adds a listener for submessage events.onTyping(EventListener<TypingEvent> listener) Adds a listener for typing notification events.Adds a listener for message edit typing notification events.onUpdateMessage(EventListener<UpdateMessageEvent> listener) Adds a listener for message edit events.Adds a listener for message flag update events.withAllPublicStreams(boolean allPublicStreams) Sets whether to request message events from all public channels.withExecutorService(ExecutorService executorService) Sets a custom executor to use for invoking event listeners.withIdleQueueTimeout(int idleQueueTimeoutSeconds) Sets the minimum number of seconds that the server should keep the event queue alive when it is not being polled.withNarrows(Narrow... narrows) Sets theNarrowexpressions to filter which message events are captured.
-
Method Details
-
onMessage
Adds a listener for new message events.- Parameters:
listener- TheEventListenerto be invoked on eachMessageEvent- Returns:
- This
EventPollerBuilderinstance
-
onUpdateMessage
Adds a listener for message edit events.- Parameters:
listener- TheEventListenerto be invoked on eachUpdateMessageEvent- Returns:
- This
EventPollerBuilderinstance
-
onDeleteMessage
Adds a listener for message deletion events.- Parameters:
listener- TheEventListenerto be invoked on eachDeleteMessageEvent- Returns:
- This
EventPollerBuilderinstance
-
onReaction
Adds a listener for message reaction events.- Parameters:
listener- TheEventListenerto be invoked on eachReactionEvent- Returns:
- This
EventPollerBuilderinstance
-
onUpdateMessageFlags
Adds a listener for message flag update events.- Parameters:
listener- TheEventListenerto be invoked on eachUpdateMessageFlagsEvent- Returns:
- This
EventPollerBuilderinstance
-
onTyping
Adds a listener for typing notification events.- Parameters:
listener- TheEventListenerto be invoked on eachTypingEvent- Returns:
- This
EventPollerBuilderinstance
-
onTypingEditMessage
Adds a listener for message edit typing notification events.- Parameters:
listener- TheEventListenerto be invoked on eachTypingEditMessageEvent- Returns:
- This
EventPollerBuilderinstance
-
onSubmessage
Adds a listener for submessage events.- Parameters:
listener- TheEventListenerto be invoked on eachSubmessageEvent- Returns:
- This
EventPollerBuilderinstance
-
on
Adds a listener for a Zulip event type. Events of types that have no dedicatedEventimplementation expose their payload viaEvent.getProperties().- Parameters:
eventType- The ZulipEventTypelistener- TheEventListenerto be invoked on each event of the given type- Returns:
- This
EventPollerBuilderinstance - See Also:
-
on
Adds a listener for an arbitrary Zulip event type. This is useful for event types introduced in newer Zulip versions that are not yet defined byEventType. Events of types that have no dedicatedEventimplementation expose their payload viaEvent.getProperties().- Parameters:
eventType- The Zulip event type name. E.g.subscriptionlistener- TheEventListenerto be invoked on each event of the given type- Returns:
- This
EventPollerBuilderinstance - See Also:
-
withNarrows
Sets theNarrowexpressions to filter which message events are captured.- Parameters:
narrows- The narrow expression message filter- Returns:
- This
EventPollerBuilderinstance
-
withAllPublicStreams
Sets whether to request message events from all public channels.- Parameters:
allPublicStreams-trueto request message events from all public channels- Returns:
- This
EventPollerBuilderinstance
-
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
EventPollerBuilderinstance
-
withExecutorService
Sets a custom executor to use for invoking event listeners.- Parameters:
executorService- CustomExecutorServiceto use for event listener execution- Returns:
- This
EventPollerBuilderinstance
-
build
-