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

Class UpdateStreamSubscriptionSettingsApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<List<String>>

public class UpdateStreamSubscriptionSettingsApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<String>>

Zulip API request builder for updating stream subscription settings.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUDIBLE_NOTIFICATIONS
static final String	COLOR
static final String	DESKTOP_NOTIFICATIONS
static final String	EMAIL_NOTIFICATIONS
static final String	IS_MUTED
static final String	PIN_TO_TOP
static final String	PUSH_NOTIFICATIONS
static final String	SUBSCRIPTION_DATA
static final String	WILDCARD_MENTIONS_NOTIFY

Constructor Summary

Constructors

Constructor	Description
UpdateStreamSubscriptionSettingsApiRequest(ZulipHttpClient client)	Constructs a UpdateStreamSubscriptionSettingsApiRequest.

Method Summary

Modifier and Type	Method	Description
List<String>	execute()	Executes the Zulip API request for updating stream subscription settings.
UpdateStreamSubscriptionSettingsApiRequest	withAudibleNotifications(long streamId, boolean audibleNotifications)	Sets whether to play a sound for messages sent to the stream.
UpdateStreamSubscriptionSettingsApiRequest	withColor(long streamId, String color)	Sets the hex value of the color to display on the Zulip UI.
UpdateStreamSubscriptionSettingsApiRequest	withDesktopNotifications(long streamId, boolean desktopNotifications)	Sets whether to show desktop notifications for messages sent to the stream.
UpdateStreamSubscriptionSettingsApiRequest	withEmailNotifications(long streamId, boolean emailNotifications)	Sets whether to enable or disable email notifications a sound for messages sent to the stream.
UpdateStreamSubscriptionSettingsApiRequest	withIsMuted(long streamId, boolean muted)	Sets whether the stream should be muted.
UpdateStreamSubscriptionSettingsApiRequest	withPinToTop(long streamId, boolean pinToTop)	Sets whether the stream should be pinned to the top in the Zulip UI.
UpdateStreamSubscriptionSettingsApiRequest	withPushNotifications(long streamId, boolean pushNotifications)	Sets whether to enable or disable push notifications a sound for messages sent to the stream.
UpdateStreamSubscriptionSettingsApiRequest	withWildcardMentionsNotify(long streamId, boolean wildcardMentionsNotify)	Sets whether to enable or disable wildcard mentions trigger notifications for messages sent to the stream.

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

COLOR

public static final String COLOR

See Also:

• Constant Field Values

IS_MUTED

public static final String IS_MUTED

See Also:

• Constant Field Values

PIN_TO_TOP

public static final String PIN_TO_TOP

See Also:

• Constant Field Values

DESKTOP_NOTIFICATIONS

public static final String DESKTOP_NOTIFICATIONS

See Also:

• Constant Field Values

AUDIBLE_NOTIFICATIONS

public static final String AUDIBLE_NOTIFICATIONS

See Also:

• Constant Field Values

PUSH_NOTIFICATIONS

public static final String PUSH_NOTIFICATIONS

See Also:

• Constant Field Values

EMAIL_NOTIFICATIONS

public static final String EMAIL_NOTIFICATIONS

See Also:

• Constant Field Values

WILDCARD_MENTIONS_NOTIFY

public static final String WILDCARD_MENTIONS_NOTIFY

See Also:

• Constant Field Values

SUBSCRIPTION_DATA

public static final String SUBSCRIPTION_DATA

See Also:

• Constant Field Values

Constructor Details

UpdateStreamSubscriptionSettingsApiRequest

public UpdateStreamSubscriptionSettingsApiRequest(ZulipHttpClient client)

Constructs a UpdateStreamSubscriptionSettingsApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

withColor

public UpdateStreamSubscriptionSettingsApiRequest withColor(long streamId,
 String color)

Sets the hex value of the color to display on the Zulip UI.

Parameters:

streamId - The id of the stream for which the setting should be updated

color - The hex value of the color

Returns:

This UpdateStreamSubscriptionSettingsApiRequest instance

withIsMuted

public UpdateStreamSubscriptionSettingsApiRequest withIsMuted(long streamId,
 boolean muted)

Sets whether the stream should be muted.

Parameters:

streamId - The id of the stream for which the setting should be updated

muted - true to mute the stream. false to unmute the stream

Returns:

This UpdateStreamSubscriptionSettingsApiRequest instance

withPinToTop

public UpdateStreamSubscriptionSettingsApiRequest withPinToTop(long streamId,
 boolean pinToTop)

Sets whether the stream should be pinned to the top in the Zulip UI.

Parameters:

streamId - The id of the stream for which the setting should be updated

pinToTop - true to pin the stream to top. false to unpin the stream

Returns:

This UpdateStreamSubscriptionSettingsApiRequest instance

withDesktopNotifications

public UpdateStreamSubscriptionSettingsApiRequest withDesktopNotifications(long streamId,
 boolean desktopNotifications)

Sets whether to show desktop notifications for messages sent to the stream.

Parameters:

streamId - The id of the stream for which the setting should be updated

desktopNotifications - true to enable desktop notifications. false to disable desktop notifications.

Returns:

This UpdateStreamSubscriptionSettingsApiRequest instance

withAudibleNotifications

public UpdateStreamSubscriptionSettingsApiRequest withAudibleNotifications(long streamId,
 boolean audibleNotifications)

Sets whether to play a sound for messages sent to the stream.

Parameters:

streamId - The id of the stream for which the setting should be updated

audibleNotifications - true to enable audible notifications. false to disable audible notifications.

Returns:

This UpdateStreamSubscriptionSettingsApiRequest instance

withPushNotifications

public UpdateStreamSubscriptionSettingsApiRequest withPushNotifications(long streamId,
 boolean pushNotifications)

Sets whether to enable or disable push notifications a sound for messages sent to the stream.

Parameters:

streamId - The id of the stream for which the setting should be updated

pushNotifications - true to enable mobile push notifications. false to disable mobile push notifications.

Returns:

This UpdateStreamSubscriptionSettingsApiRequest instance

withEmailNotifications

public UpdateStreamSubscriptionSettingsApiRequest withEmailNotifications(long streamId,
 boolean emailNotifications)

Sets whether to enable or disable email notifications a sound for messages sent to the stream.

Parameters:

streamId - The id of the stream for which the setting should be updated

emailNotifications - true to enable email notifications. false to disable email notifications.

Returns:

This UpdateStreamSubscriptionSettingsApiRequest instance

withWildcardMentionsNotify

public UpdateStreamSubscriptionSettingsApiRequest withWildcardMentionsNotify(long streamId,
 boolean wildcardMentionsNotify)

Sets whether to enable or disable wildcard mentions trigger notifications for messages sent to the stream.

Parameters:

streamId - The id of the stream for which the setting should be updated

wildcardMentionsNotify - true to enable wildcard mentions trigger notifications. false to disable email notifications.

Returns:

This UpdateStreamSubscriptionSettingsApiRequest instance

execute

public List<String> execute()
                     throws ZulipClientException

Executes the Zulip API request for updating stream subscription settings.

Specified by:

execute in interface ExecutableApiRequest<List<String>>

Returns:

List of modified settings encapsulated by StreamSubscriptionSetting

Throws:

ZulipClientException - if the request was not successful