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

Class UnsubscribeStreamsApiRequest

java.lang.Object

com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

com.github.jamesnetherton.zulip.client.api.stream.request.UnsubscribeStreamsApiRequest

All Implemented Interfaces:

ExecutableApiRequest<StreamUnsubscribeResult>

public class UnsubscribeStreamsApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<StreamUnsubscribeResult>

Zulip API request builder for unsubscribing users from a stream.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRINCIPALS
static final String	SUBSCRIPTIONS

Constructor Summary

Constructors

Constructor	Description
UnsubscribeStreamsApiRequest(ZulipHttpClient client, String[] subscriptions)	Constructs a UnsubscribeStreamsApiRequest.

Method Summary

Modifier and Type	Method	Description
StreamUnsubscribeResult	execute()	Executes the Zulip API request for unsubscribing users from a stream.
UnsubscribeStreamsApiRequest	withPrincipals(long... userIds)	Sets the list of users that are to be unsubscribed from the stream.
UnsubscribeStreamsApiRequest	withPrincipals(String... emailAddresses)	Sets the list of users that are to be unsubscribed from the stream.

Methods inherited from class com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

client, getParam, getParams, putParam, putParamAsJsonString

Methods inherited from class java.lang.Object

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

Field Details

SUBSCRIPTIONS

public static final String SUBSCRIPTIONS

See Also:

• Constant Field Values

PRINCIPALS

public static final String PRINCIPALS

See Also:

• Constant Field Values

Constructor Details

UnsubscribeStreamsApiRequest

public UnsubscribeStreamsApiRequest(ZulipHttpClient client,
 String[] subscriptions)

Constructs a UnsubscribeStreamsApiRequest.

Parameters:

client - The Zulip HTTP client

subscriptions - An array of stream names to unsubscribe from

Method Details

withPrincipals

public UnsubscribeStreamsApiRequest withPrincipals(String... emailAddresses)

Sets the list of users that are to be unsubscribed from the stream.

Parameters:

emailAddresses - The array of user email addresses to unsubscribe to the stream

Returns:

This UnsubscribeStreamsApiRequest instance

withPrincipals

public UnsubscribeStreamsApiRequest withPrincipals(long... userIds)

Sets the list of users that are to be unsubscribed from the stream.

Parameters:

userIds - The array of user ids to unsubscribe to the stream

Returns:

This UnsubscribeStreamsApiRequest instance

execute

public StreamUnsubscribeResult execute()
                                throws ZulipClientException

Executes the Zulip API request for unsubscribing users from a stream.

Specified by:

execute in interface ExecutableApiRequest<StreamUnsubscribeResult>

Returns:

StreamUnsubscribeResult describing the result of the request to unsubscribe users from streams

Throws:

ZulipClientException - if the request was not successful