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

Class SubscribeStreamsApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<StreamSubscriptionResult>

public class SubscribeStreamsApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<StreamSubscriptionResult>

Zulip API request builder for subscribing to a stream.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANNOUNCE
static final String	AUTHORIZATION_ERRORS_FATAL
static final String	CAN_ADD_SUBSCRIBERS_GROUP
static final String	CAN_ADMINISTER_CHANNEL_GROUP
static final String	CAN_DELETE_ANY_MESSAGE_GROUP
static final String	CAN_DELETE_OWN_MESSAGE_GROUP
static final String	CAN_MOVE_MESSAGES_OUT_OF_CHANNEL_GROUP
static final String	CAN_MOVE_MESSAGES_WITHIN_CHANNEL_GROUP
static final String	CAN_REMOVE_SUBSCRIBERS_GROUP
static final String	CAN_RESOLVE_TOPICS_GROUP
static final String	CAN_SEND_MESSAGE_GROUP
static final String	CAN_SUBSCRIBE_GROUP
static final String	FOLDER_ID
static final String	HISTORY_PUBLIC_TO_SUBSCRIBERS
static final String	INVITE_ONLY
static final String	IS_DEFAULT_STREAM
static final String	IS_WEB_PUBLIC
static final String	MESSAGE_RETENTION_DAYS
static final String	PRINCIPALS
static final String	SEND_NEW_SUBSCRIPTION_MESSAGES
static final String	STREAM_POST_POLICY
static final String	SUBSCRIPTIONS
static final String	TOPICS_POLICY

Constructor Summary

Constructors

Constructor	Description
SubscribeStreamsApiRequest(ZulipHttpClient client, StreamSubscriptionRequest[] subscriptions)	Constructs a SubscribeStreamsApiRequest.

Method Summary

Modifier and Type	Method	Description
StreamSubscriptionResult	execute()	Executes the Zulip API request for subscribing to a stream.
SubscribeStreamsApiRequest	withAnnounce(boolean announce)	Sets whether creation of the new stream should be announced.
SubscribeStreamsApiRequest	withAuthorizationErrorsFatal(boolean authorizationErrorsFatal)	Sets whether authorization failures should result in a failure response.
SubscribeStreamsApiRequest	withCanAddSubscribersGroup(UserGroupSetting userGroupSetting)	Sets the user group settings for users who have permission to add subscribers to this channel.
SubscribeStreamsApiRequest	withCanAdministerChannelGroup(UserGroupSetting userGroupSetting)	Sets the user group settings for users who have permission to administer this channel.
SubscribeStreamsApiRequest	withCanDeleteAnyMessageGroup(UserGroupSetting userGroupSetting)	Sets the user group settings for users who have permission to delete any message in the channel.
SubscribeStreamsApiRequest	withCanDeleteOwnMessageGroup(UserGroupSetting userGroupSetting)	Sets the user group settings for users who have permission to delete the messages that they have sent in the channel.
SubscribeStreamsApiRequest	withCanMoveMessagesOutOfChannelGroup(UserGroupSetting userGroupSetting)	Sets the user group settings for users who have permission to move messages out of this channel.
SubscribeStreamsApiRequest	withCanMoveMessagesWithinChannelGroup(UserGroupSetting userGroupSetting)	Sets the user group settings for users who have permission to move messages within this channel.
SubscribeStreamsApiRequest	withCanRemoveSubscribersGroup(long userGroupID)	Deprecated. Use withCanRemoveSubscribersGroup(UserGroupSetting)
SubscribeStreamsApiRequest	withCanRemoveSubscribersGroup(UserGroupSetting userGroupSetting)	Sets the user group id whose members are allowed to unsubscribe others from the stream.
SubscribeStreamsApiRequest	withCanResolveTopicsGroup(UserGroupSetting userGroupSetting)	Sets the user group settings for users who have permission to resolve topics in the channel.
SubscribeStreamsApiRequest	withCanSendMessageGroup(UserGroupSetting userGroupSetting)	Sets the user group settings for users who have permission to post in this channel.
SubscribeStreamsApiRequest	withCanSubscribeGroup(UserGroupSetting userGroupSetting)	Sets the user group settings for users who have permission to subscribe themselves to this channel.
SubscribeStreamsApiRequest	withDefaultStream(boolean defaultStream)	Sets whether any newly created streams will be added as default streams for new users joining the organization.
SubscribeStreamsApiRequest	withFolderId(int folderId)	Sets the id of the folder to which the newly created channel will be added.
SubscribeStreamsApiRequest	withHistoryPublicToSubscribers(boolean historyPublicToSubscribers)	Sets whether the stream history is public to new subscribers.
SubscribeStreamsApiRequest	withInviteOnly(boolean inviteOnly)	Sets whether a created stream will be private.
SubscribeStreamsApiRequest	withMessageRetention(int messageRetentionDays)	Sets the number of days that message history should be retained.
SubscribeStreamsApiRequest	withMessageRetention(RetentionPolicy messageRetentionPolicy)	Sets the message retention policy of a stream.
SubscribeStreamsApiRequest	withPrincipals(long... userIds)	Sets the list of users that are to be subscribed to the stream.
SubscribeStreamsApiRequest	withPrincipals(String... emailAddresses)	Sets the list of users that are to be subscribed to the stream.
SubscribeStreamsApiRequest	withSendNewSubscriptionMessages(boolean sendNewSubscriptionMessages)	Sets whether any other users newly subscribed via this request should be sent a Notification Bot DM notifying them about their new subscription.
SubscribeStreamsApiRequest	withStreamPostPolicy(StreamPostPolicy policy)	Sets the policy for which users can post messages to the stream.
SubscribeStreamsApiRequest	withTopicPolicy(TopicPolicy topicPolicy)	Sets whether named topics and the empty topic are enabled in this channel.
SubscribeStreamsApiRequest	withWebPublic(boolean webPublic)	Sets whether any newly created streams will be web-public streams.

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

client, getParam, 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

SUBSCRIPTIONS

public static final String SUBSCRIPTIONS

See Also:

• Constant Field Values

PRINCIPALS

public static final String PRINCIPALS

See Also:

• Constant Field Values

AUTHORIZATION_ERRORS_FATAL

public static final String AUTHORIZATION_ERRORS_FATAL

See Also:

• Constant Field Values

ANNOUNCE

public static final String ANNOUNCE

See Also:

• Constant Field Values

INVITE_ONLY

public static final String INVITE_ONLY

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

HISTORY_PUBLIC_TO_SUBSCRIBERS

public static final String HISTORY_PUBLIC_TO_SUBSCRIBERS

See Also:

• Constant Field Values

STREAM_POST_POLICY

public static final String STREAM_POST_POLICY

See Also:

• Constant Field Values

MESSAGE_RETENTION_DAYS

public static final String MESSAGE_RETENTION_DAYS

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_DELETE_ANY_MESSAGE_GROUP

public static final String CAN_DELETE_ANY_MESSAGE_GROUP

See Also:

• Constant Field Values

CAN_DELETE_OWN_MESSAGE_GROUP

public static final String CAN_DELETE_OWN_MESSAGE_GROUP

See Also:

• Constant Field Values

CAN_MOVE_MESSAGES_OUT_OF_CHANNEL_GROUP

public static final String CAN_MOVE_MESSAGES_OUT_OF_CHANNEL_GROUP

See Also:

• Constant Field Values

CAN_MOVE_MESSAGES_WITHIN_CHANNEL_GROUP

public static final String CAN_MOVE_MESSAGES_WITHIN_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

CAN_REMOVE_SUBSCRIBERS_GROUP

public static final String CAN_REMOVE_SUBSCRIBERS_GROUP

See Also:

• Constant Field Values

CAN_RESOLVE_TOPICS_GROUP

public static final String CAN_RESOLVE_TOPICS_GROUP

See Also:

• Constant Field Values

TOPICS_POLICY

public static final String TOPICS_POLICY

See Also:

• Constant Field Values

FOLDER_ID

public static final String FOLDER_ID

See Also:

• Constant Field Values

SEND_NEW_SUBSCRIPTION_MESSAGES

public static final String SEND_NEW_SUBSCRIPTION_MESSAGES

See Also:

• Constant Field Values

Constructor Details

SubscribeStreamsApiRequest

public SubscribeStreamsApiRequest(ZulipHttpClient client,
 StreamSubscriptionRequest[] subscriptions)

Constructs a SubscribeStreamsApiRequest.

Parameters:

client - The Zulip HTTP client

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

Method Details

withPrincipals

public SubscribeStreamsApiRequest withPrincipals(String... emailAddresses)

Sets the list of users that are to be subscribed to the stream.

Parameters:

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

Returns:

This SubscribeStreamsApiRequest instance

withPrincipals

public SubscribeStreamsApiRequest withPrincipals(long... userIds)

Sets the list of users that are to be subscribed to the stream.

Parameters:

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

Returns:

This SubscribeStreamsApiRequest instance

withAuthorizationErrorsFatal

public SubscribeStreamsApiRequest withAuthorizationErrorsFatal(boolean authorizationErrorsFatal)

Sets whether authorization failures should result in a failure response. I.e if a specified user does not have access to the stream.

Parameters:

authorizationErrorsFatal - true if authorization failures should result in a failure response. true if authorization failures should be ignored

Returns:

This SubscribeStreamsApiRequest instance

withAnnounce

public SubscribeStreamsApiRequest withAnnounce(boolean announce)

Sets whether creation of the new stream should be announced.

Parameters:

announce - true to announce the creation of the new stream. false to not make any announcement

Returns:

This SubscribeStreamsApiRequest instance

withDefaultStream

public SubscribeStreamsApiRequest 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

withInviteOnly

public SubscribeStreamsApiRequest withInviteOnly(boolean inviteOnly)

Sets whether a created stream will be private.

Parameters:

inviteOnly - true results in any streams created as private. false results in created streams being public

Returns:

This SubscribeStreamsApiRequest instance

withWebPublic

public SubscribeStreamsApiRequest withWebPublic(boolean webPublic)

Sets whether any newly created streams will be web-public streams.

Parameters:

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

Returns:

This SubscribeStreamsApiRequest instance

withHistoryPublicToSubscribers

public SubscribeStreamsApiRequest 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 SubscribeStreamsApiRequest instance

withStreamPostPolicy

public SubscribeStreamsApiRequest withStreamPostPolicy(StreamPostPolicy policy)

Sets the policy for which users can post messages to the stream.

Parameters:

policy - The StreamPostPolicy that should apply to the stream

Returns:

This SubscribeStreamsApiRequest instance

withMessageRetention

public SubscribeStreamsApiRequest withMessageRetention(int messageRetentionDays)

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

Parameters:

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

Returns:

This SubscribeStreamsApiRequest instance

withMessageRetention

public SubscribeStreamsApiRequest withMessageRetention(RetentionPolicy messageRetentionPolicy)

Sets the message retention policy of a stream.

Parameters:

messageRetentionPolicy - The RetentionPolicy that should apply to the stream

Returns:

This SubscribeStreamsApiRequest instance

withCanAddSubscribersGroup

public SubscribeStreamsApiRequest withCanAddSubscribersGroup(UserGroupSetting userGroupSetting)

Sets the user group settings for users who have permission to add subscribers to this channel.

Parameters:

userGroupSetting - The UserGroupSetting for users who have permission to add subscribers to this channel

Returns:

This SubscribeStreamsApiRequest instance

withCanAdministerChannelGroup

public SubscribeStreamsApiRequest withCanAdministerChannelGroup(UserGroupSetting userGroupSetting)

Sets the user group settings for users who have permission to administer this channel.

Parameters:

userGroupSetting - The UserGroupSetting for users who have permission to administer this channel

Returns:

This SubscribeStreamsApiRequest instance

withCanDeleteAnyMessageGroup

public SubscribeStreamsApiRequest withCanDeleteAnyMessageGroup(UserGroupSetting userGroupSetting)

Sets the user group settings for users who have permission to delete any message in the channel.

Parameters:

userGroupSetting - The UserGroupSetting for users who have permission to delete any message in the channel

Returns:

This SubscribeStreamsApiRequest instance

withCanDeleteOwnMessageGroup

public SubscribeStreamsApiRequest withCanDeleteOwnMessageGroup(UserGroupSetting userGroupSetting)

Sets the user group settings for users who have permission to delete the messages that they have sent in the channel.

Parameters:

userGroupSetting - The UserGroupSetting for users who have permission to delete the messages that they have sent in the channel

Returns:

This SubscribeStreamsApiRequest instance

withCanMoveMessagesOutOfChannelGroup

public SubscribeStreamsApiRequest withCanMoveMessagesOutOfChannelGroup(UserGroupSetting userGroupSetting)

Sets the user group settings for users who have permission to move messages out of this channel.

Parameters:

userGroupSetting - The UserGroupSetting for users who have permission to move messages out of this channel

Returns:

This SubscribeStreamsApiRequest instance

withCanMoveMessagesWithinChannelGroup

public SubscribeStreamsApiRequest withCanMoveMessagesWithinChannelGroup(UserGroupSetting userGroupSetting)

Sets the user group settings for users who have permission to move messages within this channel.

Parameters:

userGroupSetting - The UserGroupSetting for users who have permission to move messages within this channel

Returns:

This SubscribeStreamsApiRequest instance

withCanSendMessageGroup

public SubscribeStreamsApiRequest withCanSendMessageGroup(UserGroupSetting userGroupSetting)

Sets the user group settings for users who have permission to post in this channel.

Parameters:

userGroupSetting - The UserGroupSetting for users who have permission to post in this channel

Returns:

This SubscribeStreamsApiRequest instance

withCanSubscribeGroup

public SubscribeStreamsApiRequest withCanSubscribeGroup(UserGroupSetting userGroupSetting)

Sets the user group settings for users who have permission to subscribe themselves to this channel.

Parameters:

userGroupSetting - The UserGroupSetting for users who have permission to subscribe themselves to this channel

Returns:

This SubscribeStreamsApiRequest instance

withCanRemoveSubscribersGroup

public SubscribeStreamsApiRequest withCanRemoveSubscribersGroup(long userGroupID)

Deprecated.

Use withCanRemoveSubscribersGroup(UserGroupSetting)

Sets the user group id whose members are allowed to unsubscribe others from the stream.

Parameters:

userGroupID - The user group id whose members are allowed to unsubscribe others from the stream

Returns:

This SubscribeStreamsApiRequest instance

withCanRemoveSubscribersGroup

public SubscribeStreamsApiRequest withCanRemoveSubscribersGroup(UserGroupSetting userGroupSetting)

Sets the user group id whose members are allowed to unsubscribe others from the stream.

Parameters:

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

Returns:

This SubscribeStreamsApiRequest instance

withCanResolveTopicsGroup

public SubscribeStreamsApiRequest withCanResolveTopicsGroup(UserGroupSetting userGroupSetting)

Sets the user group settings for users who have permission to resolve topics in the channel.

Parameters:

userGroupSetting - The UserGroupSetting for users who have permission to resolve topics in the channel

Returns:

This SubscribeStreamsApiRequest instance

withTopicPolicy

public SubscribeStreamsApiRequest withTopicPolicy(TopicPolicy topicPolicy)

Sets whether named topics and the empty topic are enabled in this channel.

Parameters:

topicPolicy - The TopicPolicy

Returns:

This SubscribeStreamsApiRequest instance

withFolderId

public SubscribeStreamsApiRequest withFolderId(int folderId)

Sets the id of the folder to which the newly created channel will be added.

Parameters:

folderId - The id of the folder to which the newly created channel will be added

Returns:

This SubscribeStreamsApiRequest instance

withSendNewSubscriptionMessages

public SubscribeStreamsApiRequest withSendNewSubscriptionMessages(boolean sendNewSubscriptionMessages)

Sets whether any other users newly subscribed via this request should be sent a Notification Bot DM notifying them about their new subscription.

Parameters:

sendNewSubscriptionMessages - true to send new subscription messages. false to not send a subscription message

Returns:

This SubscribeStreamsApiRequest instance

execute

public StreamSubscriptionResult execute()
                                 throws ZulipClientException

Executes the Zulip API request for subscribing to a stream.

Specified by:

execute in interface ExecutableApiRequest<StreamSubscriptionResult>

Returns:

StreamSubscriptionRequest describing the result of the StreamSubscriptionRequest

Throws:

ZulipClientException - if the request was not successful