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

Class UpdateOwnUserSettingsApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.user.request.UpdateOwnUserSettingsApiRequest

All Implemented Interfaces:

ExecutableApiRequest<List<String>>

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

Zulip API request builder for updating own user settings.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_PRIVATE_DATA_EXPORT
static final String	COLOR_SCHEME
static final String	DEFAULT_LANGUAGE
static final String	DEFAULT_VIEW
static final String	DEMOTE_INACTIVE_STREAMS
static final String	DESKTOP_ICON_COUNT_DISPLAY
static final String	DISPLAY_EMOJI_REACTION_USERS
static final String	EMAIL
static final String	EMAIL_NOTIFICATIONS_BATCHING_PERIOD_SECONDS
static final String	EMOJISET
static final String	ENABLE_DESKTOP_NOTIFICATIONS
static final String	ENABLE_DIGEST_EMAILS
static final String	ENABLE_DRAFTS_SYNCHRONIZATION
static final String	ENABLE_LOGIN_EMAILS
static final String	ENABLE_MARKETING_EMAILS
static final String	ENABLE_OFFLINE_EMAIL_NOTIFICATIONS
static final String	ENABLE_OFFLINE_PUSH_NOTIFICATIONS
static final String	ENABLE_ONLINE_PUSH_NOTIFICATIONS
static final String	ENABLE_SOUNDS
static final String	ENABLE_STREAM_AUDIBLE_NOTIFICATIONS
static final String	ENABLE_STREAM_DESKTOP_NOTIFICATIONS
static final String	ENABLE_STREAM_EMAIL_NOTIFICATIONS
static final String	ENABLE_STREAM_PUSH_NOTIFICATIONS
static final String	ENTER_SENDS
static final String	ESCAPE_NAVIGATES_TO_DEFAULT_VIEW
static final String	FLUID_LAYOUT_WIDTH
static final String	FULL_NAME
static final String	HIDE_AI_FEATURES
static final String	HIGH_CONTRAST_MODE
static final String	LEFT_SIDE_USERLIST
static final String	MESSAGE_CONTENT_IN_EMAIL_NOTIFICATIONS
static final String	NEW_PASSWORD
static final String	NOTIFICATION_SOUND
static final String	OLD_PASSWORD
static final String	PM_CONTENT_IN_DESKTOP_NOTIFICATIONS
static final String	PRESENCE_ENABLED
static final String	REALM_NAME_IN_EMAIL_NOTIFICATIONS_POLICY
static final String	REALM_NAME_IN_NOTIFICATIONS
static final String	RECEIVES_TYPING_NOTIFICATIONS
static final String	SEND_PRIVATE_TYPING_NOTIFICATIONS
static final String	SEND_READ_RECEIPTS
static final String	SEND_STREAM_TYPING_NOTIFICATIONS
static final String	STARRED_MESSAGE_COUNTS
static final String	TIMEZONE
static final String	TRANSLATE_EMOTICONS
static final String	TWENTY_FOUR_HOUR_TIME
static final String	USER_LIST_STYLE
static final String	WEB_ANIMATE_IMAGE_PREVIEWS
static final String	WEB_CHANNEL_DEFAULT_VIEW
static final String	WEB_FONT_SIZE_PX
static final String	WEB_LINE_HEIGHT_PERCENT
static final String	WEB_MARK_READ_ON_SCROLL_POLICY
static final String	WEB_NAVIGATE_TO_SENT_MESSAGE
static final String	WEB_SUGGEST_UPDATE_TIMEZONE
static final String	WILDCARD_MENTIONS_NOTIFY

Constructor Summary

Constructors

Constructor	Description
UpdateOwnUserSettingsApiRequest(ZulipHttpClient client)	Constructs a UpdateOwnUserSettingsApiRequest.

Method Summary

Modifier and Type	Method	Description
List<String>	execute()	Executes the Zulip API request for updating own user settings.
UpdateOwnUserSettingsApiRequest	withAllowPrivateDataExport(boolean allowPrivateDataExport)	Sets whether organization administrators are allowed to export private data.
UpdateOwnUserSettingsApiRequest	withColorScheme(ColorScheme colorScheme)	Sets whether stream desktop notifications should be enabled.
UpdateOwnUserSettingsApiRequest	withDefaultLanguage(String languageCode)	Sets the default language to use.
UpdateOwnUserSettingsApiRequest	withDefaultView(WebHomeView webHomeView)	Sets the default view to use.
UpdateOwnUserSettingsApiRequest	withDemoteInactiveStreams(DemoteInactiveStreamOption demoteInactiveStreamOption)	Sets whether to demote inactive streams.
UpdateOwnUserSettingsApiRequest	withDesktopIconCountDisplay(DesktopIconCountDisplay desktopIconCountDisplay)	Sets whether to display an unread count summary on the Zulip UI.
UpdateOwnUserSettingsApiRequest	withDisplayEmojiReactionUsers(boolean displayEmojiReactionUsers)	Sets whether to display the names of reacting users on a message.
UpdateOwnUserSettingsApiRequest	withEmail(String email)	Asks the Zulip server to initiate a confirmation sequence to change the user email address.
UpdateOwnUserSettingsApiRequest	withEmailNotificationsBatchingPeriodSeconds(int duration)	Sets the duration in seconds for which the Zulip server should wait to batch email notifications before sending them.
UpdateOwnUserSettingsApiRequest	withEmojiSet(EmojiSet emojiSet)	The emoji set used to display emoji on the Zulip UI.
UpdateOwnUserSettingsApiRequest	withEnableDesktopNotifications(boolean enable)	Sets whether desktop notifications are enabled.
UpdateOwnUserSettingsApiRequest	withEnableDigestEmails(boolean enable)	Sets whether digest emails are enabled.
UpdateOwnUserSettingsApiRequest	withEnableDraftsSynchronization(boolean enable)	Sets whether synchronizing drafts is enabled.
UpdateOwnUserSettingsApiRequest	withEnableLoginEmails(boolean enable)	Sets whether login emails are enabled.
UpdateOwnUserSettingsApiRequest	withEnableMarketingEmails(boolean enable)	Sets whether to enable marketing emails.
UpdateOwnUserSettingsApiRequest	withEnableOfflineEmailNotifications(boolean enable)	Sets whether offline email notifications are enabled.
UpdateOwnUserSettingsApiRequest	withEnableOfflinePushNotifications(boolean enable)	Sets whether offline push notifications are enabled.
UpdateOwnUserSettingsApiRequest	withEnableOnlinePushNotifications(boolean enable)	Sets whether online push notifications are enabled.
UpdateOwnUserSettingsApiRequest	withEnableSounds(boolean enable)	Sets whether sounds are enabled.
UpdateOwnUserSettingsApiRequest	withEnableStreamAudibleNotifications(boolean enable)	Sets whether stream audible notifications should be enabled.
UpdateOwnUserSettingsApiRequest	withEnableStreamDesktopNotifications(boolean enable)	Sets whether stream desktop notifications should be enabled.
UpdateOwnUserSettingsApiRequest	withEnableStreamEmailNotifications(boolean enable)	Sets whether stream email notifications should be enabled.
UpdateOwnUserSettingsApiRequest	withEnableStreamPushNotifications(boolean enable)	Sets whether stream push notifications should be enabled.
UpdateOwnUserSettingsApiRequest	withEnterSends(boolean enterSends)	Sets whether pressing the enter key on the Zulip UI sends a message.
UpdateOwnUserSettingsApiRequest	withEscapeNavigatesToDefaultView(boolean escapeNavigatesToDefaultView)	Sets whether pressing the escape key navigates to the default view.
UpdateOwnUserSettingsApiRequest	withFluidLayoutWidth(boolean fluidLayoutWidth)	Whether to use the maximum available screen width for the Zulip web UI center panel.
UpdateOwnUserSettingsApiRequest	withFullName(String fullName)	Sets a new display name for the user.
UpdateOwnUserSettingsApiRequest	withHideAiFeatures(boolean hideAiFeatures)	Sets whether AI features like topic summarization should be hidden.
UpdateOwnUserSettingsApiRequest	withHighContrastMode(boolean highContrastMode)	Whether to enable variations in the Zulip UI to help visually impaired users.
UpdateOwnUserSettingsApiRequest	withLeftSideUserList(boolean leftSideUserList)	Whether the users list on left sidebar in narrow windows.
UpdateOwnUserSettingsApiRequest	withMessageContentInEmailNotifications(boolean messageContentInEmailNotifications)	Sets whether message content is present in email notifications.
UpdateOwnUserSettingsApiRequest	withNewPassword(String newPassword)	The new password for the current user.
UpdateOwnUserSettingsApiRequest	withNotificationSound(String notificationSound)	Sets the notification sound.
UpdateOwnUserSettingsApiRequest	withOldPassword(String oldPassword)	The old password for the current user.
UpdateOwnUserSettingsApiRequest	withPmContentInDesktopNotifications(boolean pmContentInDesktopNotifications)	Sets whether private message content shows in desktop notifications.
UpdateOwnUserSettingsApiRequest	withPresenceEnabled(boolean enable)	Sets whether to display the presence status to other users when online.
UpdateOwnUserSettingsApiRequest	withRealmNameInEmailNotifications(RealmNameInNotificationsPolicy policy)	Sets whether to include the organization name in the subject of message notification emails.
UpdateOwnUserSettingsApiRequest	withRealmNameInNotifications(boolean realmNameInNotifications)	Deprecated. Use withRealmNameInEmailNotifications instead
UpdateOwnUserSettingsApiRequest	withReceivesTypingNotifications(boolean receivesTypingNotifications)	Sets whether the user is configured to receive typing notifications from other users.
UpdateOwnUserSettingsApiRequest	withSendPrivateTypingNotifications(boolean sendPrivateTypingNotifications)	Sets whether typing notifications be sent when composing private messages.
UpdateOwnUserSettingsApiRequest	withSendReadReceipts(boolean sendReadReceipts)	Sets whether other users are allowed to see whether you have read messages.
UpdateOwnUserSettingsApiRequest	withSendStreamTypingNotifications(boolean sendStreamTypingNotifications)	Sets whether typing notifications be sent when composing stream messages.
UpdateOwnUserSettingsApiRequest	withStarredMessageCounts(boolean starredMessageCounts)	Sets whether to display the number of starred messages.
UpdateOwnUserSettingsApiRequest	withTimezone(String timezone)	Sets the user configured timezone.
UpdateOwnUserSettingsApiRequest	withTranslateEmoticons(boolean translateEmoticons)	Sets whether to translate emoticons to emoji in messages the user sends.
UpdateOwnUserSettingsApiRequest	withTwentyFourHourTime(boolean enable)	Sets whether time should be displayed in 24-hour notation.
UpdateOwnUserSettingsApiRequest	withUserListStyle(UserListStyle userListStyle)	Sets the style selected by the user for the right sidebar user list.
UpdateOwnUserSettingsApiRequest	withWebAnimateImagePreviews(WebAnimateImageOption webAnimateImageOption)	Sets how animated images should be played in the message feed.
UpdateOwnUserSettingsApiRequest	withWebChannelDefaultView(WebChannelView webChannelView)	Sets the default navigation behavior when clicking on a channel link.
UpdateOwnUserSettingsApiRequest	withWebFontPx(int fontSize)	Sets the user primary font size in pixels.
UpdateOwnUserSettingsApiRequest	withWebLineHeightPercent(int webLineHeightPercent)	Sets the user primary line height for the Zulip web UI in percent.
UpdateOwnUserSettingsApiRequest	withWebMarkReadOnScrollPolicy(MarkReadOnScrollPolicy policy)	Sets whether to mark messages as read when the user scrolls through their feed.
UpdateOwnUserSettingsApiRequest	withWebNavigateToSentMessage(boolean webNavigateToSentMessage)	Sets whether the user view should automatically go to the conversation where they sent a message.
UpdateOwnUserSettingsApiRequest	withWebSuggestUpdateTimezone(boolean webSuggestUpdateTimezone)	Sets whether the user should be shown an alert, offering to update their profile time zone, when the time displayed for the profile time zone differs from the current time displayed by the time zone configured on their device.
UpdateOwnUserSettingsApiRequest	withWildcardMentionsNotify(boolean wildcardMentionsNotify)	Sets whether to be notified when wildcard mentions are triggered.

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

ALLOW_PRIVATE_DATA_EXPORT

public static final String ALLOW_PRIVATE_DATA_EXPORT

See Also:

• Constant Field Values

COLOR_SCHEME

public static final String COLOR_SCHEME

See Also:

• Constant Field Values

DEFAULT_LANGUAGE

public static final String DEFAULT_LANGUAGE

See Also:

• Constant Field Values

DEFAULT_VIEW

public static final String DEFAULT_VIEW

See Also:

• Constant Field Values

DEMOTE_INACTIVE_STREAMS

public static final String DEMOTE_INACTIVE_STREAMS

See Also:

• Constant Field Values

DESKTOP_ICON_COUNT_DISPLAY

public static final String DESKTOP_ICON_COUNT_DISPLAY

See Also:

• Constant Field Values

DISPLAY_EMOJI_REACTION_USERS

public static final String DISPLAY_EMOJI_REACTION_USERS

See Also:

• Constant Field Values

EMAIL

public static final String EMAIL

See Also:

• Constant Field Values

EMOJISET

public static final String EMOJISET

See Also:

• Constant Field Values

ENABLE_DESKTOP_NOTIFICATIONS

public static final String ENABLE_DESKTOP_NOTIFICATIONS

See Also:

• Constant Field Values

ENABLE_DRAFTS_SYNCHRONIZATION

public static final String ENABLE_DRAFTS_SYNCHRONIZATION

See Also:

• Constant Field Values

ENABLE_DIGEST_EMAILS

public static final String ENABLE_DIGEST_EMAILS

See Also:

• Constant Field Values

ENABLE_LOGIN_EMAILS

public static final String ENABLE_LOGIN_EMAILS

See Also:

• Constant Field Values

EMAIL_NOTIFICATIONS_BATCHING_PERIOD_SECONDS

public static final String EMAIL_NOTIFICATIONS_BATCHING_PERIOD_SECONDS

See Also:

• Constant Field Values

ENABLE_MARKETING_EMAILS

public static final String ENABLE_MARKETING_EMAILS

See Also:

• Constant Field Values

ENABLE_OFFLINE_EMAIL_NOTIFICATIONS

public static final String ENABLE_OFFLINE_EMAIL_NOTIFICATIONS

See Also:

• Constant Field Values

ENABLE_OFFLINE_PUSH_NOTIFICATIONS

public static final String ENABLE_OFFLINE_PUSH_NOTIFICATIONS

See Also:

• Constant Field Values

ENABLE_ONLINE_PUSH_NOTIFICATIONS

public static final String ENABLE_ONLINE_PUSH_NOTIFICATIONS

See Also:

• Constant Field Values

ENABLE_SOUNDS

public static final String ENABLE_SOUNDS

See Also:

• Constant Field Values

ENABLE_STREAM_DESKTOP_NOTIFICATIONS

public static final String ENABLE_STREAM_DESKTOP_NOTIFICATIONS

See Also:

• Constant Field Values

ENABLE_STREAM_EMAIL_NOTIFICATIONS

public static final String ENABLE_STREAM_EMAIL_NOTIFICATIONS

See Also:

• Constant Field Values

ENABLE_STREAM_PUSH_NOTIFICATIONS

public static final String ENABLE_STREAM_PUSH_NOTIFICATIONS

See Also:

• Constant Field Values

ENABLE_STREAM_AUDIBLE_NOTIFICATIONS

public static final String ENABLE_STREAM_AUDIBLE_NOTIFICATIONS

See Also:

• Constant Field Values

ENTER_SENDS

public static final String ENTER_SENDS

See Also:

• Constant Field Values

ESCAPE_NAVIGATES_TO_DEFAULT_VIEW

public static final String ESCAPE_NAVIGATES_TO_DEFAULT_VIEW

See Also:

• Constant Field Values

FLUID_LAYOUT_WIDTH

public static final String FLUID_LAYOUT_WIDTH

See Also:

• Constant Field Values

FULL_NAME

public static final String FULL_NAME

See Also:

• Constant Field Values

HIDE_AI_FEATURES

public static final String HIDE_AI_FEATURES

See Also:

• Constant Field Values

HIGH_CONTRAST_MODE

public static final String HIGH_CONTRAST_MODE

See Also:

• Constant Field Values

LEFT_SIDE_USERLIST

public static final String LEFT_SIDE_USERLIST

See Also:

• Constant Field Values

MESSAGE_CONTENT_IN_EMAIL_NOTIFICATIONS

public static final String MESSAGE_CONTENT_IN_EMAIL_NOTIFICATIONS

See Also:

• Constant Field Values

NEW_PASSWORD

public static final String NEW_PASSWORD

See Also:

• Constant Field Values

NOTIFICATION_SOUND

public static final String NOTIFICATION_SOUND

See Also:

• Constant Field Values

OLD_PASSWORD

public static final String OLD_PASSWORD

See Also:

• Constant Field Values

PM_CONTENT_IN_DESKTOP_NOTIFICATIONS

public static final String PM_CONTENT_IN_DESKTOP_NOTIFICATIONS

See Also:

• Constant Field Values

PRESENCE_ENABLED

public static final String PRESENCE_ENABLED

See Also:

• Constant Field Values

REALM_NAME_IN_NOTIFICATIONS

public static final String REALM_NAME_IN_NOTIFICATIONS

See Also:

• Constant Field Values

REALM_NAME_IN_EMAIL_NOTIFICATIONS_POLICY

public static final String REALM_NAME_IN_EMAIL_NOTIFICATIONS_POLICY

See Also:

• Constant Field Values

RECEIVES_TYPING_NOTIFICATIONS

public static final String RECEIVES_TYPING_NOTIFICATIONS

See Also:

• Constant Field Values

SEND_PRIVATE_TYPING_NOTIFICATIONS

public static final String SEND_PRIVATE_TYPING_NOTIFICATIONS

See Also:

• Constant Field Values

SEND_READ_RECEIPTS

public static final String SEND_READ_RECEIPTS

See Also:

• Constant Field Values

SEND_STREAM_TYPING_NOTIFICATIONS

public static final String SEND_STREAM_TYPING_NOTIFICATIONS

See Also:

• Constant Field Values

STARRED_MESSAGE_COUNTS

public static final String STARRED_MESSAGE_COUNTS

See Also:

• Constant Field Values

TIMEZONE

public static final String TIMEZONE

See Also:

• Constant Field Values

TRANSLATE_EMOTICONS

public static final String TRANSLATE_EMOTICONS

See Also:

• Constant Field Values

TWENTY_FOUR_HOUR_TIME

public static final String TWENTY_FOUR_HOUR_TIME

See Also:

• Constant Field Values

USER_LIST_STYLE

public static final String USER_LIST_STYLE

See Also:

• Constant Field Values

WEB_ANIMATE_IMAGE_PREVIEWS

public static final String WEB_ANIMATE_IMAGE_PREVIEWS

See Also:

• Constant Field Values

WEB_CHANNEL_DEFAULT_VIEW

public static final String WEB_CHANNEL_DEFAULT_VIEW

See Also:

• Constant Field Values

WEB_FONT_SIZE_PX

public static final String WEB_FONT_SIZE_PX

See Also:

• Constant Field Values

WEB_LINE_HEIGHT_PERCENT

public static final String WEB_LINE_HEIGHT_PERCENT

See Also:

• Constant Field Values

WEB_MARK_READ_ON_SCROLL_POLICY

public static final String WEB_MARK_READ_ON_SCROLL_POLICY

See Also:

• Constant Field Values

WEB_NAVIGATE_TO_SENT_MESSAGE

public static final String WEB_NAVIGATE_TO_SENT_MESSAGE

See Also:

• Constant Field Values

WEB_SUGGEST_UPDATE_TIMEZONE

public static final String WEB_SUGGEST_UPDATE_TIMEZONE

See Also:

• Constant Field Values

WILDCARD_MENTIONS_NOTIFY

public static final String WILDCARD_MENTIONS_NOTIFY

See Also:

• Constant Field Values

Constructor Details

UpdateOwnUserSettingsApiRequest

public UpdateOwnUserSettingsApiRequest(ZulipHttpClient client)

Constructs a UpdateOwnUserSettingsApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

withAllowPrivateDataExport

public UpdateOwnUserSettingsApiRequest withAllowPrivateDataExport(boolean allowPrivateDataExport)

Sets whether organization administrators are allowed to export private data.

Parameters:

allowPrivateDataExport - true to allow organization administrators to export private data. false to disallow organization administrators from exporting private data

Returns:

This UpdateOwnUserSettingsApiRequest instance

withColorScheme

public UpdateOwnUserSettingsApiRequest withColorScheme(ColorScheme colorScheme)

Sets whether stream desktop notifications should be enabled.

Parameters:

colorScheme - The color scheme to use

Returns:

This UpdateOwnUserSettingsApiRequest instance

withDefaultLanguage

public UpdateOwnUserSettingsApiRequest withDefaultLanguage(String languageCode)

Sets the default language to use.

Parameters:

languageCode - The language code to use. E.g 'en' for English, 'de' for German etc

Returns:

This UpdateOwnUserSettingsApiRequest instance

See Also:

• https://zulip.com/help/change-your-language

withDefaultView

public UpdateOwnUserSettingsApiRequest withDefaultView(WebHomeView webHomeView)

Sets the default view to use.

Parameters:

webHomeView - The default view to use

Returns:

This UpdateOwnUserSettingsApiRequest instance

See Also:

• https://zulip.com/help/configure-default-view

withDemoteInactiveStreams

public UpdateOwnUserSettingsApiRequest withDemoteInactiveStreams(DemoteInactiveStreamOption demoteInactiveStreamOption)

Sets whether to demote inactive streams.

Parameters:

demoteInactiveStreamOption - The option to control how inactive streams are demoted

Returns:

This UpdateOwnUserSettingsApiRequest instance

See Also:

• https://zulip.com/help/manage-inactive-streams

withDesktopIconCountDisplay

public UpdateOwnUserSettingsApiRequest withDesktopIconCountDisplay(DesktopIconCountDisplay desktopIconCountDisplay)

Sets whether to display an unread count summary on the Zulip UI.

Parameters:

desktopIconCountDisplay - The DesktopIconCountDisplay setting

Returns:

This UpdateOwnUserSettingsApiRequest instance

withDisplayEmojiReactionUsers

public UpdateOwnUserSettingsApiRequest withDisplayEmojiReactionUsers(boolean displayEmojiReactionUsers)

Sets whether to display the names of reacting users on a message.

Parameters:

displayEmojiReactionUsers - true to to display the names of reacting users on a message. false to not display the names of reacting users on a message

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEmailNotificationsBatchingPeriodSeconds

public UpdateOwnUserSettingsApiRequest withEmailNotificationsBatchingPeriodSeconds(int duration)

Sets the duration in seconds for which the Zulip server should wait to batch email notifications before sending them.

Parameters:

duration - The batching period duration in seconds

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEmail

public UpdateOwnUserSettingsApiRequest withEmail(String email)

Asks the Zulip server to initiate a confirmation sequence to change the user email address.

Parameters:

email - The new email address to switch to

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEmojiSet

public UpdateOwnUserSettingsApiRequest withEmojiSet(EmojiSet emojiSet)

The emoji set used to display emoji on the Zulip UI.

Parameters:

emojiSet - The emoji set to use

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEnableDesktopNotifications

public UpdateOwnUserSettingsApiRequest withEnableDesktopNotifications(boolean enable)

Sets whether desktop notifications are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEnableDigestEmails

public UpdateOwnUserSettingsApiRequest withEnableDigestEmails(boolean enable)

Sets whether digest emails are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEnableDraftsSynchronization

public UpdateOwnUserSettingsApiRequest withEnableDraftsSynchronization(boolean enable)

Sets whether synchronizing drafts is enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEnableLoginEmails

public UpdateOwnUserSettingsApiRequest withEnableLoginEmails(boolean enable)

Sets whether login emails are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEnableMarketingEmails

public UpdateOwnUserSettingsApiRequest withEnableMarketingEmails(boolean enable)

Sets whether to enable marketing emails.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEnableOfflineEmailNotifications

public UpdateOwnUserSettingsApiRequest withEnableOfflineEmailNotifications(boolean enable)

Sets whether offline email notifications are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEnableOfflinePushNotifications

public UpdateOwnUserSettingsApiRequest withEnableOfflinePushNotifications(boolean enable)

Sets whether offline push notifications are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEnableOnlinePushNotifications

public UpdateOwnUserSettingsApiRequest withEnableOnlinePushNotifications(boolean enable)

Sets whether online push notifications are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEnableSounds

public UpdateOwnUserSettingsApiRequest withEnableSounds(boolean enable)

Sets whether sounds are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEnableStreamAudibleNotifications

public UpdateOwnUserSettingsApiRequest withEnableStreamAudibleNotifications(boolean enable)

Sets whether stream audible notifications should be enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEnableStreamDesktopNotifications

public UpdateOwnUserSettingsApiRequest withEnableStreamDesktopNotifications(boolean enable)

Sets whether stream desktop notifications should be enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEnableStreamEmailNotifications

public UpdateOwnUserSettingsApiRequest withEnableStreamEmailNotifications(boolean enable)

Sets whether stream email notifications should be enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEnableStreamPushNotifications

public UpdateOwnUserSettingsApiRequest withEnableStreamPushNotifications(boolean enable)

Sets whether stream push notifications should be enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEnterSends

public UpdateOwnUserSettingsApiRequest withEnterSends(boolean enterSends)

Sets whether pressing the enter key on the Zulip UI sends a message.

Parameters:

enterSends - true causes the enter key press to send the message. false does not send a message when the enter key is pressed

Returns:

This UpdateOwnUserSettingsApiRequest instance

withEscapeNavigatesToDefaultView

public UpdateOwnUserSettingsApiRequest withEscapeNavigatesToDefaultView(boolean escapeNavigatesToDefaultView)

Sets whether pressing the escape key navigates to the default view.

Parameters:

escapeNavigatesToDefaultView - true causes the escape key press to navigate to the default view. false the default view is not navigated to when the escape key is pressed

Returns:

This UpdateOwnUserSettingsApiRequest instance

See Also:

• https://zulip.com/help/configure-default-view

withFluidLayoutWidth

public UpdateOwnUserSettingsApiRequest withFluidLayoutWidth(boolean fluidLayoutWidth)

Whether to use the maximum available screen width for the Zulip web UI center panel.

Parameters:

fluidLayoutWidth - true causes the Zulip UI to use the maximum available screen width for the center panel. false causes the UI to not use the maximum available width for the UI center panel

Returns:

This UpdateOwnUserSettingsApiRequest instance

withFullName

public UpdateOwnUserSettingsApiRequest withFullName(String fullName)

Sets a new display name for the user.

Parameters:

fullName - true The new display name.

Returns:

This UpdateOwnUserSettingsApiRequest instance

withHideAiFeatures

public UpdateOwnUserSettingsApiRequest withHideAiFeatures(boolean hideAiFeatures)

Sets whether AI features like topic summarization should be hidden.

Parameters:

hideAiFeatures - true to hide AI features. false to not hide AI features.

Returns:

This UpdateOwnUserSettingsApiRequest instance

withHighContrastMode

public UpdateOwnUserSettingsApiRequest withHighContrastMode(boolean highContrastMode)

Whether to enable variations in the Zulip UI to help visually impaired users.

Parameters:

highContrastMode - true enables high contrast mode. false disables high contrast mode

Returns:

This UpdateOwnUserSettingsApiRequest instance

withLeftSideUserList

public UpdateOwnUserSettingsApiRequest withLeftSideUserList(boolean leftSideUserList)

Whether the users list on left sidebar in narrow windows.

Parameters:

leftSideUserList - true makes the users list appear on the left side bar in the Zulip web UI. false places the users list elsewhere in the Web UI

Returns:

This UpdateOwnUserSettingsApiRequest instance

withMessageContentInEmailNotifications

public UpdateOwnUserSettingsApiRequest withMessageContentInEmailNotifications(boolean messageContentInEmailNotifications)

Sets whether message content is present in email notifications.

Parameters:

messageContentInEmailNotifications - true to show message content in email notifications. false to not show message content in email notifications

Returns:

This UpdateOwnUserSettingsApiRequest instance

withNewPassword

public UpdateOwnUserSettingsApiRequest withNewPassword(String newPassword)

The new password for the current user. Must be set in conjunction with withOldPassword(String) ()}

Parameters:

newPassword - the new password

Returns:

This UpdateOwnUserSettingsApiRequest instance

withNotificationSound

public UpdateOwnUserSettingsApiRequest withNotificationSound(String notificationSound)

Sets the notification sound.

Parameters:

notificationSound - The name of the notification sound to play

Returns:

This UpdateOwnUserSettingsApiRequest instance

withOldPassword

public UpdateOwnUserSettingsApiRequest withOldPassword(String oldPassword)

The old password for the current user. Must be set in conjunction with withNewPassword(String) ()}

Parameters:

oldPassword - the old password

Returns:

This UpdateOwnUserSettingsApiRequest instance

withPmContentInDesktopNotifications

public UpdateOwnUserSettingsApiRequest withPmContentInDesktopNotifications(boolean pmContentInDesktopNotifications)

Sets whether private message content shows in desktop notifications.

Parameters:

pmContentInDesktopNotifications - true to have private message content show in desktop notifications. false to not have private message content show in desktop notifications

Returns:

This UpdateOwnUserSettingsApiRequest instance

withPresenceEnabled

public UpdateOwnUserSettingsApiRequest withPresenceEnabled(boolean enable)

Sets whether to display the presence status to other users when online.

Parameters:

enable - true to display the presence status to other users when online. false to not display the presence status to other users when online

Returns:

This UpdateOwnUserSettingsApiRequest instance

withRealmNameInNotifications

@Deprecated
public UpdateOwnUserSettingsApiRequest withRealmNameInNotifications(boolean realmNameInNotifications)

Deprecated.

Use withRealmNameInEmailNotifications instead

Sets whether to include organization name in subject of missed message emails.

Parameters:

realmNameInNotifications - true to include the organization name in the subject of missed message emails. false to not include the organization name in the subject of missed message emails

Returns:

This UpdateOwnUserSettingsApiRequest instance

withRealmNameInEmailNotifications

public UpdateOwnUserSettingsApiRequest withRealmNameInEmailNotifications(RealmNameInNotificationsPolicy policy)

Sets whether to include the organization name in the subject of message notification emails.

Parameters:

policy - The RealmNameInNotificationsPolicy to determine whether to include the organization name in the subject of message notification emails

Returns:

This UpdateOwnUserSettingsApiRequest instance

withReceivesTypingNotifications

public UpdateOwnUserSettingsApiRequest withReceivesTypingNotifications(boolean receivesTypingNotifications)

Sets whether the user is configured to receive typing notifications from other users.

Parameters:

receivesTypingNotifications - true to receive typing notifications from other users. false to not receive typing notifications from other users.

Returns:

This UpdateOwnUserSettingsApiRequest instance

withSendPrivateTypingNotifications

public UpdateOwnUserSettingsApiRequest withSendPrivateTypingNotifications(boolean sendPrivateTypingNotifications)

Sets whether typing notifications be sent when composing private messages.

Parameters:

sendPrivateTypingNotifications - true to send typing notifications. false to not send typing notifications

Returns:

This UpdateOwnUserSettingsApiRequest instance

See Also:

• https://zulip.com/help/status-and-availability#typing-notifications

withSendReadReceipts

public UpdateOwnUserSettingsApiRequest withSendReadReceipts(boolean sendReadReceipts)

Sets whether other users are allowed to see whether you have read messages.

Parameters:

sendReadReceipts - true to allow others see whether you have read messages. false to disallow users seeing whether you have read messages

Returns:

This UpdateOwnUserSettingsApiRequest instance

withSendStreamTypingNotifications

public UpdateOwnUserSettingsApiRequest withSendStreamTypingNotifications(boolean sendStreamTypingNotifications)

Sets whether typing notifications be sent when composing stream messages.

Parameters:

sendStreamTypingNotifications - true to send typing notifications. false to not send typing notifications

Returns:

This UpdateOwnUserSettingsApiRequest instance

See Also:

• https://zulip.com/help/status-and-availability#typing-notifications

withStarredMessageCounts

public UpdateOwnUserSettingsApiRequest withStarredMessageCounts(boolean starredMessageCounts)

Sets whether to display the number of starred messages.

Parameters:

starredMessageCounts - true to display the number of starred messages. false to not display the number of starred messages

Returns:

This UpdateOwnUserSettingsApiRequest instance

See Also:

• https://zulip.com/help/star-a-message#display-the-number-of-starred-messages

withTimezone

public UpdateOwnUserSettingsApiRequest withTimezone(String timezone)

Sets the user configured timezone.

Parameters:

timezone - The users timezone

Returns:

This UpdateOwnUserSettingsApiRequest instance

See Also:

• https://zulip.com/help/change-your-timezone
• https://zulip.com/static/generated/timezones.json

withTranslateEmoticons

public UpdateOwnUserSettingsApiRequest withTranslateEmoticons(boolean translateEmoticons)

Sets whether to translate emoticons to emoji in messages the user sends.

Parameters:

translateEmoticons - true to translate emoticons to emoji. false to not translate emoticons

Returns:

This UpdateOwnUserSettingsApiRequest instance

See Also:

• https://zulip.com/help/enable-emoticon-translations

withTwentyFourHourTime

public UpdateOwnUserSettingsApiRequest withTwentyFourHourTime(boolean enable)

Sets whether time should be displayed in 24-hour notation.

Parameters:

enable - true to display the time in 24-hour notation. false to not display time in 24-hour notation

Returns:

This UpdateOwnUserSettingsApiRequest instance

See Also:

• https://zulip.com/help/change-the-time-format

withUserListStyle

public UpdateOwnUserSettingsApiRequest withUserListStyle(UserListStyle userListStyle)

Sets the style selected by the user for the right sidebar user list.

Parameters:

userListStyle - for the style selected by the user for the right sidebar user list

Returns:

This UpdateOwnUserSettingsApiRequest instance

withWebAnimateImagePreviews

public UpdateOwnUserSettingsApiRequest withWebAnimateImagePreviews(WebAnimateImageOption webAnimateImageOption)

Sets how animated images should be played in the message feed.

Parameters:

webAnimateImageOption - The option determining how animated images should be played

Returns:

This UpdateOwnUserSettingsApiRequest instance

withWebChannelDefaultView

public UpdateOwnUserSettingsApiRequest withWebChannelDefaultView(WebChannelView webChannelView)

Sets the default navigation behavior when clicking on a channel link.

Parameters:

webChannelView - for the default channel view

Returns:

This UpdateOwnUserSettingsApiRequest instance

withWebFontPx

public UpdateOwnUserSettingsApiRequest withWebFontPx(int fontSize)

Sets the user primary font size in pixels.

Parameters:

fontSize - The size of the font used on the Zulip web UI

Returns:

This UpdateOwnUserSettingsApiRequest instance

withWebLineHeightPercent

public UpdateOwnUserSettingsApiRequest withWebLineHeightPercent(int webLineHeightPercent)

Sets the user primary line height for the Zulip web UI in percent.

Parameters:

webLineHeightPercent - The line height percentage value

Returns:

This UpdateOwnUserSettingsApiRequest instance

withWebMarkReadOnScrollPolicy

public UpdateOwnUserSettingsApiRequest withWebMarkReadOnScrollPolicy(MarkReadOnScrollPolicy policy)

Sets whether to mark messages as read when the user scrolls through their feed.

Parameters:

policy - The MarkReadOnScrollPolicy to determine whether when messages are marked as read

Returns:

This UpdateOwnUserSettingsApiRequest instance

withWebNavigateToSentMessage

public UpdateOwnUserSettingsApiRequest withWebNavigateToSentMessage(boolean webNavigateToSentMessage)

Sets whether the user view should automatically go to the conversation where they sent a message.

Parameters:

webNavigateToSentMessage - true to automatically go to the conversation where they sent a message. false to not automatically go to the conversation where they sent a message.

Returns:

This UpdateOwnUserSettingsApiRequest instance

withWebSuggestUpdateTimezone

public UpdateOwnUserSettingsApiRequest withWebSuggestUpdateTimezone(boolean webSuggestUpdateTimezone)

Sets whether the user should be shown an alert, offering to update their profile time zone, when the time displayed for the profile time zone differs from the current time displayed by the time zone configured on their device.

Parameters:

webSuggestUpdateTimezone - true to show a user alert offering to update their profile time zone. false to not show an alert.

Returns:

This UpdateOwnUserSettingsApiRequest instance

withWildcardMentionsNotify

public UpdateOwnUserSettingsApiRequest withWildcardMentionsNotify(boolean wildcardMentionsNotify)

Sets whether to be notified when wildcard mentions are triggered.

Parameters:

wildcardMentionsNotify - true to be notified when wildcard mentions are triggered. false to not be notified when wildcard mentions are triggered

Returns:

This UpdateOwnUserSettingsApiRequest instance

execute

public List<String> execute()
                     throws ZulipClientException

Executes the Zulip API request for updating own user settings.

Specified by:

execute in interface ExecutableApiRequest<List<String>>

Returns:

List of settings that were ignored

Throws:

ZulipClientException - if the request was not successful