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

Class StreamService

java.lang.Object

com.github.jamesnetherton.zulip.client.api.stream.StreamService

All Implemented Interfaces:

ZulipService

public class StreamService
extends Object
implements ZulipService

Zulip stream APIs.

Constructor Summary

Constructors

Constructor	Description
StreamService(ZulipHttpClient client)	Constructs a StreamService.

Method Summary

Modifier and Type	Method	Description
AddDefaultStreamApiRequest	addDefaultStream(long streamId)	Adds a default stream for new users joining the organization.
ArchiveStreamApiRequest	archiveStream(long streamId)	Archives a stream.
CreateChannelApiRequest	createChannel(String name, Long... subscribers)	Creates a new channel.
CreateChannelFolderApiRequest	createChannelFolder(String name)	Creates a new channel folder.
DeleteStreamApiRequest	delete(long streamId)	Deletes a stream.
DeleteTopicApiRequest	deleteTopic(long streamId, String topicName)	Deletes a topic.
GetStreamsApiRequest	getAll()	Gets all streams that the user has access to.
GetChannelFoldersApiRequest	getChannelFolders()	Gets all channel folders.
GetStreamApiRequest	getStream(long streamId)	Gets a stream for the given stream ID.
GetStreamEmailAddressApiRequest	getStreamEmailAddress(long streamId)	Gets the email address of a stream.
GetStreamIdApiRequest	getStreamId(String stream)	Gets the id of a stream.
GetStreamSubscribersApiRequest	getStreamSubscribers(long streamId)	Gets all users subscribed to a stream.
GetSubscribedStreamsApiRequest	getSubscribedStreams()	Gets users subscribed streams.
GetStreamTopicsApiRequest	getTopics(long streamId)	Gets stream topics.
GetSubscriptionStatusApiRequest	isSubscribed(long userId, long streamId)	Gets stream subscription status.
MuteTopicApiRequest	muteTopic(String topic)	Deprecated, for removal: This API element is subject to removal in a future version. Use updateUserTopicPreferences instead
RemoveDefaultStreamApiRequest	removeDefaultStream(long streamId)	Removes a default stream for new users joining the organization.
ReorderChannelFoldersApiRequest	reorderChannelFolders(Integer... channelFolderIdOrder)	Reorders channel folders.
SubscribeStreamsApiRequest	subscribe(StreamSubscriptionRequest... streamsToSubscribe)	Subscribe to streams.
MuteTopicApiRequest	unmuteTopic(String topic)	Deprecated, for removal: This API element is subject to removal in a future version. Use updateUserTopicPreferences instead
UnsubscribeStreamsApiRequest	unsubscribe(String... streams)	Unsubscribe from streams.
UpdateChannelFolderApiRequest	updateChannelFolder(int channelFolderId)	Updates a channel folder.
UpdateStreamApiRequest	updateStream(long streamId)	Updates a stream.
UpdateStreamSubscriptionSettingsApiRequest	updateSubscriptionSettings()	Updates stream subscription settings.
UpdateUserTopicPreferencesApiRequest	updateUserTopicPreferences(long streamId, String topic, TopicVisibilityPolicy topicVisibilityPolicy)	Updates personal preferences for a topic.

Methods inherited from class java.lang.Object

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

Constructor Details

StreamService

public StreamService(ZulipHttpClient client)

Constructs a StreamService.

Parameters:

client - The Zulip HTTP client

Method Details

getSubscribedStreams

public GetSubscribedStreamsApiRequest getSubscribedStreams()

Gets users subscribed streams.

Returns:

The GetSubscribedStreamsApiRequest builder object

See Also:

• https://zulip.com/api/get-subscriptions

subscribe

public SubscribeStreamsApiRequest subscribe(StreamSubscriptionRequest... streamsToSubscribe)

Subscribe to streams.

Parameters:

streamsToSubscribe - An array of StreamSubscriptionRequest objects detailing the stream name and description

Returns:

The SubscribeStreamsApiRequest builder object

See Also:

• https://zulip.com/api/subscribe

unsubscribe

public UnsubscribeStreamsApiRequest unsubscribe(String... streams)

Unsubscribe from streams.

Parameters:

streams - An array of stream names to unsubscribe from

Returns:

The UnsubscribeStreamsApiRequest builder object

See Also:

• https://zulip.com/api/unsubscribe

isSubscribed

public GetSubscriptionStatusApiRequest isSubscribed(long userId,
 long streamId)

Gets stream subscription status.

Parameters:

userId - The user id to check if it is subscribed to the specified stream

streamId - The id of the stream to check if the specified user is subscribed

Returns:

The GetSubscriptionStatusApiRequest builder object

See Also:

• https://zulip.com/api/get-subscription-status

getStream

public GetStreamApiRequest getStream(long streamId)

Gets a stream for the given stream ID.

Returns:

The GetStreamApiRequest builder object

See Also:

• https://zulip.com/api/get-stream-by-id

getAll

public GetStreamsApiRequest getAll()

Gets all streams that the user has access to.

Returns:

The GetStreamsApiRequest builder object

See Also:

• https://zulip.com/api/get-streams

getStreamId

public GetStreamIdApiRequest getStreamId(String stream)

Gets the id of a stream.

Parameters:

stream - The name of the stream

Returns:

The GetStreamIdApiRequest builder object

See Also:

• https://zulip.com/api/get-stream-id

getStreamEmailAddress

public GetStreamEmailAddressApiRequest getStreamEmailAddress(long streamId)

Gets the email address of a stream.

Parameters:

streamId - The id of the stream to fetch the email address for

Returns:

The GetStreamEmailAddressApiRequest builder object

See Also:

• https://zulip.com/api/get-stream-email-address

delete

public DeleteStreamApiRequest delete(long streamId)

Deletes a stream.

Parameters:

streamId - The id of the stream to delete

Returns:

The DeleteStreamApiRequest builder object

See Also:

• https://zulip.com/api/delete-stream

getTopics

public GetStreamTopicsApiRequest getTopics(long streamId)

Gets stream topics.

Parameters:

streamId - The id of the stream to get topics from

Returns:

The GetStreamTopicsApiRequest builder object

See Also:

• https://zulip.com/api/get-stream-topics

updateStream

public UpdateStreamApiRequest updateStream(long streamId)

Updates a stream.

Parameters:

streamId - The id of the stream to update

Returns:

The UpdateStreamApiRequest builder object

See Also:

• https://zulip.com/api/update-stream

muteTopic

@Deprecated(forRemoval=true)
public MuteTopicApiRequest muteTopic(String topic)

Deprecated, for removal: This API element is subject to removal in a future version.

Use updateUserTopicPreferences instead

Mutes a topic.

Parameters:

topic - The name of the topic to mute

Returns:

The MuteTopicApiRequest builder object

See Also:

• https://zulip.com/api/mute-topic

unmuteTopic

@Deprecated(forRemoval=true)
public MuteTopicApiRequest unmuteTopic(String topic)

Deprecated, for removal: This API element is subject to removal in a future version.

Use updateUserTopicPreferences instead

Unmutes a topic.

Parameters:

topic - The name of the topic to unmute

Returns:

The MuteTopicApiRequest builder object

See Also:

• https://zulip.com/api/mute-topic

updateSubscriptionSettings

public UpdateStreamSubscriptionSettingsApiRequest updateSubscriptionSettings()

Updates stream subscription settings.

Returns:

The UpdateStreamSubscriptionSettingsApiRequest builder object

See Also:

• https://zulip.com/api/update-subscription-settings

deleteTopic

public DeleteTopicApiRequest deleteTopic(long streamId,
 String topicName)

Deletes a topic.

Parameters:

streamId - The id of the stream containing the topic to delete

topicName - The name of the topic to delete

Returns:

The DeleteTopicApiRequest builder object

See Also:

• https://zulip.com/api/delete-topic

archiveStream

public ArchiveStreamApiRequest archiveStream(long streamId)

Archives a stream.

Parameters:

streamId - The id of the stream to archive

Returns:

The ArchiveStreamApiRequest builder object

See Also:

• https://zulip.com/api/archive-stream

updateUserTopicPreferences

public UpdateUserTopicPreferencesApiRequest updateUserTopicPreferences(long streamId,
 String topic,
 TopicVisibilityPolicy topicVisibilityPolicy)

Updates personal preferences for a topic.

Parameters:

streamId - The id of the stream where the topic resides

topic - The name of the topic to update preferences for

topicVisibilityPolicy - The TopicVisibilityPolicy to apply

Returns:

The UpdateUserTopicPreferencesApiRequest builder object

See Also:

• https://zulip.com/api/update-user-topic

addDefaultStream

public AddDefaultStreamApiRequest addDefaultStream(long streamId)

Adds a default stream for new users joining the organization.

Parameters:

streamId - The id of the stream to make a default for new users joining the organization

Returns:

The AddDefaultStreamApiRequest builder object

See Also:

• https://zulip.com/api/add-default-stream

removeDefaultStream

public RemoveDefaultStreamApiRequest removeDefaultStream(long streamId)

Removes a default stream for new users joining the organization.

Parameters:

streamId - The id of the stream to remove as a default for new users joining the organization

Returns:

The RemoveDefaultStreamApiRequest builder object

See Also:

• https://zulip.com/api/remove-default-stream

getStreamSubscribers

public GetStreamSubscribersApiRequest getStreamSubscribers(long streamId)

Gets all users subscribed to a stream.

Parameters:

streamId - The id of the stream to get subscribers for

Returns:

The GetStreamSubscribersApiRequest builder object

See Also:

• https://zulip.com/api/get-subscribers

createChannel

public CreateChannelApiRequest createChannel(String name,
 Long... subscribers)

Creates a new channel.

Parameters:

name - The name of the channel

subscribers - The user ids that should be subscribed to the channel

Returns:

The CreateChannelApiRequest builder object

See Also:

• https://zulip.com/api/create-channel

createChannelFolder

public CreateChannelFolderApiRequest createChannelFolder(String name)

Creates a new channel folder.

Parameters:

name - The name of the channel folder

Returns:

The CreateChannelFolderApiRequest builder object

See Also:

• https://zulip.com/api/create-channel-folder

getChannelFolders

public GetChannelFoldersApiRequest getChannelFolders()

Gets all channel folders.

Returns:

The GetChannelFoldersApiRequest builder object

See Also:

• https://zulip.com/api/get-channel-folders

reorderChannelFolders

public ReorderChannelFoldersApiRequest reorderChannelFolders(Integer... channelFolderIdOrder)

Reorders channel folders.

Parameters:

channelFolderIdOrder - The order of the channel folder ids

Returns:

The GetChannelFoldersApiRequest builder object

See Also:

• https://zulip.com/api/get-channel-folders

updateChannelFolder

public UpdateChannelFolderApiRequest updateChannelFolder(int channelFolderId)

Updates a channel folder.

Parameters:

channelFolderId - The id of the channel folder to update

Returns:

The UpdateChannelFolderApiRequest builder object

See Also:

• https://zulip.com/api/update-channel-folder