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

Class UpdateStreamApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class UpdateStreamApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for updating a stream.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CAN_ADD_SUBSCRIBERS_GROUP
static final String	CAN_ADMINISTER_CHANNEL_GROUP
static final String	CAN_REMOVE_SUBSCRIBERS_GROUP
static final String	CAN_SEND_MESSAGE_GROUP
static final String	CAN_SUBSCRIBE_GROUP
static final String	DESCRIPTION
static final String	HISTORY_PUBLIC_TO_SUBSCRIBERS
static final String	IS_DEFAULT_STREAM
static final String	IS_WEB_PUBLIC
static final String	MESSAGE_RETENTION_DAYS
static final String	NEW_NAME
static final String	PRIVATE

Constructor Summary

Constructors

Constructor	Description
UpdateStreamApiRequest(ZulipHttpClient client, long streamId)	Constructs a DeleteStreamApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for updating a stream.
UpdateStreamApiRequest	withCanAddSubscribersGroup(UserGroupSetting userGroupSetting)	Sets the users who have permission to add others to this stream.
UpdateStreamApiRequest	withCanAdministerChannelGroup(UserGroupSetting userGroupSetting)	Set the users who have permission to administer this stream
UpdateStreamApiRequest	withCanRemoveSubscribersGroup(UserGroupSetting userGroupSetting)	Sets the users who have permission to unsubscribe others from this stream.
UpdateStreamApiRequest	withCanSendMessageGroup(UserGroupSetting userGroupSetting)	Set the users who have permission to post in this stream
UpdateStreamApiRequest	withCanSubscribeGroup(UserGroupSetting userGroupSetting)	Sets the users who have permission to subscribe themselves to this stream
UpdateStreamApiRequest	withDefaultStream(boolean defaultStream)	Sets whether any newly created streams will be added as default streams for new users joining the organization.
UpdateStreamApiRequest	withDescription(String description)	Sets the updated stream description.
UpdateStreamApiRequest	withHistoryPublicToSubscribers(boolean historyPublicToSubscribers)	Sets whether the stream history is public to new subscribers.
UpdateStreamApiRequest	withIsPrivate(boolean isPrivate)	Sets whether the stream is private.
UpdateStreamApiRequest	withMessageRetention(int messageRetentionDays)	Sets the updated number of days that message history should be retained.
UpdateStreamApiRequest	withMessageRetention(RetentionPolicy messageRetentionPolicy)	Sets the updated message retention policy of a stream.
UpdateStreamApiRequest	withName(String name)	Sets the updated stream name.
UpdateStreamApiRequest	withWebPublic(boolean webPublic)	Sets whether the stream is a web-public stream.

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

client, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject

Methods inherited from class java.lang.Object

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

Field Details

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

NEW_NAME

public static final String NEW_NAME

See Also:

• Constant Field Values

PRIVATE

public static final String PRIVATE

See Also:

• Constant Field Values

IS_DEFAULT_STREAM

public static final String IS_DEFAULT_STREAM

See Also:

• Constant Field Values

IS_WEB_PUBLIC

public static final String IS_WEB_PUBLIC

See Also:

• Constant Field Values

MESSAGE_RETENTION_DAYS

public static final String MESSAGE_RETENTION_DAYS

See Also:

• Constant Field Values

HISTORY_PUBLIC_TO_SUBSCRIBERS

public static final String HISTORY_PUBLIC_TO_SUBSCRIBERS

See Also:

• Constant Field Values

CAN_REMOVE_SUBSCRIBERS_GROUP

public static final String CAN_REMOVE_SUBSCRIBERS_GROUP

See Also:

• Constant Field Values

CAN_ADD_SUBSCRIBERS_GROUP

public static final String CAN_ADD_SUBSCRIBERS_GROUP

See Also:

• Constant Field Values

CAN_ADMINISTER_CHANNEL_GROUP

public static final String CAN_ADMINISTER_CHANNEL_GROUP

See Also:

• Constant Field Values

CAN_SEND_MESSAGE_GROUP

public static final String CAN_SEND_MESSAGE_GROUP

See Also:

• Constant Field Values

CAN_SUBSCRIBE_GROUP

public static final String CAN_SUBSCRIBE_GROUP

See Also:

• Constant Field Values

Constructor Details

UpdateStreamApiRequest

public UpdateStreamApiRequest(ZulipHttpClient client,
 long streamId)

Constructs a DeleteStreamApiRequest.

Parameters:

client - The Zulip HTTP client

streamId - The id of the stream to update

Method Details

withDescription

public UpdateStreamApiRequest withDescription(String description)

Sets the updated stream description.

Parameters:

description - The description of the stream

Returns:

This UpdateStreamApiRequest instance

withName

public UpdateStreamApiRequest withName(String name)

Sets the updated stream name.

Parameters:

name - The name of the stream

Returns:

This UpdateStreamApiRequest instance

withIsPrivate

public UpdateStreamApiRequest withIsPrivate(boolean isPrivate)

Sets whether the stream is private.

Parameters:

isPrivate - true if the stream should be private. false if the stream should be public

Returns:

This UpdateStreamApiRequest instance

withDefaultStream

public UpdateStreamApiRequest withDefaultStream(boolean defaultStream)

Sets whether any newly created streams will be added as default streams for new users joining the organization.

Parameters:

defaultStream - true results in any newly created streams as the default. false results in any newly created streams being the default

Returns:

This SubscribeStreamsApiRequest instance

withWebPublic

public UpdateStreamApiRequest withWebPublic(boolean webPublic)

Sets whether the stream is a web-public stream.

Parameters:

webPublic - true results in any newly created streams created as web0public. false results in created streams being non web-public

Returns:

This UpdateStreamApiRequest instance

withMessageRetention

public UpdateStreamApiRequest withMessageRetention(int messageRetentionDays)

Sets the updated number of days that message history should be retained.

Parameters:

messageRetentionDays - The number of days for which message history should be retained

Returns:

This UpdateStreamApiRequest instance

withMessageRetention

public UpdateStreamApiRequest withMessageRetention(RetentionPolicy messageRetentionPolicy)

Sets the updated message retention policy of a stream.

Parameters:

messageRetentionPolicy - The RetentionPolicy that should apply to the stream

Returns:

This UpdateStreamApiRequest instance

withHistoryPublicToSubscribers

public UpdateStreamApiRequest withHistoryPublicToSubscribers(boolean historyPublicToSubscribers)

Sets whether the stream history is public to new subscribers.

Parameters:

historyPublicToSubscribers - true if stream history should be public to new subscribers. false if stream history should not be public to new subscribers

Returns:

This UpdateStreamApiRequest instance

withCanRemoveSubscribersGroup

public UpdateStreamApiRequest withCanRemoveSubscribersGroup(UserGroupSetting userGroupSetting)

Sets the users who have permission to unsubscribe others from this stream.

Parameters:

userGroupSetting - The UserGroupSetting determining which members are allowed to unsubscribe others from the stream

Returns:

This UpdateStreamApiRequest instance

withCanAddSubscribersGroup

public UpdateStreamApiRequest withCanAddSubscribersGroup(UserGroupSetting userGroupSetting)

Sets the users who have permission to add others to this stream.

Parameters:

userGroupSetting - The UserGroupSetting determining which members are allowed to subscribe others to the stream

Returns:

This UpdateStreamApiRequest instance

withCanAdministerChannelGroup

public UpdateStreamApiRequest withCanAdministerChannelGroup(UserGroupSetting userGroupSetting)

Set the users who have permission to administer this stream

Parameters:

userGroupSetting - The UserGroupSetting determining which members are allowed to subscribe others to the stream

Returns:

This UpdateStreamApiRequest instance

withCanSendMessageGroup

public UpdateStreamApiRequest withCanSendMessageGroup(UserGroupSetting userGroupSetting)

Set the users who have permission to post in this stream

Parameters:

userGroupSetting - The UserGroupSetting determining which members are allowed to subscribe others to the stream

Returns:

This UpdateStreamApiRequest instance

withCanSubscribeGroup

public UpdateStreamApiRequest withCanSubscribeGroup(UserGroupSetting userGroupSetting)

Sets the users who have permission to subscribe themselves to this stream

Parameters:

userGroupSetting - The UserGroupSetting determining which members are allowed to subscribe others to the stream

Returns:

This UpdateStreamApiRequest instance

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for updating a stream.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful