Skip to main content

UserSettings

Struct UserSettings 

Source
pub struct UserSettings { /* private fields */ }
Expand description

Represents the user’s personal settings.

Changes: Removed dense_mode setting in Zulip 10.0 (feature level 364) as we now have web_font_size_px and web_line_height_percent settings for more control. New in Zulip 5.0 (feature level 89). Previously, these settings appeared in the top-level object, where they are available for clients without the user_settings_object client capability for backwards-compatibility.

Modified from openapi-generator-cli output:

$ openapi-generator-cli generate -g rust -i ./zerver/openapi/zulip.yaml -o zulip-openapi --skip-validate-spec
/*
* Zulip REST API
*
* Powerful open source group chat
*
* The version of the OpenAPI document: 1.0.0
*
* Generated by: https://openapi-generator.tech
*/

See zerver/openapi/zulip.yaml for the original OpenAPI configuration.

Configuration slightly modified to work with the Rust generator of openapi-generator-cli.

Implementations§

Source§

impl UserSettings

Source

pub const fn new() -> Self

Creates a new UserSettings.

Source§

impl UserSettings

Source

pub const fn twenty_four_hour_time(&self) -> Option<bool>

Gets the UserSettings twenty_four_hour_time.

Whether time should be displayed in 24-hour notation.

A null value indicates that the client should use the default time format for the user’s locale.

Changes: Prior to Zulip 11.0 (feature level 408),

null was not a valid value for this setting.

Note that it was not possible to actually set the time format to null at this feature level.

Source

pub fn set_twenty_four_hour_time(&mut self, val: bool)

Sets the UserSettings twenty_four_hour_time.

Whether time should be displayed in 24-hour notation.

A null value indicates that the client should use the default time format for the user’s locale.

Changes: Prior to Zulip 11.0 (feature level 408),

null was not a valid value for this setting.

Note that it was not possible to actually set the time format to null at this feature level.

Source

pub fn unset_twenty_four_hour_time(&mut self) -> Option<bool>

Unsets the UserSettings twenty_four_hour_time.

Whether time should be displayed in 24-hour notation.

A null value indicates that the client should use the default time format for the user’s locale.

Changes: Prior to Zulip 11.0 (feature level 408),

null was not a valid value for this setting.

Note that it was not possible to actually set the time format to null at this feature level.

Source

pub fn with_twenty_four_hour_time(self, val: bool) -> Self

Builder function that sets the UserSettings twenty_four_hour_time.

Whether time should be displayed in 24-hour notation.

A null value indicates that the client should use the default time format for the user’s locale.

Changes: Prior to Zulip 11.0 (feature level 408),

null was not a valid value for this setting.

Note that it was not possible to actually set the time format to null at this feature level.

Source

pub const fn web_mark_read_on_scroll_policy( &self, ) -> Option<WebMarkReadOnScrollPolicy>

Gets the UserSettings web_mark_read_on_scroll_policy.

Whether or not to mark messages as read when the user scrolls through their feed.

Source

pub fn set_web_mark_read_on_scroll_policy( &mut self, val: WebMarkReadOnScrollPolicy, )

Sets the UserSettings web_mark_read_on_scroll_policy.

Whether or not to mark messages as read when the user scrolls through their feed.

Source

pub fn unset_web_mark_read_on_scroll_policy( &mut self, ) -> Option<WebMarkReadOnScrollPolicy>

Unsets the UserSettings web_mark_read_on_scroll_policy.

Whether or not to mark messages as read when the user scrolls through their feed.

Source

pub fn with_web_mark_read_on_scroll_policy( self, val: WebMarkReadOnScrollPolicy, ) -> Self

Builder function that sets the UserSettings web_mark_read_on_scroll_policy.

Whether or not to mark messages as read when the user scrolls through their feed.

Source

pub const fn web_channel_default_view(&self) -> Option<WebChannelDefaultView>

Gets the UserSettings web_channel_default_view.

Web/desktop app setting controlling the default navigation behavior when clicking on a channel link.

Source

pub fn set_web_channel_default_view(&mut self, val: WebChannelDefaultView)

Sets the UserSettings web_channel_default_view.

Web/desktop app setting controlling the default navigation behavior when clicking on a channel link.

Source

pub fn unset_web_channel_default_view( &mut self, ) -> Option<WebChannelDefaultView>

Unsets the UserSettings web_channel_default_view.

Web/desktop app setting controlling the default navigation behavior when clicking on a channel link.

Source

pub fn with_web_channel_default_view(self, val: WebChannelDefaultView) -> Self

Builder function that sets the UserSettings web_channel_default_view.

Web/desktop app setting controlling the default navigation behavior when clicking on a channel link.

Source

pub const fn starred_message_counts(&self) -> Option<bool>

Gets the UserSettings starred_message_counts.

Whether clients should display the number of starred messages.

Source

pub fn set_starred_message_counts(&mut self, val: bool)

Sets the UserSettings starred_message_counts.

Whether clients should display the number of starred messages.

Source

pub fn unset_starred_message_counts(&mut self) -> Option<bool>

Unsets the UserSettings starred_message_counts.

Whether clients should display the number of starred messages.

Source

pub fn with_starred_message_counts(self, val: bool) -> Self

Builder function that sets the UserSettings starred_message_counts.

Whether clients should display the number of starred messages.

Source

pub const fn receives_typing_notifications(&self) -> Option<bool>

Gets the UserSettings receives_typing_notifications.

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

The server will only deliver typing notifications events to users who for whom this is enabled.

Changes: New in Zulip 9.0 (feature level 253). Previously, there were only options to disable sending typing notifications.

Source

pub fn set_receives_typing_notifications(&mut self, val: bool)

Sets the UserSettings receives_typing_notifications.

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

The server will only deliver typing notifications events to users who for whom this is enabled.

Changes: New in Zulip 9.0 (feature level 253). Previously, there were only options to disable sending typing notifications.

Source

pub fn unset_receives_typing_notifications(&mut self) -> Option<bool>

Unsets the UserSettings receives_typing_notifications.

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

The server will only deliver typing notifications events to users who for whom this is enabled.

Changes: New in Zulip 9.0 (feature level 253). Previously, there were only options to disable sending typing notifications.

Source

pub fn with_receives_typing_notifications(self, val: bool) -> Self

Builder function that sets the UserSettings receives_typing_notifications.

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

The server will only deliver typing notifications events to users who for whom this is enabled.

Changes: New in Zulip 9.0 (feature level 253). Previously, there were only options to disable sending typing notifications.

Source

pub const fn web_suggest_update_timezone(&self) -> Option<bool>

Gets the UserSettings web_suggest_update_timezone.

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.

Changes: New in Zulip 10.0 (feature level 329).

Source

pub fn set_web_suggest_update_timezone(&mut self, val: bool)

Sets the UserSettings web_suggest_update_timezone.

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.

Changes: New in Zulip 10.0 (feature level 329).

Source

pub fn unset_web_suggest_update_timezone(&mut self) -> Option<bool>

Unsets the UserSettings web_suggest_update_timezone.

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.

Changes: New in Zulip 10.0 (feature level 329).

Source

pub fn with_web_suggest_update_timezone(self, val: bool) -> Self

Builder function that sets the UserSettings web_suggest_update_timezone.

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.

Changes: New in Zulip 10.0 (feature level 329).

Source

pub const fn fluid_layout_width(&self) -> Option<bool>

Gets the UserSettings fluid_layout_width.

Whether to use the maximum available screen width for the web app’s center panel (message feed, recent conversations) on wide screens.

Source

pub fn set_fluid_layout_width(&mut self, val: bool)

Sets the UserSettings fluid_layout_width.

Whether to use the maximum available screen width for the web app’s center panel (message feed, recent conversations) on wide screens.

Source

pub fn unset_fluid_layout_width(&mut self) -> Option<bool>

Unsets the UserSettings fluid_layout_width.

Whether to use the maximum available screen width for the web app’s center panel (message feed, recent conversations) on wide screens.

Source

pub fn with_fluid_layout_width(self, val: bool) -> Self

Builder function that sets the UserSettings fluid_layout_width.

Whether to use the maximum available screen width for the web app’s center panel (message feed, recent conversations) on wide screens.

Source

pub const fn high_contrast_mode(&self) -> Option<bool>

Gets the UserSettings high_contrast_mode.

This setting is reserved for use to control variations in Zulip’s design to help visually impaired users.

Source

pub fn set_high_contrast_mode(&mut self, val: bool)

Sets the UserSettings high_contrast_mode.

This setting is reserved for use to control variations in Zulip’s design to help visually impaired users.

Source

pub fn unset_high_contrast_mode(&mut self) -> Option<bool>

Unsets the UserSettings high_contrast_mode.

This setting is reserved for use to control variations in Zulip’s design to help visually impaired users.

Source

pub fn with_high_contrast_mode(self, val: bool) -> Self

Builder function that sets the UserSettings high_contrast_mode.

This setting is reserved for use to control variations in Zulip’s design to help visually impaired users.

Source

pub const fn web_font_size_px(&self) -> Option<i32>

Gets the UserSettings web_font_size_px.

User-configured primary font-size for the web application, in pixels.

Changes: New in Zulip 9.0 (feature level 245). Previously, font size was only adjustable via browser zoom. Note that this setting was not fully implemented at this feature level.

Source

pub fn set_web_font_size_px(&mut self, val: i32)

Sets the UserSettings web_font_size_px.

User-configured primary font-size for the web application, in pixels.

Changes: New in Zulip 9.0 (feature level 245). Previously, font size was only adjustable via browser zoom. Note that this setting was not fully implemented at this feature level.

Source

pub fn unset_web_font_size_px(&mut self) -> Option<i32>

Unsets the UserSettings web_font_size_px.

User-configured primary font-size for the web application, in pixels.

Changes: New in Zulip 9.0 (feature level 245). Previously, font size was only adjustable via browser zoom. Note that this setting was not fully implemented at this feature level.

Source

pub fn with_web_font_size_px(self, val: i32) -> Self

Builder function that sets the UserSettings web_font_size_px.

User-configured primary font-size for the web application, in pixels.

Changes: New in Zulip 9.0 (feature level 245). Previously, font size was only adjustable via browser zoom. Note that this setting was not fully implemented at this feature level.

Source

pub const fn web_line_height_percent(&self) -> Option<i32>

Gets the UserSettings web_line_height_percent.

User-configured primary line-height for the web application, in percent, so a value of 120 represents a line-height of 1.2.

Changes: New in Zulip 9.0 (feature level 245).

Previously, line height was not user-configurable.

Note that this setting was not fully implemented at this feature level.

Source

pub fn set_web_line_height_percent(&mut self, val: i32)

Sets the UserSettings web_line_height_percent.

User-configured primary line-height for the web application, in percent, so a value of 120 represents a line-height of 1.2.

Changes: New in Zulip 9.0 (feature level 245).

Previously, line height was not user-configurable.

Note that this setting was not fully implemented at this feature level.

Source

pub fn unset_web_line_height_percent(&mut self) -> Option<i32>

Unsets the UserSettings web_line_height_percent.

User-configured primary line-height for the web application, in percent, so a value of 120 represents a line-height of 1.2.

Changes: New in Zulip 9.0 (feature level 245).

Previously, line height was not user-configurable.

Note that this setting was not fully implemented at this feature level.

Source

pub fn with_web_line_height_percent(self, val: i32) -> Self

Builder function that sets the UserSettings web_line_height_percent.

User-configured primary line-height for the web application, in percent, so a value of 120 represents a line-height of 1.2.

Changes: New in Zulip 9.0 (feature level 245).

Previously, line height was not user-configurable.

Note that this setting was not fully implemented at this feature level.

Source

pub const fn color_scheme(&self) -> Option<ColorScheme>

Gets the UserSettings color_scheme.

Controls which color theme to use.

Source

pub fn set_color_scheme(&mut self, val: ColorScheme)

Sets the UserSettings color_scheme.

Controls which color theme to use.

Source

pub fn unset_color_scheme(&mut self) -> Option<ColorScheme>

Unsets the UserSettings color_scheme.

Controls which color theme to use.

Source

pub fn with_color_scheme(self, val: ColorScheme) -> Self

Builder function that sets the UserSettings color_scheme.

Controls which color theme to use.

Source

pub const fn translate_emoticons(&self) -> Option<bool>

Gets the UserSettings translate_emoticons.

Whether to translate emoticons to emoji in messages the user sends.

Source

pub fn set_translate_emoticons(&mut self, val: bool)

Sets the UserSettings translate_emoticons.

Whether to translate emoticons to emoji in messages the user sends.

Source

pub fn unset_translate_emoticons(&mut self) -> Option<bool>

Unsets the UserSettings translate_emoticons.

Whether to translate emoticons to emoji in messages the user sends.

Source

pub fn with_translate_emoticons(self, val: bool) -> Self

Builder function that sets the UserSettings translate_emoticons.

Whether to translate emoticons to emoji in messages the user sends.

Source

pub const fn display_emoji_reaction_users(&self) -> Option<bool>

Gets the UserSettings display_emoji_reaction_users.

Whether to display the names of reacting users on a message.

When enabled, clients should display the names of reacting users, rather than a count, for messages with few total reactions.

The ideal cutoff may depend on the space available for displaying reactions;

the official web application displays names when 3 or fewer total reactions are present with this setting enabled.

Changes: New in Zulip 6.0 (feature level 125).

Source

pub fn set_display_emoji_reaction_users(&mut self, val: bool)

Sets the UserSettings display_emoji_reaction_users.

Whether to display the names of reacting users on a message.

When enabled, clients should display the names of reacting users, rather than a count, for messages with few total reactions.

The ideal cutoff may depend on the space available for displaying reactions;

the official web application displays names when 3 or fewer total reactions are present with this setting enabled.

Changes: New in Zulip 6.0 (feature level 125).

Source

pub fn unset_display_emoji_reaction_users(&mut self) -> Option<bool>

Unsets the UserSettings display_emoji_reaction_users.

Whether to display the names of reacting users on a message.

When enabled, clients should display the names of reacting users, rather than a count, for messages with few total reactions.

The ideal cutoff may depend on the space available for displaying reactions;

the official web application displays names when 3 or fewer total reactions are present with this setting enabled.

Changes: New in Zulip 6.0 (feature level 125).

Source

pub fn with_display_emoji_reaction_users(self, val: bool) -> Self

Builder function that sets the UserSettings display_emoji_reaction_users.

Whether to display the names of reacting users on a message.

When enabled, clients should display the names of reacting users, rather than a count, for messages with few total reactions.

The ideal cutoff may depend on the space available for displaying reactions;

the official web application displays names when 3 or fewer total reactions are present with this setting enabled.

Changes: New in Zulip 6.0 (feature level 125).

Source

pub const fn web_home_view(&self) -> Option<WebHomeView>

Gets the UserSettings web_home_view.

The home view used when opening a new Zulip web app window or hitting the Esc keyboard shortcut repeatedly.

Source

pub fn set_web_home_view(&mut self, val: WebHomeView)

Sets the UserSettings web_home_view.

The home view used when opening a new Zulip web app window or hitting the Esc keyboard shortcut repeatedly.

Source

pub fn unset_web_home_view(&mut self) -> Option<WebHomeView>

Unsets the UserSettings web_home_view.

The home view used when opening a new Zulip web app window or hitting the Esc keyboard shortcut repeatedly.

Source

pub fn with_web_home_view(self, val: WebHomeView) -> Self

Builder function that sets the UserSettings web_home_view.

The home view used when opening a new Zulip web app window or hitting the Esc keyboard shortcut repeatedly.

Source

pub const fn web_escape_navigates_to_home_view(&self) -> Option<bool>

Gets the UserSettings web_escape_navigates_to_home_view.

Whether the escape key navigates to the configured home view.

Changes: New in Zulip 8.0 (feature level 219). Previously, this was called escape_navigates_to_default_view, which was new in Zulip 5.0 (feature level 107).

Source

pub fn set_web_escape_navigates_to_home_view(&mut self, val: bool)

Sets the UserSettings web_escape_navigates_to_home_view.

Whether the escape key navigates to the configured home view.

Changes: New in Zulip 8.0 (feature level 219). Previously, this was called escape_navigates_to_default_view, which was new in Zulip 5.0 (feature level 107).

Source

pub fn unset_web_escape_navigates_to_home_view(&mut self) -> Option<bool>

Unsets the UserSettings web_escape_navigates_to_home_view.

Whether the escape key navigates to the configured home view.

Changes: New in Zulip 8.0 (feature level 219). Previously, this was called escape_navigates_to_default_view, which was new in Zulip 5.0 (feature level 107).

Source

pub fn with_web_escape_navigates_to_home_view(self, val: bool) -> Self

Builder function that sets the UserSettings web_escape_navigates_to_home_view.

Whether the escape key navigates to the configured home view.

Changes: New in Zulip 8.0 (feature level 219). Previously, this was called escape_navigates_to_default_view, which was new in Zulip 5.0 (feature level 107).

Source

pub const fn left_side_userlist(&self) -> Option<bool>

Gets the UserSettings left_side_userlist.

Whether the users list on left sidebar in narrow windows.

This feature is not heavily used and is likely to be reworked.

Source

pub fn set_left_side_userlist(&mut self, val: bool)

Sets the UserSettings left_side_userlist.

Whether the users list on left sidebar in narrow windows.

This feature is not heavily used and is likely to be reworked.

Source

pub fn unset_left_side_userlist(&mut self) -> Option<bool>

Unsets the UserSettings left_side_userlist.

Whether the users list on left sidebar in narrow windows.

This feature is not heavily used and is likely to be reworked.

Source

pub fn with_left_side_userlist(self, val: bool) -> Self

Builder function that sets the UserSettings left_side_userlist.

Whether the users list on left sidebar in narrow windows.

This feature is not heavily used and is likely to be reworked.

Source

pub const fn emojiset(&self) -> Option<Emojiset>

Gets the UserSettings emojiset.

The user’s configured emoji set, used to display emoji to the user everywhere they appear in the UI.

Source

pub fn set_emojiset(&mut self, val: Emojiset)

Sets the UserSettings emojiset.

The user’s configured emoji set, used to display emoji to the user everywhere they appear in the UI.

Source

pub fn unset_emojiset(&mut self) -> Option<Emojiset>

Unsets the UserSettings emojiset.

The user’s configured emoji set, used to display emoji to the user everywhere they appear in the UI.

Source

pub fn with_emojiset(self, val: Emojiset) -> Self

Builder function that sets the UserSettings emojiset.

The user’s configured emoji set, used to display emoji to the user everywhere they appear in the UI.

Source

pub const fn demote_inactive_streams(&self) -> Option<DemoteInactiveStreams>

Gets the UserSettings demote_inactive_streams.

Whether to hide inactive channels in the left sidebar.

Source

pub fn set_demote_inactive_streams(&mut self, val: DemoteInactiveStreams)

Sets the UserSettings demote_inactive_streams.

Whether to hide inactive channels in the left sidebar.

Source

pub fn unset_demote_inactive_streams(&mut self) -> Option<DemoteInactiveStreams>

Unsets the UserSettings demote_inactive_streams.

Whether to hide inactive channels in the left sidebar.

Source

pub fn with_demote_inactive_streams(self, val: DemoteInactiveStreams) -> Self

Builder function that sets the UserSettings demote_inactive_streams.

Whether to hide inactive channels in the left sidebar.

Source

pub const fn user_list_style(&self) -> Option<UserListStyle>

Gets the UserSettings user_list_style.

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

Source

pub fn set_user_list_style(&mut self, val: UserListStyle)

Sets the UserSettings user_list_style.

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

Source

pub fn unset_user_list_style(&mut self) -> Option<UserListStyle>

Unsets the UserSettings user_list_style.

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

Source

pub fn with_user_list_style(self, val: UserListStyle) -> Self

Builder function that sets the UserSettings user_list_style.

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

Source

pub const fn web_animate_image_previews( &self, ) -> Option<WebAnimateImagePreviews>

Gets the UserSettings web_animate_image_previews.

Controls how animated images should be played in the message feed in the web/desktop application.

Source

pub fn set_web_animate_image_previews(&mut self, val: WebAnimateImagePreviews)

Sets the UserSettings web_animate_image_previews.

Controls how animated images should be played in the message feed in the web/desktop application.

Source

pub fn unset_web_animate_image_previews( &mut self, ) -> Option<WebAnimateImagePreviews>

Unsets the UserSettings web_animate_image_previews.

Controls how animated images should be played in the message feed in the web/desktop application.

Source

pub fn with_web_animate_image_previews( self, val: WebAnimateImagePreviews, ) -> Self

Builder function that sets the UserSettings web_animate_image_previews.

Controls how animated images should be played in the message feed in the web/desktop application.

Source

pub const fn web_stream_unreads_count_display_policy( &self, ) -> Option<WebStreamUnreadsCountDisplayPolicy>

Gets the UserSettings web_stream_unreads_count_display_policy.

Configuration for which channels should be displayed with a numeric unread count in the left sidebar.

Source

pub fn set_web_stream_unreads_count_display_policy( &mut self, val: WebStreamUnreadsCountDisplayPolicy, )

Sets the UserSettings web_stream_unreads_count_display_policy.

Configuration for which channels should be displayed with a numeric unread count in the left sidebar.

Source

pub fn unset_web_stream_unreads_count_display_policy( &mut self, ) -> Option<WebStreamUnreadsCountDisplayPolicy>

Unsets the UserSettings web_stream_unreads_count_display_policy.

Configuration for which channels should be displayed with a numeric unread count in the left sidebar.

Source

pub fn with_web_stream_unreads_count_display_policy( self, val: WebStreamUnreadsCountDisplayPolicy, ) -> Self

Builder function that sets the UserSettings web_stream_unreads_count_display_policy.

Configuration for which channels should be displayed with a numeric unread count in the left sidebar.

Source

pub const fn hide_ai_features(&self) -> Option<bool>

Gets the UserSettings hide_ai_features.

Controls whether user wants AI features like topic summarization to be hidden in all Zulip clients.

Changes: New in Zulip 10.0 (feature level 350).

Source

pub fn set_hide_ai_features(&mut self, val: bool)

Sets the UserSettings hide_ai_features.

Controls whether user wants AI features like topic summarization to be hidden in all Zulip clients.

Changes: New in Zulip 10.0 (feature level 350).

Source

pub fn unset_hide_ai_features(&mut self) -> Option<bool>

Unsets the UserSettings hide_ai_features.

Controls whether user wants AI features like topic summarization to be hidden in all Zulip clients.

Changes: New in Zulip 10.0 (feature level 350).

Source

pub fn with_hide_ai_features(self, val: bool) -> Self

Builder function that sets the UserSettings hide_ai_features.

Controls whether user wants AI features like topic summarization to be hidden in all Zulip clients.

Changes: New in Zulip 10.0 (feature level 350).

Source

pub const fn web_left_sidebar_show_channel_folders(&self) -> Option<bool>

Gets the UserSettings web_left_sidebar_show_channel_folders.

Determines whether the web/desktop application’s left sidebar displays any channel folders configured by the organization.

Changes: New in Zulip 11.0 (feature level 411).

Source

pub fn set_web_left_sidebar_show_channel_folders(&mut self, val: bool)

Sets the UserSettings web_left_sidebar_show_channel_folders.

Determines whether the web/desktop application’s left sidebar displays any channel folders configured by the organization.

Changes: New in Zulip 11.0 (feature level 411).

Source

pub fn unset_web_left_sidebar_show_channel_folders(&mut self) -> Option<bool>

Unsets the UserSettings web_left_sidebar_show_channel_folders.

Determines whether the web/desktop application’s left sidebar displays any channel folders configured by the organization.

Changes: New in Zulip 11.0 (feature level 411).

Source

pub fn with_web_left_sidebar_show_channel_folders(self, val: bool) -> Self

Builder function that sets the UserSettings web_left_sidebar_show_channel_folders.

Determines whether the web/desktop application’s left sidebar displays any channel folders configured by the organization.

Changes: New in Zulip 11.0 (feature level 411).

Source

pub const fn web_left_sidebar_unreads_count_summary(&self) -> Option<bool>

Gets the UserSettings web_left_sidebar_unreads_count_summary.

Determines whether the web/desktop application’s left sidebar displays the unread message count summary.

Changes: New in Zulip 11.0 (feature level 398).

Source

pub fn set_web_left_sidebar_unreads_count_summary(&mut self, val: bool)

Sets the UserSettings web_left_sidebar_unreads_count_summary.

Determines whether the web/desktop application’s left sidebar displays the unread message count summary.

Changes: New in Zulip 11.0 (feature level 398).

Source

pub fn unset_web_left_sidebar_unreads_count_summary(&mut self) -> Option<bool>

Unsets the UserSettings web_left_sidebar_unreads_count_summary.

Determines whether the web/desktop application’s left sidebar displays the unread message count summary.

Changes: New in Zulip 11.0 (feature level 398).

Source

pub fn with_web_left_sidebar_unreads_count_summary(self, val: bool) -> Self

Builder function that sets the UserSettings web_left_sidebar_unreads_count_summary.

Determines whether the web/desktop application’s left sidebar displays the unread message count summary.

Changes: New in Zulip 11.0 (feature level 398).

Source

pub const fn enter_sends(&self) -> Option<bool>

Gets the UserSettings enter_sends.

Whether the user setting for sending on pressing Enter in the compose box is enabled.

Source

pub fn set_enter_sends(&mut self, val: bool)

Sets the UserSettings enter_sends.

Whether the user setting for sending on pressing Enter in the compose box is enabled.

Source

pub fn unset_enter_sends(&mut self) -> Option<bool>

Unsets the UserSettings enter_sends.

Whether the user setting for sending on pressing Enter in the compose box is enabled.

Source

pub fn with_enter_sends(self, val: bool) -> Self

Builder function that sets the UserSettings enter_sends.

Whether the user setting for sending on pressing Enter in the compose box is enabled.

Source

pub const fn enable_drafts_synchronization(&self) -> Option<bool>

Gets the UserSettings enable_drafts_synchronization.

A boolean parameter to control whether synchronizing drafts is enabled for the user.

When synchronization is disabled, all drafts stored in the server will be automatically deleted from the server.

This does not do anything (like sending events) to delete local copies of drafts stored in clients.

Source

pub fn set_enable_drafts_synchronization(&mut self, val: bool)

Sets the UserSettings enable_drafts_synchronization.

A boolean parameter to control whether synchronizing drafts is enabled for the user.

When synchronization is disabled, all drafts stored in the server will be automatically deleted from the server.

This does not do anything (like sending events) to delete local copies of drafts stored in clients.

Source

pub fn unset_enable_drafts_synchronization(&mut self) -> Option<bool>

Unsets the UserSettings enable_drafts_synchronization.

A boolean parameter to control whether synchronizing drafts is enabled for the user.

When synchronization is disabled, all drafts stored in the server will be automatically deleted from the server.

This does not do anything (like sending events) to delete local copies of drafts stored in clients.

Source

pub fn with_enable_drafts_synchronization(self, val: bool) -> Self

Builder function that sets the UserSettings enable_drafts_synchronization.

A boolean parameter to control whether synchronizing drafts is enabled for the user.

When synchronization is disabled, all drafts stored in the server will be automatically deleted from the server.

This does not do anything (like sending events) to delete local copies of drafts stored in clients.

Source

pub const fn enable_stream_desktop_notifications(&self) -> Option<bool>

Gets the UserSettings enable_stream_desktop_notifications.

Enable visual desktop notifications for channel messages.

Source

pub fn set_enable_stream_desktop_notifications(&mut self, val: bool)

Sets the UserSettings enable_stream_desktop_notifications.

Enable visual desktop notifications for channel messages.

Source

pub fn unset_enable_stream_desktop_notifications(&mut self) -> Option<bool>

Unsets the UserSettings enable_stream_desktop_notifications.

Enable visual desktop notifications for channel messages.

Source

pub fn with_enable_stream_desktop_notifications(self, val: bool) -> Self

Builder function that sets the UserSettings enable_stream_desktop_notifications.

Enable visual desktop notifications for channel messages.

Source

pub const fn enable_stream_email_notifications(&self) -> Option<bool>

Gets the UserSettings enable_stream_email_notifications.

Enable email notifications for channel messages.

Source

pub fn set_enable_stream_email_notifications(&mut self, val: bool)

Sets the UserSettings enable_stream_email_notifications.

Enable email notifications for channel messages.

Source

pub fn unset_enable_stream_email_notifications(&mut self) -> Option<bool>

Unsets the UserSettings enable_stream_email_notifications.

Enable email notifications for channel messages.

Source

pub fn with_enable_stream_email_notifications(self, val: bool) -> Self

Builder function that sets the UserSettings enable_stream_email_notifications.

Enable email notifications for channel messages.

Source

pub const fn enable_stream_push_notifications(&self) -> Option<bool>

Gets the UserSettings enable_stream_push_notifications.

Enable mobile notifications for channel messages.

Source

pub fn set_enable_stream_push_notifications(&mut self, val: bool)

Sets the UserSettings enable_stream_push_notifications.

Enable mobile notifications for channel messages.

Source

pub fn unset_enable_stream_push_notifications(&mut self) -> Option<bool>

Unsets the UserSettings enable_stream_push_notifications.

Enable mobile notifications for channel messages.

Source

pub fn with_enable_stream_push_notifications(self, val: bool) -> Self

Builder function that sets the UserSettings enable_stream_push_notifications.

Enable mobile notifications for channel messages.

Source

pub const fn enable_stream_audible_notifications(&self) -> Option<bool>

Gets the UserSettings enable_stream_audible_notifications.

Enable audible desktop notifications for channel messages.

Source

pub fn set_enable_stream_audible_notifications(&mut self, val: bool)

Sets the UserSettings enable_stream_audible_notifications.

Enable audible desktop notifications for channel messages.

Source

pub fn unset_enable_stream_audible_notifications(&mut self) -> Option<bool>

Unsets the UserSettings enable_stream_audible_notifications.

Enable audible desktop notifications for channel messages.

Source

pub fn with_enable_stream_audible_notifications(self, val: bool) -> Self

Builder function that sets the UserSettings enable_stream_audible_notifications.

Enable audible desktop notifications for channel messages.

Source

pub const fn enable_desktop_notifications(&self) -> Option<bool>

Gets the UserSettings enable_desktop_notifications.

Enable visual desktop notifications for direct messages and @-mentions.

Source

pub fn set_enable_desktop_notifications(&mut self, val: bool)

Sets the UserSettings enable_desktop_notifications.

Enable visual desktop notifications for direct messages and @-mentions.

Source

pub fn unset_enable_desktop_notifications(&mut self) -> Option<bool>

Unsets the UserSettings enable_desktop_notifications.

Enable visual desktop notifications for direct messages and @-mentions.

Source

pub fn with_enable_desktop_notifications(self, val: bool) -> Self

Builder function that sets the UserSettings enable_desktop_notifications.

Enable visual desktop notifications for direct messages and @-mentions.

Source

pub const fn enable_sounds(&self) -> Option<bool>

Gets the UserSettings enable_sounds.

Enable audible desktop notifications for direct messages and @-mentions.

Source

pub fn set_enable_sounds(&mut self, val: bool)

Sets the UserSettings enable_sounds.

Enable audible desktop notifications for direct messages and @-mentions.

Source

pub fn unset_enable_sounds(&mut self) -> Option<bool>

Unsets the UserSettings enable_sounds.

Enable audible desktop notifications for direct messages and @-mentions.

Source

pub fn with_enable_sounds(self, val: bool) -> Self

Builder function that sets the UserSettings enable_sounds.

Enable audible desktop notifications for direct messages and @-mentions.

Source

pub const fn enable_followed_topic_desktop_notifications(&self) -> Option<bool>

Gets the UserSettings enable_followed_topic_desktop_notifications.

Enable visual desktop notifications for messages sent to followed topics. Changes: New in Zulip 8.0 (feature level 189).

Source

pub fn set_enable_followed_topic_desktop_notifications(&mut self, val: bool)

Sets the UserSettings enable_followed_topic_desktop_notifications.

Enable visual desktop notifications for messages sent to followed topics. Changes: New in Zulip 8.0 (feature level 189).

Source

pub fn unset_enable_followed_topic_desktop_notifications( &mut self, ) -> Option<bool>

Unsets the UserSettings enable_followed_topic_desktop_notifications.

Enable visual desktop notifications for messages sent to followed topics. Changes: New in Zulip 8.0 (feature level 189).

Source

pub fn with_enable_followed_topic_desktop_notifications(self, val: bool) -> Self

Builder function that sets the UserSettings enable_followed_topic_desktop_notifications.

Enable visual desktop notifications for messages sent to followed topics. Changes: New in Zulip 8.0 (feature level 189).

Source

pub const fn enable_followed_topic_email_notifications(&self) -> Option<bool>

Gets the UserSettings enable_followed_topic_email_notifications.

Enable email notifications for messages sent to followed topics. Changes: New in Zulip 8.0 (feature level 189).

Source

pub fn set_enable_followed_topic_email_notifications(&mut self, val: bool)

Sets the UserSettings enable_followed_topic_email_notifications.

Enable email notifications for messages sent to followed topics. Changes: New in Zulip 8.0 (feature level 189).

Source

pub fn unset_enable_followed_topic_email_notifications( &mut self, ) -> Option<bool>

Unsets the UserSettings enable_followed_topic_email_notifications.

Enable email notifications for messages sent to followed topics. Changes: New in Zulip 8.0 (feature level 189).

Source

pub fn with_enable_followed_topic_email_notifications(self, val: bool) -> Self

Builder function that sets the UserSettings enable_followed_topic_email_notifications.

Enable email notifications for messages sent to followed topics. Changes: New in Zulip 8.0 (feature level 189).

Source

pub const fn enable_followed_topic_push_notifications(&self) -> Option<bool>

Gets the UserSettings enable_followed_topic_push_notifications.

Enable push notifications for messages sent to followed topics. Changes: New in Zulip 8.0 (feature level 189).

Source

pub fn set_enable_followed_topic_push_notifications(&mut self, val: bool)

Sets the UserSettings enable_followed_topic_push_notifications.

Enable push notifications for messages sent to followed topics. Changes: New in Zulip 8.0 (feature level 189).

Source

pub fn unset_enable_followed_topic_push_notifications(&mut self) -> Option<bool>

Unsets the UserSettings enable_followed_topic_push_notifications.

Enable push notifications for messages sent to followed topics. Changes: New in Zulip 8.0 (feature level 189).

Source

pub fn with_enable_followed_topic_push_notifications(self, val: bool) -> Self

Builder function that sets the UserSettings enable_followed_topic_push_notifications.

Enable push notifications for messages sent to followed topics. Changes: New in Zulip 8.0 (feature level 189).

Source

pub const fn enable_followed_topic_audible_notifications(&self) -> Option<bool>

Gets the UserSettings enable_followed_topic_audible_notifications.

Enable audible desktop notifications for messages sent to followed topics. Changes: New in Zulip 8.0 (feature level 189).

Source

pub fn set_enable_followed_topic_audible_notifications(&mut self, val: bool)

Sets the UserSettings enable_followed_topic_audible_notifications.

Enable audible desktop notifications for messages sent to followed topics. Changes: New in Zulip 8.0 (feature level 189).

Source

pub fn unset_enable_followed_topic_audible_notifications( &mut self, ) -> Option<bool>

Unsets the UserSettings enable_followed_topic_audible_notifications.

Enable audible desktop notifications for messages sent to followed topics. Changes: New in Zulip 8.0 (feature level 189).

Source

pub fn with_enable_followed_topic_audible_notifications(self, val: bool) -> Self

Builder function that sets the UserSettings enable_followed_topic_audible_notifications.

Enable audible desktop notifications for messages sent to followed topics. Changes: New in Zulip 8.0 (feature level 189).

Source

pub const fn email_notifications_batching_period_seconds(&self) -> Option<i32>

Gets the UserSettings email_notifications_batching_period_seconds.

The duration (in seconds) for which the server should wait to batch email notifications before sending them.

Source

pub fn set_email_notifications_batching_period_seconds(&mut self, val: i32)

Sets the UserSettings email_notifications_batching_period_seconds.

The duration (in seconds) for which the server should wait to batch email notifications before sending them.

Source

pub fn unset_email_notifications_batching_period_seconds( &mut self, ) -> Option<i32>

Unsets the UserSettings email_notifications_batching_period_seconds.

The duration (in seconds) for which the server should wait to batch email notifications before sending them.

Source

pub fn with_email_notifications_batching_period_seconds(self, val: i32) -> Self

Builder function that sets the UserSettings email_notifications_batching_period_seconds.

The duration (in seconds) for which the server should wait to batch email notifications before sending them.

Source

pub const fn enable_offline_email_notifications(&self) -> Option<bool>

Gets the UserSettings enable_offline_email_notifications.

Enable email notifications for direct messages and @-mentions received when the user is offline.

Source

pub fn set_enable_offline_email_notifications(&mut self, val: bool)

Sets the UserSettings enable_offline_email_notifications.

Enable email notifications for direct messages and @-mentions received when the user is offline.

Source

pub fn unset_enable_offline_email_notifications(&mut self) -> Option<bool>

Unsets the UserSettings enable_offline_email_notifications.

Enable email notifications for direct messages and @-mentions received when the user is offline.

Source

pub fn with_enable_offline_email_notifications(self, val: bool) -> Self

Builder function that sets the UserSettings enable_offline_email_notifications.

Enable email notifications for direct messages and @-mentions received when the user is offline.

Source

pub const fn enable_offline_push_notifications(&self) -> Option<bool>

Gets the UserSettings enable_offline_push_notifications.

Enable mobile notification for direct messages and @-mentions received when the user is offline.

Source

pub fn set_enable_offline_push_notifications(&mut self, val: bool)

Sets the UserSettings enable_offline_push_notifications.

Enable mobile notification for direct messages and @-mentions received when the user is offline.

Source

pub fn unset_enable_offline_push_notifications(&mut self) -> Option<bool>

Unsets the UserSettings enable_offline_push_notifications.

Enable mobile notification for direct messages and @-mentions received when the user is offline.

Source

pub fn with_enable_offline_push_notifications(self, val: bool) -> Self

Builder function that sets the UserSettings enable_offline_push_notifications.

Enable mobile notification for direct messages and @-mentions received when the user is offline.

Source

pub const fn enable_online_push_notifications(&self) -> Option<bool>

Gets the UserSettings enable_online_push_notifications.

Enable mobile notification for direct messages and @-mentions received when the user is online.

Source

pub fn set_enable_online_push_notifications(&mut self, val: bool)

Sets the UserSettings enable_online_push_notifications.

Enable mobile notification for direct messages and @-mentions received when the user is online.

Source

pub fn unset_enable_online_push_notifications(&mut self) -> Option<bool>

Unsets the UserSettings enable_online_push_notifications.

Enable mobile notification for direct messages and @-mentions received when the user is online.

Source

pub fn with_enable_online_push_notifications(self, val: bool) -> Self

Builder function that sets the UserSettings enable_online_push_notifications.

Enable mobile notification for direct messages and @-mentions received when the user is online.

Source

pub const fn enable_digest_emails(&self) -> Option<bool>

Gets the UserSettings enable_digest_emails.

Enable digest emails when the user is away.

Source

pub fn set_enable_digest_emails(&mut self, val: bool)

Sets the UserSettings enable_digest_emails.

Enable digest emails when the user is away.

Source

pub fn unset_enable_digest_emails(&mut self) -> Option<bool>

Unsets the UserSettings enable_digest_emails.

Enable digest emails when the user is away.

Source

pub fn with_enable_digest_emails(self, val: bool) -> Self

Builder function that sets the UserSettings enable_digest_emails.

Enable digest emails when the user is away.

Source

pub const fn enable_marketing_emails(&self) -> Option<bool>

Gets the UserSettings enable_marketing_emails.

Enable marketing emails. Has no function outside Zulip Cloud.

Source

pub fn set_enable_marketing_emails(&mut self, val: bool)

Sets the UserSettings enable_marketing_emails.

Enable marketing emails. Has no function outside Zulip Cloud.

Source

pub fn unset_enable_marketing_emails(&mut self) -> Option<bool>

Unsets the UserSettings enable_marketing_emails.

Enable marketing emails. Has no function outside Zulip Cloud.

Source

pub fn with_enable_marketing_emails(self, val: bool) -> Self

Builder function that sets the UserSettings enable_marketing_emails.

Enable marketing emails. Has no function outside Zulip Cloud.

Source

pub const fn enable_login_emails(&self) -> Option<bool>

Gets the UserSettings enable_login_emails.

Enable email notifications for new logins to account.

Source

pub fn set_enable_login_emails(&mut self, val: bool)

Sets the UserSettings enable_login_emails.

Enable email notifications for new logins to account.

Source

pub fn unset_enable_login_emails(&mut self) -> Option<bool>

Unsets the UserSettings enable_login_emails.

Enable email notifications for new logins to account.

Source

pub fn with_enable_login_emails(self, val: bool) -> Self

Builder function that sets the UserSettings enable_login_emails.

Enable email notifications for new logins to account.

Source

pub const fn message_content_in_email_notifications(&self) -> Option<bool>

Gets the UserSettings message_content_in_email_notifications.

Include the message’s content in email notifications for new messages.

Source

pub fn set_message_content_in_email_notifications(&mut self, val: bool)

Sets the UserSettings message_content_in_email_notifications.

Include the message’s content in email notifications for new messages.

Source

pub fn unset_message_content_in_email_notifications(&mut self) -> Option<bool>

Unsets the UserSettings message_content_in_email_notifications.

Include the message’s content in email notifications for new messages.

Source

pub fn with_message_content_in_email_notifications(self, val: bool) -> Self

Builder function that sets the UserSettings message_content_in_email_notifications.

Include the message’s content in email notifications for new messages.

Source

pub const fn pm_content_in_desktop_notifications(&self) -> Option<bool>

Gets the UserSettings pm_content_in_desktop_notifications.

Include content of direct messages in desktop notifications.

Source

pub fn set_pm_content_in_desktop_notifications(&mut self, val: bool)

Sets the UserSettings pm_content_in_desktop_notifications.

Include content of direct messages in desktop notifications.

Source

pub fn unset_pm_content_in_desktop_notifications(&mut self) -> Option<bool>

Unsets the UserSettings pm_content_in_desktop_notifications.

Include content of direct messages in desktop notifications.

Source

pub fn with_pm_content_in_desktop_notifications(self, val: bool) -> Self

Builder function that sets the UserSettings pm_content_in_desktop_notifications.

Include content of direct messages in desktop notifications.

Source

pub const fn wildcard_mentions_notify(&self) -> Option<bool>

Gets the UserSettings wildcard_mentions_notify.

Whether wildcard mentions (E.g. @all) should send notifications like a personal mention.

Source

pub fn set_wildcard_mentions_notify(&mut self, val: bool)

Sets the UserSettings wildcard_mentions_notify.

Whether wildcard mentions (E.g. @all) should send notifications like a personal mention.

Source

pub fn unset_wildcard_mentions_notify(&mut self) -> Option<bool>

Unsets the UserSettings wildcard_mentions_notify.

Whether wildcard mentions (E.g. @all) should send notifications like a personal mention.

Source

pub fn with_wildcard_mentions_notify(self, val: bool) -> Self

Builder function that sets the UserSettings wildcard_mentions_notify.

Whether wildcard mentions (E.g. @all) should send notifications like a personal mention.

Source

pub const fn enable_followed_topic_wildcard_mentions_notify( &self, ) -> Option<bool>

Gets the UserSettings enable_followed_topic_wildcard_mentions_notify.

Whether wildcard mentions (e.g., @all) in messages sent to followed topics should send notifications like a personal mention.

Changes: New in Zulip 8.0 (feature level 189).

Source

pub fn set_enable_followed_topic_wildcard_mentions_notify(&mut self, val: bool)

Sets the UserSettings enable_followed_topic_wildcard_mentions_notify.

Whether wildcard mentions (e.g., @all) in messages sent to followed topics should send notifications like a personal mention.

Changes: New in Zulip 8.0 (feature level 189).

Source

pub fn unset_enable_followed_topic_wildcard_mentions_notify( &mut self, ) -> Option<bool>

Unsets the UserSettings enable_followed_topic_wildcard_mentions_notify.

Whether wildcard mentions (e.g., @all) in messages sent to followed topics should send notifications like a personal mention.

Changes: New in Zulip 8.0 (feature level 189).

Source

pub fn with_enable_followed_topic_wildcard_mentions_notify( self, val: bool, ) -> Self

Builder function that sets the UserSettings enable_followed_topic_wildcard_mentions_notify.

Whether wildcard mentions (e.g., @all) in messages sent to followed topics should send notifications like a personal mention.

Changes: New in Zulip 8.0 (feature level 189).

Source

pub const fn desktop_icon_count_display( &self, ) -> Option<DesktopIconCountDisplay>

Gets the UserSettings desktop_icon_count_display.

Unread count badge (appears in desktop sidebar and browser tab)

Source

pub fn set_desktop_icon_count_display(&mut self, val: DesktopIconCountDisplay)

Sets the UserSettings desktop_icon_count_display.

Unread count badge (appears in desktop sidebar and browser tab)

Source

pub fn unset_desktop_icon_count_display( &mut self, ) -> Option<DesktopIconCountDisplay>

Unsets the UserSettings desktop_icon_count_display.

Unread count badge (appears in desktop sidebar and browser tab)

Source

pub fn with_desktop_icon_count_display( self, val: DesktopIconCountDisplay, ) -> Self

Builder function that sets the UserSettings desktop_icon_count_display.

Unread count badge (appears in desktop sidebar and browser tab)

Source

pub const fn realm_name_in_email_notifications_policy( &self, ) -> Option<RealmNameInEmailNotificationsPolicy>

Gets the UserSettings realm_name_in_email_notifications_policy.

Whether to include organization name in subject of message notification emails.

Source

pub fn set_realm_name_in_email_notifications_policy( &mut self, val: RealmNameInEmailNotificationsPolicy, )

Sets the UserSettings realm_name_in_email_notifications_policy.

Whether to include organization name in subject of message notification emails.

Source

pub fn unset_realm_name_in_email_notifications_policy( &mut self, ) -> Option<RealmNameInEmailNotificationsPolicy>

Unsets the UserSettings realm_name_in_email_notifications_policy.

Whether to include organization name in subject of message notification emails.

Source

pub fn with_realm_name_in_email_notifications_policy( self, val: RealmNameInEmailNotificationsPolicy, ) -> Self

Builder function that sets the UserSettings realm_name_in_email_notifications_policy.

Whether to include organization name in subject of message notification emails.

Source

pub const fn automatically_follow_topics_policy( &self, ) -> Option<AutomaticallyFollowTopicsPolicy>

Gets the UserSettings automatically_follow_topics_policy.

Which topics to follow automatically.

Source

pub fn set_automatically_follow_topics_policy( &mut self, val: AutomaticallyFollowTopicsPolicy, )

Sets the UserSettings automatically_follow_topics_policy.

Which topics to follow automatically.

Source

pub fn unset_automatically_follow_topics_policy( &mut self, ) -> Option<AutomaticallyFollowTopicsPolicy>

Unsets the UserSettings automatically_follow_topics_policy.

Which topics to follow automatically.

Source

pub fn with_automatically_follow_topics_policy( self, val: AutomaticallyFollowTopicsPolicy, ) -> Self

Builder function that sets the UserSettings automatically_follow_topics_policy.

Which topics to follow automatically.

Source

pub const fn automatically_unmute_topics_in_muted_streams_policy( &self, ) -> Option<AutomaticallyUnmuteTopicsInMutedStreamsPolicy>

Gets the UserSettings automatically_unmute_topics_in_muted_streams_policy.

Which topics to unmute automatically in muted channels.

Source

pub fn set_automatically_unmute_topics_in_muted_streams_policy( &mut self, val: AutomaticallyUnmuteTopicsInMutedStreamsPolicy, )

Sets the UserSettings automatically_unmute_topics_in_muted_streams_policy.

Which topics to unmute automatically in muted channels.

Source

pub fn unset_automatically_unmute_topics_in_muted_streams_policy( &mut self, ) -> Option<AutomaticallyUnmuteTopicsInMutedStreamsPolicy>

Unsets the UserSettings automatically_unmute_topics_in_muted_streams_policy.

Which topics to unmute automatically in muted channels.

Source

pub fn with_automatically_unmute_topics_in_muted_streams_policy( self, val: AutomaticallyUnmuteTopicsInMutedStreamsPolicy, ) -> Self

Builder function that sets the UserSettings automatically_unmute_topics_in_muted_streams_policy.

Which topics to unmute automatically in muted channels.

Source

pub const fn automatically_follow_topics_where_mentioned(&self) -> Option<bool>

Gets the UserSettings automatically_follow_topics_where_mentioned.

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

Changes: New in Zulip 8.0 (feature level 235).

Source

pub fn set_automatically_follow_topics_where_mentioned(&mut self, val: bool)

Sets the UserSettings automatically_follow_topics_where_mentioned.

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

Changes: New in Zulip 8.0 (feature level 235).

Source

pub fn unset_automatically_follow_topics_where_mentioned( &mut self, ) -> Option<bool>

Unsets the UserSettings automatically_follow_topics_where_mentioned.

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

Changes: New in Zulip 8.0 (feature level 235).

Source

pub fn with_automatically_follow_topics_where_mentioned(self, val: bool) -> Self

Builder function that sets the UserSettings automatically_follow_topics_where_mentioned.

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

Changes: New in Zulip 8.0 (feature level 235).

Source

pub const fn resolved_topic_notice_auto_read_policy( &self, ) -> Option<ResolvedTopicNoticeAutoReadPolicy>

Gets the UserSettings resolved_topic_notice_auto_read_policy.

Controls whether the resolved-topic notices are marked as read.

Source

pub fn set_resolved_topic_notice_auto_read_policy( &mut self, val: ResolvedTopicNoticeAutoReadPolicy, )

Sets the UserSettings resolved_topic_notice_auto_read_policy.

Controls whether the resolved-topic notices are marked as read.

Source

pub fn unset_resolved_topic_notice_auto_read_policy( &mut self, ) -> Option<ResolvedTopicNoticeAutoReadPolicy>

Unsets the UserSettings resolved_topic_notice_auto_read_policy.

Controls whether the resolved-topic notices are marked as read.

Source

pub fn with_resolved_topic_notice_auto_read_policy( self, val: ResolvedTopicNoticeAutoReadPolicy, ) -> Self

Builder function that sets the UserSettings resolved_topic_notice_auto_read_policy.

Controls whether the resolved-topic notices are marked as read.

Source

pub const fn presence_enabled(&self) -> Option<bool>

Gets the UserSettings presence_enabled.

Display the presence status to other users when online.

Source

pub fn set_presence_enabled(&mut self, val: bool)

Sets the UserSettings presence_enabled.

Display the presence status to other users when online.

Source

pub fn unset_presence_enabled(&mut self) -> Option<bool>

Unsets the UserSettings presence_enabled.

Display the presence status to other users when online.

Source

pub fn with_presence_enabled(self, val: bool) -> Self

Builder function that sets the UserSettings presence_enabled.

Display the presence status to other users when online.

Source

pub const fn send_private_typing_notifications(&self) -> Option<bool>

Gets the UserSettings send_private_typing_notifications.

Whether the user has chosen to send typing notifications when composing direct messages.

The client should send typing notifications for direct messages if and only if this setting is enabled.

Changes: New in Zulip 5.0 (feature level 105).

Source

pub fn set_send_private_typing_notifications(&mut self, val: bool)

Sets the UserSettings send_private_typing_notifications.

Whether the user has chosen to send typing notifications when composing direct messages.

The client should send typing notifications for direct messages if and only if this setting is enabled.

Changes: New in Zulip 5.0 (feature level 105).

Source

pub fn unset_send_private_typing_notifications(&mut self) -> Option<bool>

Unsets the UserSettings send_private_typing_notifications.

Whether the user has chosen to send typing notifications when composing direct messages.

The client should send typing notifications for direct messages if and only if this setting is enabled.

Changes: New in Zulip 5.0 (feature level 105).

Source

pub fn with_send_private_typing_notifications(self, val: bool) -> Self

Builder function that sets the UserSettings send_private_typing_notifications.

Whether the user has chosen to send typing notifications when composing direct messages.

The client should send typing notifications for direct messages if and only if this setting is enabled.

Changes: New in Zulip 5.0 (feature level 105).

Source

pub const fn send_stream_typing_notifications(&self) -> Option<bool>

Gets the UserSettings send_stream_typing_notifications.

Whether the user has chosen to send typing notifications when composing channel messages.

The client should send typing notifications for channel messages if and only if this setting is enabled.

Changes: New in Zulip 5.0 (feature level 105).

Source

pub fn set_send_stream_typing_notifications(&mut self, val: bool)

Sets the UserSettings send_stream_typing_notifications.

Whether the user has chosen to send typing notifications when composing channel messages.

The client should send typing notifications for channel messages if and only if this setting is enabled.

Changes: New in Zulip 5.0 (feature level 105).

Source

pub fn unset_send_stream_typing_notifications(&mut self) -> Option<bool>

Unsets the UserSettings send_stream_typing_notifications.

Whether the user has chosen to send typing notifications when composing channel messages.

The client should send typing notifications for channel messages if and only if this setting is enabled.

Changes: New in Zulip 5.0 (feature level 105).

Source

pub fn with_send_stream_typing_notifications(self, val: bool) -> Self

Builder function that sets the UserSettings send_stream_typing_notifications.

Whether the user has chosen to send typing notifications when composing channel messages.

The client should send typing notifications for channel messages if and only if this setting is enabled.

Changes: New in Zulip 5.0 (feature level 105).

Source

pub const fn send_read_receipts(&self) -> Option<bool>

Gets the UserSettings send_read_receipts.

Whether other users are allowed to see whether you’ve read messages.

Changes: New in Zulip 5.0 (feature level 105).

Source

pub fn set_send_read_receipts(&mut self, val: bool)

Sets the UserSettings send_read_receipts.

Whether other users are allowed to see whether you’ve read messages.

Changes: New in Zulip 5.0 (feature level 105).

Source

pub fn unset_send_read_receipts(&mut self) -> Option<bool>

Unsets the UserSettings send_read_receipts.

Whether other users are allowed to see whether you’ve read messages.

Changes: New in Zulip 5.0 (feature level 105).

Source

pub fn with_send_read_receipts(self, val: bool) -> Self

Builder function that sets the UserSettings send_read_receipts.

Whether other users are allowed to see whether you’ve read messages.

Changes: New in Zulip 5.0 (feature level 105).

Source

pub const fn allow_private_data_export(&self) -> Option<bool>

Gets the UserSettings allow_private_data_export.

Whether organization administrators are allowed to export your private data.

Changes: New in Zulip 10.0 (feature level 293).

Source

pub fn set_allow_private_data_export(&mut self, val: bool)

Sets the UserSettings allow_private_data_export.

Whether organization administrators are allowed to export your private data.

Changes: New in Zulip 10.0 (feature level 293).

Source

pub fn unset_allow_private_data_export(&mut self) -> Option<bool>

Unsets the UserSettings allow_private_data_export.

Whether organization administrators are allowed to export your private data.

Changes: New in Zulip 10.0 (feature level 293).

Source

pub fn with_allow_private_data_export(self, val: bool) -> Self

Builder function that sets the UserSettings allow_private_data_export.

Whether organization administrators are allowed to export your private data.

Changes: New in Zulip 10.0 (feature level 293).

Source

pub const fn email_address_visibility(&self) -> Option<EmailAddressVisibility>

Gets the UserSettings email_address_visibility.

The policy for

which other users in this organization can see the user’s real email address.

Source

pub fn set_email_address_visibility(&mut self, val: EmailAddressVisibility)

Sets the UserSettings email_address_visibility.

The policy for

which other users in this organization can see the user’s real email address.

Source

pub fn unset_email_address_visibility( &mut self, ) -> Option<EmailAddressVisibility>

Unsets the UserSettings email_address_visibility.

The policy for

which other users in this organization can see the user’s real email address.

Source

pub fn with_email_address_visibility(self, val: EmailAddressVisibility) -> Self

Builder function that sets the UserSettings email_address_visibility.

The policy for

which other users in this organization can see the user’s real email address.

Source

pub const fn web_navigate_to_sent_message(&self) -> Option<bool>

Gets the UserSettings web_navigate_to_sent_message.

Web/desktop app setting for whether the user’s view should automatically go to the conversation where they sent a message.

Changes: New in Zulip 9.0 (feature level 268). Previously, this behavior was not configurable.

Source

pub fn set_web_navigate_to_sent_message(&mut self, val: bool)

Sets the UserSettings web_navigate_to_sent_message.

Web/desktop app setting for whether the user’s view should automatically go to the conversation where they sent a message.

Changes: New in Zulip 9.0 (feature level 268). Previously, this behavior was not configurable.

Source

pub fn unset_web_navigate_to_sent_message(&mut self) -> Option<bool>

Unsets the UserSettings web_navigate_to_sent_message.

Web/desktop app setting for whether the user’s view should automatically go to the conversation where they sent a message.

Changes: New in Zulip 9.0 (feature level 268). Previously, this behavior was not configurable.

Source

pub fn with_web_navigate_to_sent_message(self, val: bool) -> Self

Builder function that sets the UserSettings web_navigate_to_sent_message.

Web/desktop app setting for whether the user’s view should automatically go to the conversation where they sent a message.

Changes: New in Zulip 9.0 (feature level 268). Previously, this behavior was not configurable.

Source§

impl UserSettings

Source

pub fn default_language(&self) -> Option<&str>

Gets the UserSettings default_language.

What default language to use for the account.

This controls both the Zulip UI as well as email notifications sent to the user.

The value needs to be a standard language code that the Zulip server has translation data for; for example, \"en\" for English or \"de\" for German.

Source

pub fn set_default_language<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)

Sets the UserSettings default_language.

What default language to use for the account.

This controls both the Zulip UI as well as email notifications sent to the user.

The value needs to be a standard language code that the Zulip server has translation data for; for example, \"en\" for English or \"de\" for German.

Source

pub fn unset_default_language(&mut self) -> Option<String>

Unsets the UserSettings default_language.

What default language to use for the account.

This controls both the Zulip UI as well as email notifications sent to the user.

The value needs to be a standard language code that the Zulip server has translation data for; for example, \"en\" for English or \"de\" for German.

Source

pub fn with_default_language<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self

Builder function that sets the UserSettings default_language.

What default language to use for the account.

This controls both the Zulip UI as well as email notifications sent to the user.

The value needs to be a standard language code that the Zulip server has translation data for; for example, \"en\" for English or \"de\" for German.

Source

pub fn notification_sound(&self) -> Option<&str>

Gets the UserSettings notification_sound.

Notification sound name.

Source

pub fn set_notification_sound<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)

Sets the UserSettings notification_sound.

Notification sound name.

Source

pub fn unset_notification_sound(&mut self) -> Option<String>

Unsets the UserSettings notification_sound.

Notification sound name.

Source

pub fn with_notification_sound<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self

Builder function that sets the UserSettings notification_sound.

Notification sound name.

Source

pub fn timezone(&self) -> Option<&str>

Gets the UserSettings timezone.

The IANA identifier of the user’s profile time zone, which is used primarily to display the user’s local time to other users.

Source

pub fn set_timezone<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)

Sets the UserSettings timezone.

The IANA identifier of the user’s profile time zone, which is used primarily to display the user’s local time to other users.

Source

pub fn unset_timezone(&mut self) -> Option<String>

Unsets the UserSettings timezone.

The IANA identifier of the user’s profile time zone, which is used primarily to display the user’s local time to other users.

Source

pub fn with_timezone<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self

Builder function that sets the UserSettings timezone.

The IANA identifier of the user’s profile time zone, which is used primarily to display the user’s local time to other users.

Source

pub fn available_notification_sounds(&self) -> Option<&[String]>

Gets the UserSettings available_notification_sounds.

Array containing the names of the notification sound options supported by this Zulip server.

Only relevant to support UI for configuring notification sounds.

Source

pub fn set_available_notification_sounds<'a, C: Into<Cow<'a, [String]>>>( &mut self, val: C, )

Sets the UserSettings available_notification_sounds.

Array containing the names of the notification sound options supported by this Zulip server.

Only relevant to support UI for configuring notification sounds.

Source

pub fn unset_available_notification_sounds(&mut self) -> Option<Vec<String>>

Unsets the UserSettings available_notification_sounds.

Array containing the names of the notification sound options supported by this Zulip server.

Only relevant to support UI for configuring notification sounds.

Source

pub fn with_available_notification_sounds<'a, C: Into<Cow<'a, [String]>>>( self, val: C, ) -> Self

Builder function that sets the UserSettings available_notification_sounds.

Array containing the names of the notification sound options supported by this Zulip server.

Only relevant to support UI for configuring notification sounds.

Source

pub fn emojiset_choices(&self) -> Option<&[UserSettingsEmojisetChoice]>

Gets the UserSettings emojiset_choices.

Array of dictionaries where each dictionary describes an emoji set supported by this version of the Zulip server.

Only relevant to clients with configuration UI for choosing an emoji set; the currently selected emoji set is available in the emojiset key.

See PATCH /settings for details on the meaning of this setting.

Source

pub fn set_emojiset_choices<'a, C: Into<Cow<'a, [UserSettingsEmojisetChoice]>>>( &mut self, val: C, )

Sets the UserSettings emojiset_choices.

Array of dictionaries where each dictionary describes an emoji set supported by this version of the Zulip server.

Only relevant to clients with configuration UI for choosing an emoji set; the currently selected emoji set is available in the emojiset key.

See PATCH /settings for details on the meaning of this setting.

Source

pub fn unset_emojiset_choices( &mut self, ) -> Option<Vec<UserSettingsEmojisetChoice>>

Unsets the UserSettings emojiset_choices.

Array of dictionaries where each dictionary describes an emoji set supported by this version of the Zulip server.

Only relevant to clients with configuration UI for choosing an emoji set; the currently selected emoji set is available in the emojiset key.

See PATCH /settings for details on the meaning of this setting.

Source

pub fn with_emojiset_choices<'a, C: Into<Cow<'a, [UserSettingsEmojisetChoice]>>>( self, val: C, ) -> Self

Builder function that sets the UserSettings emojiset_choices.

Array of dictionaries where each dictionary describes an emoji set supported by this version of the Zulip server.

Only relevant to clients with configuration UI for choosing an emoji set; the currently selected emoji set is available in the emojiset key.

See PATCH /settings for details on the meaning of this setting.

Trait Implementations§

Source§

impl Clone for UserSettings

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for UserSettings

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for UserSettings

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for UserSettings

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for UserSettings

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for UserSettings

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for UserSettings

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for UserSettings

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more