com.github.jamesnetherton.zulip.client.api.event.EventService Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of zulip-java-client Show documentation

Java client for the Zulip REST API

The newest version!

package com.github.jamesnetherton.zulip.client.api.event;

import com.github.jamesnetherton.zulip.client.api.core.ZulipService;
import com.github.jamesnetherton.zulip.client.api.narrow.Narrow;
import com.github.jamesnetherton.zulip.client.http.ZulipHttpClient;

/**
 * Zulip event APIs.
 *
 * Note that these service methods are experimental and subject to change or removal in future releases.
 */
public class EventService implements ZulipService {

    private final ZulipHttpClient client;

    /**
     * Constructs a {@link EventService}.
     *
     * @param client The Zulip HTTP client
     */
    public EventService(ZulipHttpClient client) {
        this.client = client;
    }

    /**
     * Capture message events.
     *
     * @param  listener The {@link MessageEventListener} to be invoked on each message event
     * @param  narrows  optional {@link Narrow} expressions to filter which message events are captured. E.g messages from a
     *                  specific stream
     * @return          {@link EventPoller} to initiate event polling
     */
    public EventPoller captureMessageEvents(MessageEventListener listener, Narrow... narrows) {
        return new EventPoller(this.client, listener, narrows);
    }
}