Package com.github.jamesnetherton.zulip.client

Class Zulip

java.lang.Object

com.github.jamesnetherton.zulip.client.Zulip

All Implemented Interfaces:

Closeable, AutoCloseable

public final class Zulip
extends Object
implements Closeable

The Zulip client. The entrypoint to accessing Zulip REST APIs.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Zulip.Builder	Builder class for constructing the Zulip Client.

Constructor Summary

Constructors

Constructor	Description
Zulip(ZulipConfiguration configuration)	Constructs a new Zulip instance with the provided ZulipConfiguration.
Zulip(String email, String apiKey, String site)	Constructs a new Zulip instance.

Method Summary

Modifier and Type	Method	Description
StreamService	channels()	Access the collection of channel Zulip APIs.
void	close()	Closes the underlying HTTP client and frees up resources.
DraftService	drafts()	Access the collection of draft Zulip APIs.
EventService	events()	Access the collection of event Zulip APIs.
InvitationService	invitations()	Access the collection of invitation Zulip APIs.
MessageService	messages()	Access the collection of message Zulip APIs.
ServerService	server()	Access the collection of server and organization Zulip APIs.
SnippetService	snippets()	Access the collection of saved snippet Zulip APIs.
StreamService	streams()	Access the collection of stream Zulip APIs.
UserService	users()	Access the collection of user Zulip APIs.

Methods inherited from class java.lang.Object

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

Constructor Details

Zulip

public Zulip(String email,
 String apiKey,
 String site)
      throws ZulipClientException

Constructs a new Zulip instance.

Parameters:

email - The email address to use for authentication with the Zulip server

apiKey - The API key to use for authentication with the Zulip server

site - The URL of the Zulip server

Throws:

ZulipClientException - If there was a problem constructing the Zulip client

Zulip

public Zulip(ZulipConfiguration configuration)
      throws ZulipClientException

Constructs a new Zulip instance with the provided ZulipConfiguration.

Parameters:

configuration - The ZulipConfiguration to use for configuring the Zulip client

Throws:

ZulipClientException - If there was a problem constructing the Zulip client

Method Details

channels

public StreamService channels()

Access the collection of channel Zulip APIs.

Since channels are analogous to streams. The StreamService is returned.

Returns:

The StreamService Zulip channel APIs

drafts

public DraftService drafts()

Access the collection of draft Zulip APIs.

Returns:

The DraftService Zulip draft APIs

events

public EventService events()

Access the collection of event Zulip APIs.

Returns:

The EventService Zulip event APIs

invitations

public InvitationService invitations()

Access the collection of invitation Zulip APIs.

Returns:

The InvitationService Zulip event APIs

messages

public MessageService messages()

Access the collection of message Zulip APIs.

Returns:

The MessageService Zulip message APIs

server

public ServerService server()

Access the collection of server and organization Zulip APIs.

Returns:

The ServerService Zulip server and organization APIs

snippets

public SnippetService snippets()

Access the collection of saved snippet Zulip APIs.

Returns:

The SnippetService Zulip saved snippet APIs

streams

public StreamService streams()

Access the collection of stream Zulip APIs.

Returns:

The StreamService Zulip stream APIs

users

public UserService users()

Access the collection of user Zulip APIs.

Returns:

The UserService Zulip user APIs

close

public void close()

Closes the underlying HTTP client and frees up resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable