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

Class UpdateRealmNewUserDefaultSettingsApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.server.request.UpdateRealmNewUserDefaultSettingsApiRequest

All Implemented Interfaces:

ExecutableApiRequest<List<String>>

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

Zulip API request builder for updating realm level default settings for new users.

See Also:

• https://zulip.com/api/update-realm-user-settings-defaults

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTOMATICALLY_FOLLOW_TOPICS_POLICY
static final String	AUTOMATICALLY_FOLLOW_TOPICS_WHERE_MENTIONED
static final String	AUTOMATICALLY_UNMUTE_TOPICS_IN_MUTED_STREAMS_POLICY
static final String	COLOR_SCHEME
static final String	DEMOTE_INACTIVE_STREAMS
static final String	DESKTOP_ICON_COUNT_DISPLAY
static final String	DISPLAY_EMOJI_REACTION_USERS
static final String	EMAIL_ADDRESS_VISIBILITY
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_FOLLOWED_TOPIC_AUDIBLE_NOTIFICATIONS
static final String	ENABLE_FOLLOWED_TOPIC_DESKTOP_NOTIFICATIONS
static final String	ENABLE_FOLLOWED_TOPIC_EMAIL_NOTIFICATIONS
static final String	ENABLE_FOLLOWED_TOPIC_PUSH_NOTIFICATIONS
static final String	ENABLE_FOLLOWED_TOPIC_WILDCARD_MENTIONS_NOTIFY
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	FLUID_LAYOUT_WIDTH
static final String	HIGH_CONTRAST_MODE
static final String	LEFT_SIDE_USERLIST
static final String	MESSAGE_CONTENT_IN_EMAIL_NOTIFICATIONS
static final String	NOTIFICATION_SOUND
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	RESOLVED_TOPIC_NOTICE_AUTO_READ_POLICY
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	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_ESCAPE_NAVIGATES_TO_HOME_VIEW
static final String	WEB_FONT_SIZE_PX
static final String	WEB_HOME_VIEW
static final String	WEB_LEFT_SIDEBAR_SHOW_CHANNEL_FOLDERS
static final String	WEB_LEFT_SIDEBAR_UNREADS_COUNT_SUMMARY
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_STREAM_UNREADS_COUNT_DISPLAY_POLICY
static final String	WEB_SUGGEST_UPDATE_TIMEZONE
static final String	WILDCARD_MENTIONS_NOTIFY

Constructor Summary

Constructors

Constructor	Description
UpdateRealmNewUserDefaultSettingsApiRequest(ZulipHttpClient client)	Constructs a UpdateRealmNewUserDefaultSettingsApiRequest.

Method Summary

Modifier and Type	Method	Description
List<String>	execute()	Invokes the HTTP client to send the request to the Zulip REST API and returns a response as type T.
UpdateRealmNewUserDefaultSettingsApiRequest	withAutomaticallyFollowTopicsPolicy(TopicFollowPolicy policy)	Sets the topics to follow automatically.
UpdateRealmNewUserDefaultSettingsApiRequest	withAutomaticallyFollowTopicsWhereMentioned(boolean enable)	Sets whether the server will automatically mark the user as following topics where the user is mentioned.
UpdateRealmNewUserDefaultSettingsApiRequest	withAutomaticallyUnmuteTopicsInMutedStreamsPolicy(UnmuteTopicInMutedStreamsPolicy policy)	Sets the topics to unmute automatically in muted streams.
UpdateRealmNewUserDefaultSettingsApiRequest	withColorScheme(ColorScheme colorScheme)	Sets the color scheme to use.
UpdateRealmNewUserDefaultSettingsApiRequest	withDemoteInactiveStreams(DemoteInactiveStreamOption demoteInactiveStreamOption)	Sets whether to demote inactive streams.
UpdateRealmNewUserDefaultSettingsApiRequest	withDesktopIconCountDisplay(DesktopIconCountDisplay desktopIconCountDisplay)	Sets whether to display an unread count summary on the Zulip UI.
UpdateRealmNewUserDefaultSettingsApiRequest	withDisplayEmojiReactionUsers(boolean displayEmojiReactionUsers)	Sets whether to display the names of reacting users on a message.
UpdateRealmNewUserDefaultSettingsApiRequest	withEmailAddressVisibility(EmailAddressVisibilityPolicy policy)	Sets the policy for which other users in this organization can see the users real email address.
UpdateRealmNewUserDefaultSettingsApiRequest	withEmailNotificationsBatchingPeriodSeconds(int duration)	Sets the duration in seconds for which the Zulip server should wait to batch email notifications before sending them.
UpdateRealmNewUserDefaultSettingsApiRequest	withEmojiSet(EmojiSet emojiSet)	The emoji set used to display emoji on the Zulip UI.
UpdateRealmNewUserDefaultSettingsApiRequest	withEnableDesktopNotifications(boolean enable)	Sets whether desktop notifications are enabled.
UpdateRealmNewUserDefaultSettingsApiRequest	withEnableDigestEmails(boolean enable)	Sets whether digest emails are enabled.
UpdateRealmNewUserDefaultSettingsApiRequest	withEnableDraftsSynchronization(boolean enable)	Sets whether synchronizing drafts is enabled.
UpdateRealmNewUserDefaultSettingsApiRequest	withEnableFollowedTopicAudibleNotifications(boolean enable)	Sets whether audible desktop notifications for messages sent to followed topics is enabled.
UpdateRealmNewUserDefaultSettingsApiRequest	withEnableFollowedTopicDesktopNotifications(boolean enable)	Sets whether visual desktop notifications for messages sent to followed topics is enabled.
UpdateRealmNewUserDefaultSettingsApiRequest	withEnableFollowedTopicEmailNotifications(boolean enable)	Sets whether email notifications for messages sent to followed topics is enabled.
UpdateRealmNewUserDefaultSettingsApiRequest	withEnableFollowedTopicPushNotifications(boolean enable)	Sets whether push notifications for messages sent to followed topics is enabled.
UpdateRealmNewUserDefaultSettingsApiRequest	withEnableFollowedTopicWildcardMentionsNotify(boolean enable)	Sets whether wildcard mentions in messages sent to followed topics should send notifications like a personal mention is enabled.
UpdateRealmNewUserDefaultSettingsApiRequest	withEnableOfflineEmailNotifications(boolean enable)	Sets whether offline email notifications are enabled.
UpdateRealmNewUserDefaultSettingsApiRequest	withEnableOfflinePushNotifications(boolean enable)	Sets whether offline push notifications are enabled.
UpdateRealmNewUserDefaultSettingsApiRequest	withEnableOnlinePushNotifications(boolean enable)	Sets whether online push notifications are enabled.
UpdateRealmNewUserDefaultSettingsApiRequest	withEnableSounds(boolean enable)	Sets whether sounds are enabled.
UpdateRealmNewUserDefaultSettingsApiRequest	withEnableStreamAudibleNotifications(boolean enable)	Sets whether stream audible notifications should be enabled.
UpdateRealmNewUserDefaultSettingsApiRequest	withEnableStreamDesktopNotifications(boolean enable)	Sets whether stream desktop notifications should be enabled.
UpdateRealmNewUserDefaultSettingsApiRequest	withEnableStreamEmailNotifications(boolean enable)	Sets whether stream email notifications should be enabled.
UpdateRealmNewUserDefaultSettingsApiRequest	withEnableStreamPushNotifications(boolean enable)	Sets whether stream push notifications should be enabled.
UpdateRealmNewUserDefaultSettingsApiRequest	withEnterSends(boolean enterSends)	Sets whether pressing the enter key on the Zulip UI sends a message.
UpdateRealmNewUserDefaultSettingsApiRequest	withFluidLayoutWidth(boolean fluidLayoutWidth)	Whether to use the maximum available screen width for the Zulip web UI center panel.
UpdateRealmNewUserDefaultSettingsApiRequest	withHighContrastMode(boolean highContrastMode)	Whether to enable variations in the Zulip UI to help visually impaired users.
UpdateRealmNewUserDefaultSettingsApiRequest	withLeftSideUserList(boolean leftSideUserList)	Whether the users list on left sidebar in narrow windows.
UpdateRealmNewUserDefaultSettingsApiRequest	withMessageContentInEmailNotifications(boolean messageContentInEmailNotifications)	Sets whether message content is present in email notifications.
UpdateRealmNewUserDefaultSettingsApiRequest	withNotificationSound(String notificationSound)	Sets the notification sound.
UpdateRealmNewUserDefaultSettingsApiRequest	withPmContentInDesktopNotifications(boolean pmContentInDesktopNotifications)	Sets whether private message content shows in desktop notifications.
UpdateRealmNewUserDefaultSettingsApiRequest	withPresenceEnabled(boolean enable)	Sets whether to display the presence status to other users when online.
UpdateRealmNewUserDefaultSettingsApiRequest	withRealmNameInEmailNotifications(RealmNameInNotificationsPolicy policy)	Sets whether to include the organization name in the subject of message notification emails.
UpdateRealmNewUserDefaultSettingsApiRequest	withRealmNameInNotifications(boolean realmNameInNotifications)	Deprecated. use withRealmNameInEmailNotifications instead
UpdateRealmNewUserDefaultSettingsApiRequest	withReceivesTypingNotifications(boolean receivesTypingNotifications)	Sets whether the user is configured to receive typing notifications from other users.
UpdateRealmNewUserDefaultSettingsApiRequest	withResolvedTopicNoticeAutoReadPolicy(ResolvedTopicNoticeAutoReadPolicy resolvedTopicNoticeAutoReadPolicy)	Sets whether resolved topic notices are marked as read.
UpdateRealmNewUserDefaultSettingsApiRequest	withSendPrivateTypingNotifications(boolean sendPrivateTypingNotifications)	Sets whether typing notifications be sent when composing private messages.
UpdateRealmNewUserDefaultSettingsApiRequest	withSendReadReceipts(boolean sendReadReceipts)	Sets whether other users are allowed to see whether you have read messages.
UpdateRealmNewUserDefaultSettingsApiRequest	withSendStreamTypingNotifications(boolean sendStreamTypingNotifications)	Sets whether typing notifications be sent when composing stream messages.
UpdateRealmNewUserDefaultSettingsApiRequest	withStarredMessageCounts(boolean starredMessageCounts)	Sets whether to display the number of starred messages.
UpdateRealmNewUserDefaultSettingsApiRequest	withTranslateEmoticons(boolean translateEmoticons)	Sets whether to translate emoticons to emoji in messages the user sends.
UpdateRealmNewUserDefaultSettingsApiRequest	withTwentyFourHourTime(boolean enable)	Sets whether time should be displayed in 24-hour notation.
UpdateRealmNewUserDefaultSettingsApiRequest	withUserListStyle(UserListStyle userListStyle)	Sets the style selected by the user for the right sidebar user list.
UpdateRealmNewUserDefaultSettingsApiRequest	withWebAnimateImagePreviews(WebAnimateImageOption webAnimateImageOption)	Sets how animated images should be played in the message feed.
UpdateRealmNewUserDefaultSettingsApiRequest	withWebChannelDefaultView(WebChannelView webChannelView)	Sets the default navigation behavior when clicking on a channel link.
UpdateRealmNewUserDefaultSettingsApiRequest	withWebEscapeNavigatesToHomeView(boolean webEscapeNavigatesToHomeView)	Sets whether pressing the escape key navigates to the web home view.
UpdateRealmNewUserDefaultSettingsApiRequest	withWebFontPx(int fontSize)	Sets the user primary font size in pixels.
UpdateRealmNewUserDefaultSettingsApiRequest	withWebHomeView(WebHomeView webHomeView)	Sets the web home view to use.
UpdateRealmNewUserDefaultSettingsApiRequest	withWebLeftSidebarShowChannelFolders(boolean webLeftSidebarShowChannelFolders)	Sets whether the left sidebar displays channel folders configured by the organization.
UpdateRealmNewUserDefaultSettingsApiRequest	withWebLeftSidebarUnreadsCountSummary(boolean webLeftSidebarUnreadsCountSummary)	Sets whether the left sidebar displays the unread message count summary.
UpdateRealmNewUserDefaultSettingsApiRequest	withWebLineHeightPercent(int webLineHeightPercent)	Sets the user primary line height for the Zulip web UI in percent.
UpdateRealmNewUserDefaultSettingsApiRequest	withWebMarkReadOnScrollPolicy(MarkReadOnScrollPolicy policy)	Sets whether or not to mark messages as read when the user scrolls through their feed.
UpdateRealmNewUserDefaultSettingsApiRequest	withWebNavigateToSentMessage(boolean webNavigateToSentMessage)	Sets whether the user view should automatically go to the conversation where they sent a message.
UpdateRealmNewUserDefaultSettingsApiRequest	withWebStreamUnreadsCountDisplayPolicy(WebStreamUnreadsCountDisplayPolicy policy)	Sets which streams should be displayed with a numeric unread count in the left sidebar in the Zulip UI.
UpdateRealmNewUserDefaultSettingsApiRequest	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.
UpdateRealmNewUserDefaultSettingsApiRequest	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, 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

AUTOMATICALLY_FOLLOW_TOPICS_POLICY

public static final String AUTOMATICALLY_FOLLOW_TOPICS_POLICY

See Also:

• Constant Field Values

AUTOMATICALLY_UNMUTE_TOPICS_IN_MUTED_STREAMS_POLICY

public static final String AUTOMATICALLY_UNMUTE_TOPICS_IN_MUTED_STREAMS_POLICY

See Also:

• Constant Field Values

AUTOMATICALLY_FOLLOW_TOPICS_WHERE_MENTIONED

public static final String AUTOMATICALLY_FOLLOW_TOPICS_WHERE_MENTIONED

See Also:

• Constant Field Values

COLOR_SCHEME

public static final String COLOR_SCHEME

See Also:

• Constant Field Values

DEMOTE_INACTIVE_STREAMS

public static final String DEMOTE_INACTIVE_STREAMS

See Also:

• Constant Field Values

DISPLAY_EMOJI_REACTION_USERS

public static final String DISPLAY_EMOJI_REACTION_USERS

See Also:

• Constant Field Values

DESKTOP_ICON_COUNT_DISPLAY

public static final String DESKTOP_ICON_COUNT_DISPLAY

See Also:

• Constant Field Values

ENABLE_DESKTOP_NOTIFICATIONS

public static final String ENABLE_DESKTOP_NOTIFICATIONS

See Also:

• Constant Field Values

EMAIL_ADDRESS_VISIBILITY

public static final String EMAIL_ADDRESS_VISIBILITY

See Also:

• Constant Field Values

EMAIL_NOTIFICATIONS_BATCHING_PERIOD_SECONDS

public static final String EMAIL_NOTIFICATIONS_BATCHING_PERIOD_SECONDS

See Also:

• Constant Field Values

EMOJISET

public static final String EMOJISET

See Also:

• Constant Field Values

ENABLE_DIGEST_EMAILS

public static final String ENABLE_DIGEST_EMAILS

See Also:

• Constant Field Values

ENABLE_DRAFTS_SYNCHRONIZATION

public static final String ENABLE_DRAFTS_SYNCHRONIZATION

See Also:

• Constant Field Values

ENABLE_FOLLOWED_TOPIC_DESKTOP_NOTIFICATIONS

public static final String ENABLE_FOLLOWED_TOPIC_DESKTOP_NOTIFICATIONS

See Also:

• Constant Field Values

ENABLE_FOLLOWED_TOPIC_EMAIL_NOTIFICATIONS

public static final String ENABLE_FOLLOWED_TOPIC_EMAIL_NOTIFICATIONS

See Also:

• Constant Field Values

ENABLE_FOLLOWED_TOPIC_PUSH_NOTIFICATIONS

public static final String ENABLE_FOLLOWED_TOPIC_PUSH_NOTIFICATIONS

See Also:

• Constant Field Values

ENABLE_FOLLOWED_TOPIC_AUDIBLE_NOTIFICATIONS

public static final String ENABLE_FOLLOWED_TOPIC_AUDIBLE_NOTIFICATIONS

See Also:

• Constant Field Values

ENABLE_FOLLOWED_TOPIC_WILDCARD_MENTIONS_NOTIFY

public static final String ENABLE_FOLLOWED_TOPIC_WILDCARD_MENTIONS_NOTIFY

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_AUDIBLE_NOTIFICATIONS

public static final String ENABLE_STREAM_AUDIBLE_NOTIFICATIONS

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

ENTER_SENDS

public static final String ENTER_SENDS

See Also:

• Constant Field Values

FLUID_LAYOUT_WIDTH

public static final String FLUID_LAYOUT_WIDTH

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

NOTIFICATION_SOUND

public static final String NOTIFICATION_SOUND

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

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_ESCAPE_NAVIGATES_TO_HOME_VIEW

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

public static final String WEB_HOME_VIEW

See Also:

• Constant Field Values

WEB_STREAM_UNREADS_COUNT_DISPLAY_POLICY

public static final String WEB_STREAM_UNREADS_COUNT_DISPLAY_POLICY

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

WEB_LEFT_SIDEBAR_SHOW_CHANNEL_FOLDERS

public static final String WEB_LEFT_SIDEBAR_SHOW_CHANNEL_FOLDERS

See Also:

• Constant Field Values

WEB_LEFT_SIDEBAR_UNREADS_COUNT_SUMMARY

public static final String WEB_LEFT_SIDEBAR_UNREADS_COUNT_SUMMARY

See Also:

• Constant Field Values

RESOLVED_TOPIC_NOTICE_AUTO_READ_POLICY

public static final String RESOLVED_TOPIC_NOTICE_AUTO_READ_POLICY

See Also:

• Constant Field Values

Constructor Details

UpdateRealmNewUserDefaultSettingsApiRequest

public UpdateRealmNewUserDefaultSettingsApiRequest(ZulipHttpClient client)

Constructs a UpdateRealmNewUserDefaultSettingsApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

withAutomaticallyFollowTopicsPolicy

public UpdateRealmNewUserDefaultSettingsApiRequest withAutomaticallyFollowTopicsPolicy(TopicFollowPolicy policy)

Sets the topics to follow automatically.

Parameters:

policy - The TopicFollowPolicy to use

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withAutomaticallyUnmuteTopicsInMutedStreamsPolicy

public UpdateRealmNewUserDefaultSettingsApiRequest withAutomaticallyUnmuteTopicsInMutedStreamsPolicy(UnmuteTopicInMutedStreamsPolicy policy)

Sets the topics to unmute automatically in muted streams.

Parameters:

policy - The UnmuteTopicInMutedStreamsPolicy to use

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withAutomaticallyFollowTopicsWhereMentioned

public UpdateRealmNewUserDefaultSettingsApiRequest withAutomaticallyFollowTopicsWhereMentioned(boolean enable)

Sets whether the server will automatically mark the user as following topics where the user is mentioned.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withColorScheme

public UpdateRealmNewUserDefaultSettingsApiRequest withColorScheme(ColorScheme colorScheme)

Sets the color scheme to use.

Parameters:

colorScheme - The color scheme to use

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withWebHomeView

public UpdateRealmNewUserDefaultSettingsApiRequest withWebHomeView(WebHomeView webHomeView)

Sets the web home view to use.

Parameters:

webHomeView - The default web home view to use

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

See Also:

• https://zulip.com/api/update-realm-user-settings-defaults#parameter-web_home_view

withDemoteInactiveStreams

public UpdateRealmNewUserDefaultSettingsApiRequest withDemoteInactiveStreams(DemoteInactiveStreamOption demoteInactiveStreamOption)

Sets whether to demote inactive streams.

Parameters:

demoteInactiveStreamOption - The option to control how inactive streams are demoted

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

See Also:

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

withDesktopIconCountDisplay

public UpdateRealmNewUserDefaultSettingsApiRequest withDesktopIconCountDisplay(DesktopIconCountDisplay desktopIconCountDisplay)

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

Parameters:

desktopIconCountDisplay - The DesktopIconCountDisplay setting

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withDisplayEmojiReactionUsers

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

withEmailNotificationsBatchingPeriodSeconds

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

withEmojiSet

public UpdateRealmNewUserDefaultSettingsApiRequest withEmojiSet(EmojiSet emojiSet)

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

Parameters:

emojiSet - The emoji set to use

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEnableDesktopNotifications

public UpdateRealmNewUserDefaultSettingsApiRequest withEnableDesktopNotifications(boolean enable)

Sets whether desktop notifications are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEmailAddressVisibility

public UpdateRealmNewUserDefaultSettingsApiRequest withEmailAddressVisibility(EmailAddressVisibilityPolicy policy)

Sets the policy for which other users in this organization can see the users real email address.

Parameters:

policy - The EmailAddressVisibilityPolicy to apply

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEnableDigestEmails

public UpdateRealmNewUserDefaultSettingsApiRequest withEnableDigestEmails(boolean enable)

Sets whether digest emails are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEnableDraftsSynchronization

public UpdateRealmNewUserDefaultSettingsApiRequest withEnableDraftsSynchronization(boolean enable)

Sets whether synchronizing drafts is enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEnableFollowedTopicDesktopNotifications

public UpdateRealmNewUserDefaultSettingsApiRequest withEnableFollowedTopicDesktopNotifications(boolean enable)

Sets whether visual desktop notifications for messages sent to followed topics is enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEnableFollowedTopicEmailNotifications

public UpdateRealmNewUserDefaultSettingsApiRequest withEnableFollowedTopicEmailNotifications(boolean enable)

Sets whether email notifications for messages sent to followed topics is enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEnableFollowedTopicPushNotifications

public UpdateRealmNewUserDefaultSettingsApiRequest withEnableFollowedTopicPushNotifications(boolean enable)

Sets whether push notifications for messages sent to followed topics is enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEnableFollowedTopicAudibleNotifications

public UpdateRealmNewUserDefaultSettingsApiRequest withEnableFollowedTopicAudibleNotifications(boolean enable)

Sets whether audible desktop notifications for messages sent to followed topics is enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEnableFollowedTopicWildcardMentionsNotify

public UpdateRealmNewUserDefaultSettingsApiRequest withEnableFollowedTopicWildcardMentionsNotify(boolean enable)

Sets whether wildcard mentions in messages sent to followed topics should send notifications like a personal mention is enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEnableOfflineEmailNotifications

public UpdateRealmNewUserDefaultSettingsApiRequest withEnableOfflineEmailNotifications(boolean enable)

Sets whether offline email notifications are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEnableOfflinePushNotifications

public UpdateRealmNewUserDefaultSettingsApiRequest withEnableOfflinePushNotifications(boolean enable)

Sets whether offline push notifications are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEnableOnlinePushNotifications

public UpdateRealmNewUserDefaultSettingsApiRequest withEnableOnlinePushNotifications(boolean enable)

Sets whether online push notifications are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEnableSounds

public UpdateRealmNewUserDefaultSettingsApiRequest withEnableSounds(boolean enable)

Sets whether sounds are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEnableStreamAudibleNotifications

public UpdateRealmNewUserDefaultSettingsApiRequest withEnableStreamAudibleNotifications(boolean enable)

Sets whether stream audible notifications should be enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEnableStreamDesktopNotifications

public UpdateRealmNewUserDefaultSettingsApiRequest withEnableStreamDesktopNotifications(boolean enable)

Sets whether stream desktop notifications should be enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEnableStreamEmailNotifications

public UpdateRealmNewUserDefaultSettingsApiRequest withEnableStreamEmailNotifications(boolean enable)

Sets whether stream email notifications should be enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEnableStreamPushNotifications

public UpdateRealmNewUserDefaultSettingsApiRequest withEnableStreamPushNotifications(boolean enable)

Sets whether stream push notifications should be enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withEnterSends

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

withWebEscapeNavigatesToHomeView

public UpdateRealmNewUserDefaultSettingsApiRequest withWebEscapeNavigatesToHomeView(boolean webEscapeNavigatesToHomeView)

Sets whether pressing the escape key navigates to the web home view.

Parameters:

webEscapeNavigatesToHomeView - 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 UpdateRealmNewUserDefaultSettingsApiRequest instance

See Also:

• https://zulip.com/api/update-realm-user-settings-defaults#parameter-web_escape_navigates_to_home_view

withFluidLayoutWidth

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

withHighContrastMode

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

withLeftSideUserList

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

withMessageContentInEmailNotifications

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

withNotificationSound

public UpdateRealmNewUserDefaultSettingsApiRequest withNotificationSound(String notificationSound)

Sets the notification sound.

Parameters:

notificationSound - The name of the notification sound to play

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withPmContentInDesktopNotifications

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

withPresenceEnabled

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

withRealmNameInNotifications

@Deprecated
public UpdateRealmNewUserDefaultSettingsApiRequest 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 UpdateRealmNewUserDefaultSettingsApiRequest instance

withRealmNameInEmailNotifications

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

withReceivesTypingNotifications

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

withSendPrivateTypingNotifications

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

See Also:

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

withSendReadReceipts

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

withSendStreamTypingNotifications

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

See Also:

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

withStarredMessageCounts

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

See Also:

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

withTranslateEmoticons

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

See Also:

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

withTwentyFourHourTime

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

See Also:

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

withUserListStyle

public UpdateRealmNewUserDefaultSettingsApiRequest withUserListStyle(UserListStyle userListStyle)

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

Parameters:

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

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withWebAnimateImagePreviews

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

withWebChannelDefaultView

public UpdateRealmNewUserDefaultSettingsApiRequest withWebChannelDefaultView(WebChannelView webChannelView)

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

Parameters:

webChannelView - for the default channel view

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withWebFontPx

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

withWebLineHeightPercent

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

withWebMarkReadOnScrollPolicy

public UpdateRealmNewUserDefaultSettingsApiRequest withWebMarkReadOnScrollPolicy(MarkReadOnScrollPolicy policy)

Sets whether or not 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 UpdateRealmNewUserDefaultSettingsApiRequest instance

withWebNavigateToSentMessage

public UpdateRealmNewUserDefaultSettingsApiRequest withWebNavigateToSentMessage(boolean webNavigateToSentMessage)

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

Parameters:

webNavigateToSentMessage - trye 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 UpdateRealmNewUserDefaultSettingsApiRequest instance

withWebStreamUnreadsCountDisplayPolicy

public UpdateRealmNewUserDefaultSettingsApiRequest withWebStreamUnreadsCountDisplayPolicy(WebStreamUnreadsCountDisplayPolicy policy)

Sets which streams should be displayed with a numeric unread count in the left sidebar in the Zulip UI.

Parameters:

policy - The WebStreamUnreadsCountDisplayPolicy to determine which streams are to be displayed

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withWebSuggestUpdateTimezone

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

withWildcardMentionsNotify

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

withWebLeftSidebarShowChannelFolders

public UpdateRealmNewUserDefaultSettingsApiRequest withWebLeftSidebarShowChannelFolders(boolean webLeftSidebarShowChannelFolders)

Sets whether the left sidebar displays channel folders configured by the organization.

Parameters:

webLeftSidebarShowChannelFolders - true to display channel folders configured by the organization. false to not display folders

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withWebLeftSidebarUnreadsCountSummary

public UpdateRealmNewUserDefaultSettingsApiRequest withWebLeftSidebarUnreadsCountSummary(boolean webLeftSidebarUnreadsCountSummary)

Sets whether the left sidebar displays the unread message count summary.

Parameters:

webLeftSidebarUnreadsCountSummary - true to display the unread message count summary. false to not display the message count summary

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

withResolvedTopicNoticeAutoReadPolicy

public UpdateRealmNewUserDefaultSettingsApiRequest withResolvedTopicNoticeAutoReadPolicy(ResolvedTopicNoticeAutoReadPolicy resolvedTopicNoticeAutoReadPolicy)

Sets whether resolved topic notices are marked as read.

Parameters:

resolvedTopicNoticeAutoReadPolicy - The ResolvedTopicNoticeAutoReadPolicy to apply

Returns:

This UpdateRealmNewUserDefaultSettingsApiRequest instance

execute

public List<String> execute()
                     throws ZulipClientException

Description copied from interface: ExecutableApiRequest

Invokes the HTTP client to send the request to the Zulip REST API and returns a response as type T.

Specified by:

execute in interface ExecutableApiRequest<List<String>>

Returns:

The response for type T

Throws:

ZulipClientException - if an error occurs for the API request