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

Class CreateChannelApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.channel.request.CreateChannelApiRequest

All Implemented Interfaces:

ExecutableApiRequest<Long>

public class CreateChannelApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Long>

Zulip API request builder for creating new channel.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANNOUNCE
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	DESCRIPTION
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	NAME
static final String	SEND_NEW_SUBSCRIPTION_MESSAGES
static final String	SUBSCRIBERS
static final String	TOPICS_POLICY

Constructor Summary

Constructors

Constructor	Description
CreateChannelApiRequest(ZulipHttpClient client, String name, Long... subscribers)	Constructs a ZulipApiRequest.

Method Summary

Modifier and Type	Method	Description
Long	execute()	Executes the Zulip API request for creating new channel.
CreateChannelApiRequest	withAnnounce(boolean announce)	Sets whether the notification bot will send an announcement about the new channel creation.
CreateChannelApiRequest	withCanAddSubscribersGroup(UserGroupSetting userGroupSetting)	Sets the user group settings for users who have permission to add subscribers to this channel.
CreateChannelApiRequest	withCanAdministerChannelGroup(UserGroupSetting userGroupSetting)	Set the users who have permission to administer this stream.
CreateChannelApiRequest	withCanDeleteAnyMessageGroup(UserGroupSetting userGroupSetting)	Sets the user group settings for users who have permission to delete any message in the channel.
CreateChannelApiRequest	withCanDeleteOwnMessageGroup(UserGroupSetting userGroupSetting)	Sets the user group settings for users who have permission to delete the messages that they have sent in the channel.
CreateChannelApiRequest	withCanMoveMessagesOutOfChannelGroup(UserGroupSetting userGroupSetting)	Sets the user group settings for users who have permission to move messages out of this channel.
CreateChannelApiRequest	withCanMoveMessagesWithinChannelGroup(UserGroupSetting userGroupSetting)	Sets the user group settings for users who have permission to move messages within this channel.
CreateChannelApiRequest	withCanRemoveSubscribersGroup(UserGroupSetting userGroupSetting)	Sets the user group id whose members are allowed to unsubscribe others from the stream.
CreateChannelApiRequest	withCanResolveTopicsGroup(UserGroupSetting userGroupSetting)	Sets the user group settings for users who have permission to resolve topics in the channel.
CreateChannelApiRequest	withCanSendMessageGroup(UserGroupSetting userGroupSetting)	Set the users who have permission to post in this stream.
CreateChannelApiRequest	withCanSubscribeGroup(UserGroupSetting userGroupSetting)	Sets the user group settings for users who have permission to subscribe themselves to this channel.
CreateChannelApiRequest	withDescription(String description)	Sets the description of the channel.
CreateChannelApiRequest	withFolderId(int folderId)	Sets the id of the folder to which the channel belongs.
CreateChannelApiRequest	withHistoryPublicToSubscribers(boolean historyPublicToSubscribers)	Sets whether the channel message history should be available to newly subscribed members.
CreateChannelApiRequest	withInviteOnly(boolean inviteOnly)	Sets whether the newly created channel will be a private channel.
CreateChannelApiRequest	withIsDefaultStream(boolean isDefaultStream)	Sets whether the newly created channel will be added as a default channel.
CreateChannelApiRequest	withIsWebPublic(boolean isWebPublic)	Sets whether the newly created channel will be a web public channel.
CreateChannelApiRequest	withMessageRetentionDays(int messageRetentionDays)	Sets the number of days that messages sent to this channel will be stored before being automatically deleted by the message retention policy.
CreateChannelApiRequest	withSendNewSubscriptionMessages(boolean sendNewSubscriptionMessages)	Sets whether any other users newly subscribed via this request should be sent a notification bot direct message notifying them about their new subscription.
CreateChannelApiRequest	withTopicPolicy(TopicPolicy topicPolicy)	Sets whether named topics and the empty topic are enabled in this channel.

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

NAME

public static final String NAME

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

SUBSCRIBERS

public static final String SUBSCRIBERS

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_WEB_PUBLIC

public static final String IS_WEB_PUBLIC

See Also:

• Constant Field Values

IS_DEFAULT_STREAM

public static final String IS_DEFAULT_STREAM

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

TOPICS_POLICY

public static final String TOPICS_POLICY

See Also:

• Constant Field Values

HISTORY_PUBLIC_TO_SUBSCRIBERS

public static final String HISTORY_PUBLIC_TO_SUBSCRIBERS

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_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_REMOVE_SUBSCRIBERS_GROUP

public static final String CAN_REMOVE_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_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_RESOLVE_TOPICS_GROUP

public static final String CAN_RESOLVE_TOPICS_GROUP

See Also:

• Constant Field Values

Constructor Details

CreateChannelApiRequest

public CreateChannelApiRequest(ZulipHttpClient client,
 String name,
 Long... subscribers)

Constructs a ZulipApiRequest.

Parameters:

client - The Zulip HTTP client

name - The name of the channel

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

Method Details

withDescription

public CreateChannelApiRequest withDescription(String description)

Sets the description of the channel.

Parameters:

description - The channel description

Returns:

This CreateChannelApiRequest instance

See Also:

• https://zulip.com/api/create-channel#parameter-description

withAnnounce

public CreateChannelApiRequest withAnnounce(boolean announce)

Sets whether the notification bot will send an announcement about the new channel creation. https://zulip.com/api/create-channel#parameter-announce

Parameters:

announce - true to send an announcement. false to not send an announcement.

Returns:

This CreateChannelApiRequest instance

withInviteOnly

public CreateChannelApiRequest withInviteOnly(boolean inviteOnly)

Sets whether the newly created channel will be a private channel. https://zulip.com/api/create-channel#parameter-invite_only

Parameters:

inviteOnly - true to create the channel as a private channel. false to create as a public channel

Returns:

This CreateChannelApiRequest instance

withIsWebPublic

public CreateChannelApiRequest withIsWebPublic(boolean isWebPublic)

Sets whether the newly created channel will be a web public channel. https://zulip.com/api/create-channel#parameter-is_web_public

Parameters:

isWebPublic - true to create the channel as web public. false to not create as web public

Returns:

This CreateChannelApiRequest instance

withIsDefaultStream

public CreateChannelApiRequest withIsDefaultStream(boolean isDefaultStream)

Sets whether the newly created channel will be added as a default channel. https://zulip.com/api/create-channel#parameter-is_default_stream

Parameters:

isDefaultStream - true create the channel as a default channel. false to not create as a default channel

Returns:

This CreateChannelApiRequest instance

withFolderId

public CreateChannelApiRequest withFolderId(int folderId)

Sets the id of the folder to which the channel belongs.

Parameters:

folderId - The id of the folder

Returns:

This CreateChannelApiRequest instance

withSendNewSubscriptionMessages

public CreateChannelApiRequest withSendNewSubscriptionMessages(boolean sendNewSubscriptionMessages)

Sets whether any other users newly subscribed via this request should be sent a notification bot direct message notifying them about their new subscription.

Parameters:

sendNewSubscriptionMessages - true to have any other users newly subscribed via this request be sent a notification bot direct message. false to not have newly subscribed users notified

Returns:

This CreateChannelApiRequest instance

See Also:

• https://zulip.com/api/create-channel#parameter-send_new_subscription_messages

withTopicPolicy

public CreateChannelApiRequest withTopicPolicy(TopicPolicy topicPolicy)

Sets whether named topics and the empty topic are enabled in this channel. https://zulip.com/api/create-channel#parameter-topics_policy

Parameters:

topicPolicy - The TopicPolicy

Returns:

This CreateChannelApiRequest instance

withHistoryPublicToSubscribers

public CreateChannelApiRequest withHistoryPublicToSubscribers(boolean historyPublicToSubscribers)

Sets whether the channel message history should be available to newly subscribed members. https://zulip.com/api/create-channel#parameter-history_public_to_subscribers

Parameters:

historyPublicToSubscribers - true to make channel history available to newly subscribed members. false to make channel history unavailable to newly subscribed members

Returns:

This CreateChannelApiRequest instance

withMessageRetentionDays

public CreateChannelApiRequest withMessageRetentionDays(int messageRetentionDays)

Sets the number of days that messages sent to this channel will be stored before being automatically deleted by the message retention policy. https://zulip.com/api/create-channel#parameter-message_retention_days

Parameters:

messageRetentionDays - The number of days that messages sent to this channel will be stored before being automatically deleted by the message retention policy

Returns:

This CreateChannelApiRequest instance

withCanAddSubscribersGroup

public CreateChannelApiRequest withCanAddSubscribersGroup(UserGroupSetting userGroupSetting)

Sets the user group settings for users who have permission to add subscribers to this channel. https://zulip.com/api/create-channel#parameter-can_add_subscribers_group

Parameters:

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

Returns:

This CreateChannelApiRequest instance

withCanDeleteAnyMessageGroup

public CreateChannelApiRequest withCanDeleteAnyMessageGroup(UserGroupSetting userGroupSetting)

Sets the user group settings for users who have permission to delete any message in the channel. https://zulip.com/api/create-channel#parameter-can_delete_any_message_group

Parameters:

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

Returns:

This CreateChannelApiRequest instance

withCanDeleteOwnMessageGroup

public CreateChannelApiRequest withCanDeleteOwnMessageGroup(UserGroupSetting userGroupSetting)

Sets the user group settings for users who have permission to delete the messages that they have sent in the channel. https://zulip.com/api/create-channel#parameter-can_delete_own_message_group

Parameters:

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

Returns:

This CreateChannelApiRequest instance

withCanRemoveSubscribersGroup

public CreateChannelApiRequest withCanRemoveSubscribersGroup(UserGroupSetting userGroupSetting)

Sets the user group id whose members are allowed to unsubscribe others from the stream. https://zulip.com/api/create-channel#parameter-can_remove_subscribers_group

Parameters:

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

Returns:

This CreateChannelApiRequest instance

withCanAdministerChannelGroup

public CreateChannelApiRequest withCanAdministerChannelGroup(UserGroupSetting userGroupSetting)

Set the users who have permission to administer this stream. https://zulip.com/api/create-channel#parameter-can_administer_channel_group

Parameters:

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

Returns:

This CreateChannelApiRequest instance

withCanMoveMessagesOutOfChannelGroup

public CreateChannelApiRequest withCanMoveMessagesOutOfChannelGroup(UserGroupSetting userGroupSetting)

Sets the user group settings for users who have permission to move messages out of this channel. https://zulip.com/api/create-channel#parameter-can_move_messages_out_of_channel_group

Parameters:

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

Returns:

This CreateChannelApiRequest instance

withCanMoveMessagesWithinChannelGroup

public CreateChannelApiRequest withCanMoveMessagesWithinChannelGroup(UserGroupSetting userGroupSetting)

Sets the user group settings for users who have permission to move messages within this channel. https://zulip.com/api/create-channel#parameter-can_move_messages_within_channel_group

Parameters:

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

Returns:

This CreateChannelApiRequest instance

withCanSendMessageGroup

public CreateChannelApiRequest withCanSendMessageGroup(UserGroupSetting userGroupSetting)

Set the users who have permission to post in this stream. https://zulip.com/api/create-channel#parameter-can_send_message_group

Parameters:

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

Returns:

This CreateChannelApiRequest instance

withCanSubscribeGroup

public CreateChannelApiRequest withCanSubscribeGroup(UserGroupSetting userGroupSetting)

Sets the user group settings for users who have permission to subscribe themselves to this channel. https://zulip.com/api/create-channel#parameter-can_subscribe_group

Parameters:

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

Returns:

This CreateChannelApiRequest instance

withCanResolveTopicsGroup

public CreateChannelApiRequest withCanResolveTopicsGroup(UserGroupSetting userGroupSetting)

Sets the user group settings for users who have permission to resolve topics in the channel. https://zulip.com/api/create-channel#parameter-can_resolve_topics_group

Parameters:

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

Returns:

This CreateChannelApiRequest instance

execute

public Long execute()
             throws ZulipClientException

Executes the Zulip API request for creating new channel.

Specified by:

execute in interface ExecutableApiRequest<Long>

Returns:

The response for type T

Throws:

ZulipClientException - if the request was not successful