Struct Response 

pub struct Response { /* private fields */ }

Represents the response to a Register Zulip API request.

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

impl Response

pub const fn new() -> Self

Creates a new Response.

impl Response

pub const fn last_event_id(&self) -> Option<i64>

Gets the Response last_event_id.

The initial value of last_event_id to pass to GET /api/v1/events.

pub fn set_last_event_id(&mut self, val: i64)

Sets the Response last_event_id.

The initial value of last_event_id to pass to GET /api/v1/events.

pub fn unset_last_event_id(&mut self) -> Option<i64>

Unsets the Response last_event_id.

The initial value of last_event_id to pass to GET /api/v1/events.

pub fn with_last_event_id(self, val: i64) -> Self

Builder function that sets the Response last_event_id.

The initial value of last_event_id to pass to GET /api/v1/events.

pub const fn zulip_feature_level(&self) -> Option<i64>

Gets the Response zulip_feature_level.

The server’s current Zulip feature level.

Changes: As of Zulip 3.0 (feature level 3), this is always present in the endpoint’s response.

Previously, it was only present if event_types included zulip_version.

New in Zulip 3.0 (feature level 1).

pub fn set_zulip_feature_level(&mut self, val: i64)

Sets the Response zulip_feature_level.

The server’s current Zulip feature level.

Changes: As of Zulip 3.0 (feature level 3), this is always present in the endpoint’s response.

Previously, it was only present if event_types included zulip_version.

New in Zulip 3.0 (feature level 1).

pub fn unset_zulip_feature_level(&mut self) -> Option<i64>

Unsets the Response zulip_feature_level.

The server’s current Zulip feature level.

Changes: As of Zulip 3.0 (feature level 3), this is always present in the endpoint’s response.

Previously, it was only present if event_types included zulip_version.

New in Zulip 3.0 (feature level 1).

pub fn with_zulip_feature_level(self, val: i64) -> Self

Builder function that sets the Response zulip_feature_level.

The server’s current Zulip feature level.

Changes: As of Zulip 3.0 (feature level 3), this is always present in the endpoint’s response.

Previously, it was only present if event_types included zulip_version.

New in Zulip 3.0 (feature level 1).

pub const fn realm_date_created(&self) -> Option<i64>

Gets the Response realm_date_created.

The UNIX timestamp (UTC) for when the organization was created.

Present if realm is present in fetch_event_types.

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

pub fn set_realm_date_created(&mut self, val: i64)

Sets the Response realm_date_created.

The UNIX timestamp (UTC) for when the organization was created.

Present if realm is present in fetch_event_types.

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

pub fn unset_realm_date_created(&mut self) -> Option<i64>

Unsets the Response realm_date_created.

The UNIX timestamp (UTC) for when the organization was created.

Present if realm is present in fetch_event_types.

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

pub fn with_realm_date_created(self, val: i64) -> Self

Builder function that sets the Response realm_date_created.

The UNIX timestamp (UTC) for when the organization was created.

Present if realm is present in fetch_event_types.

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

pub const fn demo_organization_scheduled_deletion_date(&self) -> Option<i64>

Gets the Response demo_organization_scheduled_deletion_date.

The UNIX timestamp (UTC) when the demo organization will be automatically deleted.

Present if realm is present in fetch_event_types, and the realm is a demo organization.

Clients should use this to display a prominent warning to the user that the organization will be deleted at the indicated time.

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

pub fn set_demo_organization_scheduled_deletion_date(&mut self, val: i64)

Sets the Response demo_organization_scheduled_deletion_date.

The UNIX timestamp (UTC) when the demo organization will be automatically deleted.

Present if realm is present in fetch_event_types, and the realm is a demo organization.

Clients should use this to display a prominent warning to the user that the organization will be deleted at the indicated time.

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

pub fn unset_demo_organization_scheduled_deletion_date(&mut self) -> Option<i64>

Unsets the Response demo_organization_scheduled_deletion_date.

The UNIX timestamp (UTC) when the demo organization will be automatically deleted.

Present if realm is present in fetch_event_types, and the realm is a demo organization.

Clients should use this to display a prominent warning to the user that the organization will be deleted at the indicated time.

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

pub fn with_demo_organization_scheduled_deletion_date(self, val: i64) -> Self

Builder function that sets the Response demo_organization_scheduled_deletion_date.

The UNIX timestamp (UTC) when the demo organization will be automatically deleted.

Present if realm is present in fetch_event_types, and the realm is a demo organization.

Clients should use this to display a prominent warning to the user that the organization will be deleted at the indicated time.

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

pub const fn max_message_id(&self) -> Option<i64>

Gets the Response max_message_id.

The highest message ID among all messages the user has received as of the moment of this request.

Present if message is present in fetch_event_types.

Deprecated: This field may be removed in future versions as it no longer has a clear purpose.

Clients wishing to fetch the latest messages should pass \"anchor\": \"latest\" to GET /messages.

pub fn set_max_message_id(&mut self, val: i64)

Sets the Response max_message_id.

The highest message ID among all messages the user has received as of the moment of this request.

Present if message is present in fetch_event_types.

Deprecated: This field may be removed in future versions as it no longer has a clear purpose.

Clients wishing to fetch the latest messages should pass \"anchor\": \"latest\" to GET /messages.

pub fn unset_max_message_id(&mut self) -> Option<i64>

Unsets the Response max_message_id.

The highest message ID among all messages the user has received as of the moment of this request.

Present if message is present in fetch_event_types.

Deprecated: This field may be removed in future versions as it no longer has a clear purpose.

Clients wishing to fetch the latest messages should pass \"anchor\": \"latest\" to GET /messages.

pub fn with_max_message_id(self, val: i64) -> Self

Builder function that sets the Response max_message_id.

The highest message ID among all messages the user has received as of the moment of this request.

Present if message is present in fetch_event_types.

Deprecated: This field may be removed in future versions as it no longer has a clear purpose.

Clients wishing to fetch the latest messages should pass \"anchor\": \"latest\" to GET /messages.

pub const fn max_reminder_note_length(&self) -> Option<i64>

Gets the Response max_reminder_note_length.

The maximum allowed length for a reminder note. Changes: New in Zulip 11.0 (feature level 415).

pub fn set_max_reminder_note_length(&mut self, val: i64)

Sets the Response max_reminder_note_length.

The maximum allowed length for a reminder note. Changes: New in Zulip 11.0 (feature level 415).

pub fn unset_max_reminder_note_length(&mut self) -> Option<i64>

Unsets the Response max_reminder_note_length.

The maximum allowed length for a reminder note. Changes: New in Zulip 11.0 (feature level 415).

pub fn with_max_reminder_note_length(self, val: i64) -> Self

Builder function that sets the Response max_reminder_note_length.

The maximum allowed length for a reminder note. Changes: New in Zulip 11.0 (feature level 415).

pub const fn max_stream_description_length(&self) -> Option<i64>

Gets the Response max_stream_description_length.

The maximum allowed length for a channel description, in Unicode code points. Clients should use this property rather than hardcoding field sizes.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 53). Previously, this required stream in fetch_event_types, was called stream_description_max_length, and always had a value of 1024.

pub fn set_max_stream_description_length(&mut self, val: i64)

Sets the Response max_stream_description_length.

The maximum allowed length for a channel description, in Unicode code points. Clients should use this property rather than hardcoding field sizes.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 53). Previously, this required stream in fetch_event_types, was called stream_description_max_length, and always had a value of 1024.

pub fn unset_max_stream_description_length(&mut self) -> Option<i64>

Unsets the Response max_stream_description_length.

The maximum allowed length for a channel description, in Unicode code points. Clients should use this property rather than hardcoding field sizes.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 53). Previously, this required stream in fetch_event_types, was called stream_description_max_length, and always had a value of 1024.

pub fn with_max_stream_description_length(self, val: i64) -> Self

Builder function that sets the Response max_stream_description_length.

The maximum allowed length for a channel description, in Unicode code points. Clients should use this property rather than hardcoding field sizes.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 53). Previously, this required stream in fetch_event_types, was called stream_description_max_length, and always had a value of 1024.

pub const fn max_channel_folder_description_length(&self) -> Option<i64>

Gets the Response max_channel_folder_description_length.

The maximum allowed length for a channel folder description, in Unicode code points.

Present if realm is present in fetch_event_types.

Clients should use this property rather than hardcoding field sizes.

Changes: New in Zulip 11.0 (feature level 410). Clients should use 1024 as a fallback value on previous feature levels.

pub fn set_max_channel_folder_description_length(&mut self, val: i64)

Sets the Response max_channel_folder_description_length.

The maximum allowed length for a channel folder description, in Unicode code points.

Present if realm is present in fetch_event_types.

Clients should use this property rather than hardcoding field sizes.

Changes: New in Zulip 11.0 (feature level 410). Clients should use 1024 as a fallback value on previous feature levels.

pub fn unset_max_channel_folder_description_length(&mut self) -> Option<i64>

Unsets the Response max_channel_folder_description_length.

The maximum allowed length for a channel folder description, in Unicode code points.

Present if realm is present in fetch_event_types.

Clients should use this property rather than hardcoding field sizes.

Changes: New in Zulip 11.0 (feature level 410). Clients should use 1024 as a fallback value on previous feature levels.

pub fn with_max_channel_folder_description_length(self, val: i64) -> Self

Builder function that sets the Response max_channel_folder_description_length.

The maximum allowed length for a channel folder description, in Unicode code points.

Present if realm is present in fetch_event_types.

Clients should use this property rather than hardcoding field sizes.

Changes: New in Zulip 11.0 (feature level 410). Clients should use 1024 as a fallback value on previous feature levels.

pub const fn max_topic_length(&self) -> Option<i64>

Gets the Response max_topic_length.

The maximum allowed length for a topic, in Unicode code points. Clients should use this property rather than hardcoding field sizes.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 53). Previously, this property always had a value of 60.

pub fn set_max_topic_length(&mut self, val: i64)

Sets the Response max_topic_length.

The maximum allowed length for a topic, in Unicode code points. Clients should use this property rather than hardcoding field sizes.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 53). Previously, this property always had a value of 60.

pub fn unset_max_topic_length(&mut self) -> Option<i64>

Unsets the Response max_topic_length.

The maximum allowed length for a topic, in Unicode code points. Clients should use this property rather than hardcoding field sizes.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 53). Previously, this property always had a value of 60.

pub fn with_max_topic_length(self, val: i64) -> Self

Builder function that sets the Response max_topic_length.

The maximum allowed length for a topic, in Unicode code points. Clients should use this property rather than hardcoding field sizes.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 53). Previously, this property always had a value of 60.

pub const fn max_message_length(&self) -> Option<i64>

Gets the Response max_message_length.

The maximum allowed length for a message, in Unicode code points. Clients should use this property rather than hardcoding field sizes.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 53). Previously, this property always had a value of 10000.

pub fn set_max_message_length(&mut self, val: i64)

Sets the Response max_message_length.

The maximum allowed length for a message, in Unicode code points. Clients should use this property rather than hardcoding field sizes.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 53). Previously, this property always had a value of 10000.

pub fn unset_max_message_length(&mut self) -> Option<i64>

Unsets the Response max_message_length.

The maximum allowed length for a message, in Unicode code points. Clients should use this property rather than hardcoding field sizes.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 53). Previously, this property always had a value of 10000.

pub fn with_max_message_length(self, val: i64) -> Self

Builder function that sets the Response max_message_length.

The maximum allowed length for a message, in Unicode code points. Clients should use this property rather than hardcoding field sizes.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 53). Previously, this property always had a value of 10000.

pub const fn server_min_deactivated_realm_deletion_days(&self) -> Option<i64>

Gets the Response server_min_deactivated_realm_deletion_days.

The minimum permitted number of days before full data deletion (users, channels, messages, etc.) of a deactivated organization.

Present if realm is present in fetch_event_types.

If null, then a deactivated organization’s data can be deleted immediately.

Changes: New in Zulip 10.0 (feature level 332)

pub fn set_server_min_deactivated_realm_deletion_days(&mut self, val: i64)

Sets the Response server_min_deactivated_realm_deletion_days.

The minimum permitted number of days before full data deletion (users, channels, messages, etc.) of a deactivated organization.

Present if realm is present in fetch_event_types.

If null, then a deactivated organization’s data can be deleted immediately.

Changes: New in Zulip 10.0 (feature level 332)

pub fn unset_server_min_deactivated_realm_deletion_days( &mut self, ) -> Option<i64>

Unsets the Response server_min_deactivated_realm_deletion_days.

The minimum permitted number of days before full data deletion (users, channels, messages, etc.) of a deactivated organization.

Present if realm is present in fetch_event_types.

If null, then a deactivated organization’s data can be deleted immediately.

Changes: New in Zulip 10.0 (feature level 332)

pub fn with_server_min_deactivated_realm_deletion_days(self, val: i64) -> Self

Builder function that sets the Response server_min_deactivated_realm_deletion_days.

The minimum permitted number of days before full data deletion (users, channels, messages, etc.) of a deactivated organization.

Present if realm is present in fetch_event_types.

If null, then a deactivated organization’s data can be deleted immediately.

Changes: New in Zulip 10.0 (feature level 332)

pub const fn server_max_deactivated_realm_deletion_days(&self) -> Option<i64>

Gets the Response server_max_deactivated_realm_deletion_days.

The maximum permitted number of days before full data deletion (users, channels, messages, etc.) of a deactivated organization.

Present if realm is present in fetch_event_types.

If null, then a deactivated organization’s data can be retained indefinitely.

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

pub fn set_server_max_deactivated_realm_deletion_days(&mut self, val: i64)

Sets the Response server_max_deactivated_realm_deletion_days.

The maximum permitted number of days before full data deletion (users, channels, messages, etc.) of a deactivated organization.

Present if realm is present in fetch_event_types.

If null, then a deactivated organization’s data can be retained indefinitely.

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

pub fn unset_server_max_deactivated_realm_deletion_days( &mut self, ) -> Option<i64>

Unsets the Response server_max_deactivated_realm_deletion_days.

The maximum permitted number of days before full data deletion (users, channels, messages, etc.) of a deactivated organization.

Present if realm is present in fetch_event_types.

If null, then a deactivated organization’s data can be retained indefinitely.

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

pub fn with_server_max_deactivated_realm_deletion_days(self, val: i64) -> Self

Builder function that sets the Response server_max_deactivated_realm_deletion_days.

The maximum permitted number of days before full data deletion (users, channels, messages, etc.) of a deactivated organization.

Present if realm is present in fetch_event_types.

If null, then a deactivated organization’s data can be retained indefinitely.

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

pub const fn server_presence_ping_interval_seconds(&self) -> Option<i64>

Gets the Response server_presence_ping_interval_seconds.

For clients implementing the presence system,

the time interval the client should use for sending presence requests to the server

(and thus receive presence updates from the server).

Present if realm is present in fetch_event_types.

It is important for presence implementations to use both this and server_presence_offline_threshold_seconds correctly,

so that a Zulip server can change these values to manage the trade-off between load and freshness of presence data.

Changes: New in Zulip 7.0 (feature level 164). Clients should use 60 for older Zulip servers,

since that’s the value that was hardcoded in the Zulip mobile apps prior to this parameter being introduced.

pub fn set_server_presence_ping_interval_seconds(&mut self, val: i64)

Sets the Response server_presence_ping_interval_seconds.

For clients implementing the presence system,

the time interval the client should use for sending presence requests to the server

(and thus receive presence updates from the server).

Present if realm is present in fetch_event_types.

It is important for presence implementations to use both this and server_presence_offline_threshold_seconds correctly,

so that a Zulip server can change these values to manage the trade-off between load and freshness of presence data.

Changes: New in Zulip 7.0 (feature level 164). Clients should use 60 for older Zulip servers,

since that’s the value that was hardcoded in the Zulip mobile apps prior to this parameter being introduced.

pub fn unset_server_presence_ping_interval_seconds(&mut self) -> Option<i64>

Unsets the Response server_presence_ping_interval_seconds.

For clients implementing the presence system,

the time interval the client should use for sending presence requests to the server

(and thus receive presence updates from the server).

Present if realm is present in fetch_event_types.

It is important for presence implementations to use both this and server_presence_offline_threshold_seconds correctly,

so that a Zulip server can change these values to manage the trade-off between load and freshness of presence data.

Changes: New in Zulip 7.0 (feature level 164). Clients should use 60 for older Zulip servers,

since that’s the value that was hardcoded in the Zulip mobile apps prior to this parameter being introduced.

pub fn with_server_presence_ping_interval_seconds(self, val: i64) -> Self

Builder function that sets the Response server_presence_ping_interval_seconds.

For clients implementing the presence system,

the time interval the client should use for sending presence requests to the server

(and thus receive presence updates from the server).

Present if realm is present in fetch_event_types.

It is important for presence implementations to use both this and server_presence_offline_threshold_seconds correctly,

so that a Zulip server can change these values to manage the trade-off between load and freshness of presence data.

Changes: New in Zulip 7.0 (feature level 164). Clients should use 60 for older Zulip servers,

since that’s the value that was hardcoded in the Zulip mobile apps prior to this parameter being introduced.

pub const fn server_presence_offline_threshold_seconds(&self) -> Option<i64>

Gets the Response server_presence_offline_threshold_seconds.

How old a presence timestamp for a given user can be before the user should be displayed as offline by clients displaying Zulip presence data.

Present if realm is present in fetch_event_types.

See the related server_presence_ping_interval_seconds for details.

Changes: New in Zulip 7.0 (feature level 164). Clients should use 140 for older Zulip servers,

since that’s the value that was hardcoded in the Zulip client apps prior to this parameter being introduced.

pub fn set_server_presence_offline_threshold_seconds(&mut self, val: i64)

Sets the Response server_presence_offline_threshold_seconds.

How old a presence timestamp for a given user can be before the user should be displayed as offline by clients displaying Zulip presence data.

Present if realm is present in fetch_event_types.

See the related server_presence_ping_interval_seconds for details.

Changes: New in Zulip 7.0 (feature level 164). Clients should use 140 for older Zulip servers,

since that’s the value that was hardcoded in the Zulip client apps prior to this parameter being introduced.

pub fn unset_server_presence_offline_threshold_seconds(&mut self) -> Option<i64>

Unsets the Response server_presence_offline_threshold_seconds.

How old a presence timestamp for a given user can be before the user should be displayed as offline by clients displaying Zulip presence data.

Present if realm is present in fetch_event_types.

See the related server_presence_ping_interval_seconds for details.

Changes: New in Zulip 7.0 (feature level 164). Clients should use 140 for older Zulip servers,

since that’s the value that was hardcoded in the Zulip client apps prior to this parameter being introduced.

pub fn with_server_presence_offline_threshold_seconds(self, val: i64) -> Self

Builder function that sets the Response server_presence_offline_threshold_seconds.

How old a presence timestamp for a given user can be before the user should be displayed as offline by clients displaying Zulip presence data.

Present if realm is present in fetch_event_types.

See the related server_presence_ping_interval_seconds for details.

Changes: New in Zulip 7.0 (feature level 164). Clients should use 140 for older Zulip servers,

since that’s the value that was hardcoded in the Zulip client apps prior to this parameter being introduced.

pub const fn server_typing_started_expiry_period_milliseconds( &self, ) -> Option<i64>

Gets the Response server_typing_started_expiry_period_milliseconds.

For clients implementing typing notifications protocol,

the time interval in milliseconds that the client should wait for additional typing start

events from the server before removing an active typing indicator.

Present if realm is present in fetch_event_types.

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

Clients should use 15000 for older Zulip servers, since that’s the value that was hardcoded in the Zulip apps prior to this parameter being introduced.

pub fn set_server_typing_started_expiry_period_milliseconds(&mut self, val: i64)

Sets the Response server_typing_started_expiry_period_milliseconds.

For clients implementing typing notifications protocol,

the time interval in milliseconds that the client should wait for additional typing start

events from the server before removing an active typing indicator.

Present if realm is present in fetch_event_types.

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

Clients should use 15000 for older Zulip servers, since that’s the value that was hardcoded in the Zulip apps prior to this parameter being introduced.

pub fn unset_server_typing_started_expiry_period_milliseconds( &mut self, ) -> Option<i64>

Unsets the Response server_typing_started_expiry_period_milliseconds.

For clients implementing typing notifications protocol,

the time interval in milliseconds that the client should wait for additional typing start

events from the server before removing an active typing indicator.

Present if realm is present in fetch_event_types.

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

Clients should use 15000 for older Zulip servers, since that’s the value that was hardcoded in the Zulip apps prior to this parameter being introduced.

pub fn with_server_typing_started_expiry_period_milliseconds( self, val: i64, ) -> Self

Builder function that sets the Response server_typing_started_expiry_period_milliseconds.

For clients implementing typing notifications protocol,

the time interval in milliseconds that the client should wait for additional typing start

events from the server before removing an active typing indicator.

Present if realm is present in fetch_event_types.

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

Clients should use 15000 for older Zulip servers, since that’s the value that was hardcoded in the Zulip apps prior to this parameter being introduced.

pub const fn server_typing_started_wait_period_milliseconds( &self, ) -> Option<i64>

Gets the Response server_typing_started_wait_period_milliseconds.

For clients implementing typing notifications protocol,

the time interval in milliseconds that the client should use to send regular start notifications

to the server to indicate that the user is still actively interacting with the compose UI.

Present if realm is present in fetch_event_types.

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

Clients should use 10000 for older Zulip servers,

since that’s the value that was hardcoded in the Zulip apps prior to this parameter being introduced.

pub fn set_server_typing_started_wait_period_milliseconds(&mut self, val: i64)

Sets the Response server_typing_started_wait_period_milliseconds.

For clients implementing typing notifications protocol,

the time interval in milliseconds that the client should use to send regular start notifications

to the server to indicate that the user is still actively interacting with the compose UI.

Present if realm is present in fetch_event_types.

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

Clients should use 10000 for older Zulip servers,

since that’s the value that was hardcoded in the Zulip apps prior to this parameter being introduced.

pub fn unset_server_typing_started_wait_period_milliseconds( &mut self, ) -> Option<i64>

Unsets the Response server_typing_started_wait_period_milliseconds.

For clients implementing typing notifications protocol,

the time interval in milliseconds that the client should use to send regular start notifications

to the server to indicate that the user is still actively interacting with the compose UI.

Present if realm is present in fetch_event_types.

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

Clients should use 10000 for older Zulip servers,

since that’s the value that was hardcoded in the Zulip apps prior to this parameter being introduced.

pub fn with_server_typing_started_wait_period_milliseconds( self, val: i64, ) -> Self

Builder function that sets the Response server_typing_started_wait_period_milliseconds.

For clients implementing typing notifications protocol,

the time interval in milliseconds that the client should use to send regular start notifications

to the server to indicate that the user is still actively interacting with the compose UI.

Present if realm is present in fetch_event_types.

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

Clients should use 10000 for older Zulip servers,

since that’s the value that was hardcoded in the Zulip apps prior to this parameter being introduced.

pub const fn presence_last_update_id(&self) -> Option<i64>

Gets the Response presence_last_update_id.

Provides the last_update_id value of the latest presence data fetched by the server and included in the response in presences.

Present if presence is present in fetch_event_types.

This can be used as the value of the presence_last_update_id parameter when polling for presence data at the

/users/me/presence endpoint to tell the server to only fetch the relevant newer data in order to skip redundant already-known presence information.

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

pub fn set_presence_last_update_id(&mut self, val: i64)

Sets the Response presence_last_update_id.

Provides the last_update_id value of the latest presence data fetched by the server and included in the response in presences.

Present if presence is present in fetch_event_types.

This can be used as the value of the presence_last_update_id parameter when polling for presence data at the

/users/me/presence endpoint to tell the server to only fetch the relevant newer data in order to skip redundant already-known presence information.

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

pub fn unset_presence_last_update_id(&mut self) -> Option<i64>

Unsets the Response presence_last_update_id.

Provides the last_update_id value of the latest presence data fetched by the server and included in the response in presences.

Present if presence is present in fetch_event_types.

This can be used as the value of the presence_last_update_id parameter when polling for presence data at the

/users/me/presence endpoint to tell the server to only fetch the relevant newer data in order to skip redundant already-known presence information.

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

pub fn with_presence_last_update_id(self, val: i64) -> Self

Builder function that sets the Response presence_last_update_id.

Provides the last_update_id value of the latest presence data fetched by the server and included in the response in presences.

Present if presence is present in fetch_event_types.

This can be used as the value of the presence_last_update_id parameter when polling for presence data at the

/users/me/presence endpoint to tell the server to only fetch the relevant newer data in order to skip redundant already-known presence information.

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

pub const fn server_timestamp(&self) -> Option<f64>

Gets the Response server_timestamp.

The time when the server fetched the presences data included in the response. Matches the similar field in presence responses.

Present if presence is present in fetch_event_types.

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

pub fn set_server_timestamp(&mut self, val: f64)

Sets the Response server_timestamp.

The time when the server fetched the presences data included in the response. Matches the similar field in presence responses.

Present if presence is present in fetch_event_types.

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

pub fn unset_server_timestamp(&mut self) -> Option<f64>

Unsets the Response server_timestamp.

The time when the server fetched the presences data included in the response. Matches the similar field in presence responses.

Present if presence is present in fetch_event_types.

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

pub fn with_server_timestamp(self, val: f64) -> Self

Builder function that sets the Response server_timestamp.

The time when the server fetched the presences data included in the response. Matches the similar field in presence responses.

Present if presence is present in fetch_event_types.

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

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

Gets the Response has_zoom_token.

A boolean which signifies whether the user has a Zoom token and has thus completed OAuth flow for the Zoom integration.

Present if video_calls is present in fetch_event_types.

Clients need to know whether initiating Zoom OAuth is required before creating a Zoom call.

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

Sets the Response has_zoom_token.

A boolean which signifies whether the user has a Zoom token and has thus completed OAuth flow for the Zoom integration.

Present if video_calls is present in fetch_event_types.

Clients need to know whether initiating Zoom OAuth is required before creating a Zoom call.

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

Unsets the Response has_zoom_token.

A boolean which signifies whether the user has a Zoom token and has thus completed OAuth flow for the Zoom integration.

Present if video_calls is present in fetch_event_types.

Clients need to know whether initiating Zoom OAuth is required before creating a Zoom call.

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

Builder function that sets the Response has_zoom_token.

A boolean which signifies whether the user has a Zoom token and has thus completed OAuth flow for the Zoom integration.

Present if video_calls is present in fetch_event_types.

Clients need to know whether initiating Zoom OAuth is required before creating a Zoom call.

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

Gets the Response enable_desktop_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response enable_desktop_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response enable_desktop_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response enable_desktop_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response enable_digest_emails.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response enable_digest_emails.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response enable_digest_emails.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response enable_digest_emails.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response enable_login_emails.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response enable_login_emails.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response enable_login_emails.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response enable_login_emails.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response enable_marketing_emails.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response enable_marketing_emails.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response enable_marketing_emails.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response enable_marketing_emails.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response email_notifications_batching_period_seconds.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response email_notifications_batching_period_seconds.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response email_notifications_batching_period_seconds.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response email_notifications_batching_period_seconds.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response enable_offline_email_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response enable_offline_email_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response enable_offline_email_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response enable_offline_email_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object in their

client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response enable_offline_push_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response enable_offline_push_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response enable_offline_push_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response enable_offline_push_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response enable_sounds.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response enable_sounds.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response enable_sounds.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response enable_sounds.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response enable_stream_desktop_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response enable_stream_desktop_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response enable_stream_desktop_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response enable_stream_desktop_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response enable_stream_email_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response enable_stream_email_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response enable_stream_email_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response enable_stream_email_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response enable_stream_push_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response enable_stream_push_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response enable_stream_push_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response enable_stream_push_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response enable_stream_audible_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response enable_stream_audible_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response enable_stream_audible_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response enable_stream_audible_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response wildcard_mentions_notify.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response wildcard_mentions_notify.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response wildcard_mentions_notify.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response wildcard_mentions_notify.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response message_content_in_email_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response message_content_in_email_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response message_content_in_email_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response message_content_in_email_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response pm_content_in_desktop_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response pm_content_in_desktop_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response pm_content_in_desktop_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response pm_content_in_desktop_notifications.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response desktop_icon_count_display.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response desktop_icon_count_display.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response desktop_icon_count_display.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response desktop_icon_count_display.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response realm_name_in_email_notifications_policy.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: In Zulip 7.0 (feature level 168), replaced previous realm_name_in_notifications global notifications setting with realm_name_in_email_notifications_policy.

Deprecated since Zulip 5.0 (feature level 89); both realm_name_in_notifications and the newer realm_name_in_email_notifications_policy are deprecated.

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response realm_name_in_email_notifications_policy.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: In Zulip 7.0 (feature level 168), replaced previous realm_name_in_notifications global notifications setting with realm_name_in_email_notifications_policy.

Deprecated since Zulip 5.0 (feature level 89); both realm_name_in_notifications and the newer realm_name_in_email_notifications_policy are deprecated.

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response realm_name_in_email_notifications_policy.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: In Zulip 7.0 (feature level 168), replaced previous realm_name_in_notifications global notifications setting with realm_name_in_email_notifications_policy.

Deprecated since Zulip 5.0 (feature level 89); both realm_name_in_notifications and the newer realm_name_in_email_notifications_policy are deprecated.

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response realm_name_in_email_notifications_policy.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: In Zulip 7.0 (feature level 168), replaced previous realm_name_in_notifications global notifications setting with realm_name_in_email_notifications_policy.

Deprecated since Zulip 5.0 (feature level 89); both realm_name_in_notifications and the newer realm_name_in_email_notifications_policy are deprecated.

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response presence_enabled.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response presence_enabled.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response presence_enabled.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response presence_enabled.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response color_scheme.

The color scheme selected by the user.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response color_scheme.

The color scheme selected by the user.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response color_scheme.

The color scheme selected by the user.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response color_scheme.

The color scheme selected by the user.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response demote_inactive_streams.

Whether the user has chosen to hide inactive channels.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response demote_inactive_streams.

Whether the user has chosen to hide inactive channels.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response demote_inactive_streams.

Whether the user has chosen to hide inactive channels.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response demote_inactive_streams.

Whether the user has chosen to hide inactive channels.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response enable_drafts_synchronization.

Whether drafts synchronization is enabled for the user.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

If disabled, clients will receive an error when trying to use the drafts endpoints.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

New in Zulip 5.0 (feature level 87).

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

Sets the Response enable_drafts_synchronization.

Whether drafts synchronization is enabled for the user.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

If disabled, clients will receive an error when trying to use the drafts endpoints.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

New in Zulip 5.0 (feature level 87).

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

Unsets the Response enable_drafts_synchronization.

Whether drafts synchronization is enabled for the user.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

If disabled, clients will receive an error when trying to use the drafts endpoints.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

New in Zulip 5.0 (feature level 87).

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

Builder function that sets the Response enable_drafts_synchronization.

Whether drafts synchronization is enabled for the user.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

If disabled, clients will receive an error when trying to use the drafts endpoints.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

New in Zulip 5.0 (feature level 87).

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

Gets the Response fluid_layout_width.

Whether the user has chosen for the layout width to be fluid.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response fluid_layout_width.

Whether the user has chosen for the layout width to be fluid.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response fluid_layout_width.

Whether the user has chosen for the layout width to be fluid.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response fluid_layout_width.

Whether the user has chosen for the layout width to be fluid.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response high_contrast_mode.

Whether has switched on high contrast mode.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response high_contrast_mode.

Whether has switched on high contrast mode.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response high_contrast_mode.

Whether has switched on high contrast mode.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response high_contrast_mode.

Whether has switched on high contrast mode.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response left_side_userlist.

Whether the user has chosen for the userlist to be displayed on the left side of the screen (for desktop app and web app) in narrow windows.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response left_side_userlist.

Whether the user has chosen for the userlist to be displayed on the left side of the screen (for desktop app and web app) in narrow windows.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response left_side_userlist.

Whether the user has chosen for the userlist to be displayed on the left side of the screen (for desktop app and web app) in narrow windows.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response left_side_userlist.

Whether the user has chosen for the userlist to be displayed on the left side of the screen (for desktop app and web app) in narrow windows.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response starred_message_counts.

Whether the user has chosen the number of starred messages to be displayed similar to unread counts.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response starred_message_counts.

Whether the user has chosen the number of starred messages to be displayed similar to unread counts.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response starred_message_counts.

Whether the user has chosen the number of starred messages to be displayed similar to unread counts.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response starred_message_counts.

Whether the user has chosen the number of starred messages to be displayed similar to unread counts.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response translate_emoticons.

Whether the user has chosen for emoticons to be translated into emoji in the Zulip compose box.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response translate_emoticons.

Whether the user has chosen for emoticons to be translated into emoji in the Zulip compose box.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response translate_emoticons.

Whether the user has chosen for emoticons to be translated into emoji in the Zulip compose box.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response translate_emoticons.

Whether the user has chosen for emoticons to be translated into emoji in the Zulip compose box.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response twenty_four_hour_time.

Whether the user has chosen a twenty four hour time display (true) or a twelve hour one (false).

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response twenty_four_hour_time.

Whether the user has chosen a twenty four hour time display (true) or a twelve hour one (false).

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response twenty_four_hour_time.

Whether the user has chosen a twenty four hour time display (true) or a twelve hour one (false).

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response twenty_four_hour_time.

Whether the user has chosen a twenty four hour time display (true) or a twelve hour one (false).

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response 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.

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

Sets the Response 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.

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

Unsets the Response 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.

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

Builder function that sets the Response 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.

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

Gets the Response enter_sends.

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

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and process the user_settings event type instead.

Prior to Zulip 5.0 (feature level 84), this field was present in response if realm_user was present in fetch_event_types, not update_display_settings.

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

Sets the Response enter_sends.

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

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and process the user_settings event type instead.

Prior to Zulip 5.0 (feature level 84), this field was present in response if realm_user was present in fetch_event_types, not update_display_settings.

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

Unsets the Response enter_sends.

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

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and process the user_settings event type instead.

Prior to Zulip 5.0 (feature level 84), this field was present in response if realm_user was present in fetch_event_types, not update_display_settings.

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

Builder function that sets the Response enter_sends.

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

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and process the user_settings event type instead.

Prior to Zulip 5.0 (feature level 84), this field was present in response if realm_user was present in fetch_event_types, not update_display_settings.

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

Gets the Response realm_allow_edit_history.

Whether this organization is configured to allow users to access message edit history.

Present if realm is present in fetch_event_types.

The value of realm_allow_edit_history is set as false if the realm_message_edit_history_visibility_policy

is configured as "None" and true if it is configured as "Moves only" or "All".

Changes: Deprecated in Zulip 10.0 (feature level 358) and will be removed in the future,

as it is an inaccurate version realm_message_edit_history_visibility_policy, which replaces this field.

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

Sets the Response realm_allow_edit_history.

Whether this organization is configured to allow users to access message edit history.

Present if realm is present in fetch_event_types.

The value of realm_allow_edit_history is set as false if the realm_message_edit_history_visibility_policy

is configured as "None" and true if it is configured as "Moves only" or "All".

Changes: Deprecated in Zulip 10.0 (feature level 358) and will be removed in the future,

as it is an inaccurate version realm_message_edit_history_visibility_policy, which replaces this field.

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

Unsets the Response realm_allow_edit_history.

Whether this organization is configured to allow users to access message edit history.

Present if realm is present in fetch_event_types.

The value of realm_allow_edit_history is set as false if the realm_message_edit_history_visibility_policy

is configured as "None" and true if it is configured as "Moves only" or "All".

Changes: Deprecated in Zulip 10.0 (feature level 358) and will be removed in the future,

as it is an inaccurate version realm_message_edit_history_visibility_policy, which replaces this field.

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

Builder function that sets the Response realm_allow_edit_history.

Whether this organization is configured to allow users to access message edit history.

Present if realm is present in fetch_event_types.

The value of realm_allow_edit_history is set as false if the realm_message_edit_history_visibility_policy

is configured as "None" and true if it is configured as "Moves only" or "All".

Changes: Deprecated in Zulip 10.0 (feature level 358) and will be removed in the future,

as it is an inaccurate version realm_message_edit_history_visibility_policy, which replaces this field.

pub const fn realm_create_public_stream_policy( &self, ) -> Option<RealmCreatePublicStreamPolicy>

Gets the Response realm_create_public_stream_policy.

A deprecated representation of a superset of the users who have permission to create public channels in the organization, available for backwards-compatibility.

Present if realm is present in fetch_event_types.

pub fn set_realm_create_public_stream_policy( &mut self, val: RealmCreatePublicStreamPolicy, )

Sets the Response realm_create_public_stream_policy.

A deprecated representation of a superset of the users who have permission to create public channels in the organization, available for backwards-compatibility.

Present if realm is present in fetch_event_types.

pub fn unset_realm_create_public_stream_policy( &mut self, ) -> Option<RealmCreatePublicStreamPolicy>

Unsets the Response realm_create_public_stream_policy.

A deprecated representation of a superset of the users who have permission to create public channels in the organization, available for backwards-compatibility.

Present if realm is present in fetch_event_types.

pub fn with_realm_create_public_stream_policy( self, val: RealmCreatePublicStreamPolicy, ) -> Self

Builder function that sets the Response realm_create_public_stream_policy.

A deprecated representation of a superset of the users who have permission to create public channels in the organization, available for backwards-compatibility.

Present if realm is present in fetch_event_types.

pub const fn realm_create_private_stream_policy( &self, ) -> Option<RealmCreatePrivateStreamPolicy>

Gets the Response realm_create_private_stream_policy.

A deprecated representation of a superset of the users who have permission to create private channels in the organization, available for backwards-compatibility.

Present if realm is present in fetch_event_types.

Clients should use can_create_private_channel_group instead.

pub fn set_realm_create_private_stream_policy( &mut self, val: RealmCreatePrivateStreamPolicy, )

Sets the Response realm_create_private_stream_policy.

A deprecated representation of a superset of the users who have permission to create private channels in the organization, available for backwards-compatibility.

Present if realm is present in fetch_event_types.

Clients should use can_create_private_channel_group instead.

pub fn unset_realm_create_private_stream_policy( &mut self, ) -> Option<RealmCreatePrivateStreamPolicy>

Unsets the Response realm_create_private_stream_policy.

A deprecated representation of a superset of the users who have permission to create private channels in the organization, available for backwards-compatibility.

Present if realm is present in fetch_event_types.

Clients should use can_create_private_channel_group instead.

pub fn with_realm_create_private_stream_policy( self, val: RealmCreatePrivateStreamPolicy, ) -> Self

Builder function that sets the Response realm_create_private_stream_policy.

A deprecated representation of a superset of the users who have permission to create private channels in the organization, available for backwards-compatibility.

Present if realm is present in fetch_event_types.

Clients should use can_create_private_channel_group instead.

pub const fn realm_create_web_public_stream_policy( &self, ) -> Option<RealmCreateWebPublicStreamPolicy>

Gets the Response realm_create_web_public_stream_policy.

A deprecated representation of a superset of the users who have permission to create web-public channels in the organization, available for backwards-compatibility.

Present if realm is present in fetch_event_types.

Clients should use can_create_web_public_channel_group instead.

pub fn set_realm_create_web_public_stream_policy( &mut self, val: RealmCreateWebPublicStreamPolicy, )

Sets the Response realm_create_web_public_stream_policy.

A deprecated representation of a superset of the users who have permission to create web-public channels in the organization, available for backwards-compatibility.

Present if realm is present in fetch_event_types.

Clients should use can_create_web_public_channel_group instead.

pub fn unset_realm_create_web_public_stream_policy( &mut self, ) -> Option<RealmCreateWebPublicStreamPolicy>

Unsets the Response realm_create_web_public_stream_policy.

A deprecated representation of a superset of the users who have permission to create web-public channels in the organization, available for backwards-compatibility.

Present if realm is present in fetch_event_types.

Clients should use can_create_web_public_channel_group instead.

pub fn with_realm_create_web_public_stream_policy( self, val: RealmCreateWebPublicStreamPolicy, ) -> Self

Builder function that sets the Response realm_create_web_public_stream_policy.

A deprecated representation of a superset of the users who have permission to create web-public channels in the organization, available for backwards-compatibility.

Present if realm is present in fetch_event_types.

Clients should use can_create_web_public_channel_group instead.

pub const fn realm_wildcard_mention_policy( &self, ) -> Option<RealmWildcardMentionPolicy>

Gets the Response realm_wildcard_mention_policy.

A deprecated representation of a superset of the users who have permission to use wildcard mentions in large channels, available for backwards-compatibility.

Present if realm is present in fetch_event_types.

Clients should use can_create_web_public_channel_group instead.

pub fn set_realm_wildcard_mention_policy( &mut self, val: RealmWildcardMentionPolicy, )

Sets the Response realm_wildcard_mention_policy.

A deprecated representation of a superset of the users who have permission to use wildcard mentions in large channels, available for backwards-compatibility.

Present if realm is present in fetch_event_types.

Clients should use can_create_web_public_channel_group instead.

pub fn unset_realm_wildcard_mention_policy( &mut self, ) -> Option<RealmWildcardMentionPolicy>

Unsets the Response realm_wildcard_mention_policy.

A deprecated representation of a superset of the users who have permission to use wildcard mentions in large channels, available for backwards-compatibility.

Present if realm is present in fetch_event_types.

Clients should use can_create_web_public_channel_group instead.

pub fn with_realm_wildcard_mention_policy( self, val: RealmWildcardMentionPolicy, ) -> Self

Builder function that sets the Response realm_wildcard_mention_policy.

A deprecated representation of a superset of the users who have permission to use wildcard mentions in large channels, available for backwards-compatibility.

Present if realm is present in fetch_event_types.

Clients should use can_create_web_public_channel_group instead.

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

Gets the Response realm_digest_emails_enabled.

Present if realm is present in fetch_event_types.

Whether the organization has enabled weekly digest emails.

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

Sets the Response realm_digest_emails_enabled.

Present if realm is present in fetch_event_types.

Whether the organization has enabled weekly digest emails.

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

Unsets the Response realm_digest_emails_enabled.

Present if realm is present in fetch_event_types.

Whether the organization has enabled weekly digest emails.

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

Builder function that sets the Response realm_digest_emails_enabled.

Present if realm is present in fetch_event_types.

Whether the organization has enabled weekly digest emails.

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

Gets the Response realm_disallow_disposable_email_addresses.

Present if realm is present in fetch_event_types.

Whether the organization disallows disposable email addresses.

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

Sets the Response realm_disallow_disposable_email_addresses.

Present if realm is present in fetch_event_types.

Whether the organization disallows disposable email addresses.

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

Unsets the Response realm_disallow_disposable_email_addresses.

Present if realm is present in fetch_event_types.

Whether the organization disallows disposable email addresses.

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

Builder function that sets the Response realm_disallow_disposable_email_addresses.

Present if realm is present in fetch_event_types.

Whether the organization disallows disposable email addresses.

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

Gets the Response realm_email_changes_disabled.

Present if realm is present in fetch_event_types.

Whether users are allowed to change their own email address in this organization.

This is typically disabled for organizations that synchronize accounts from LDAP or a similar corporate database.

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

Sets the Response realm_email_changes_disabled.

Present if realm is present in fetch_event_types.

Whether users are allowed to change their own email address in this organization.

This is typically disabled for organizations that synchronize accounts from LDAP or a similar corporate database.

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

Unsets the Response realm_email_changes_disabled.

Present if realm is present in fetch_event_types.

Whether users are allowed to change their own email address in this organization.

This is typically disabled for organizations that synchronize accounts from LDAP or a similar corporate database.

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

Builder function that sets the Response realm_email_changes_disabled.

Present if realm is present in fetch_event_types.

Whether users are allowed to change their own email address in this organization.

This is typically disabled for organizations that synchronize accounts from LDAP or a similar corporate database.

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

Gets the Response realm_invite_required.

Present if realm is present in fetch_event_types.

Whether an invitation is required to join this organization.

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

Sets the Response realm_invite_required.

Present if realm is present in fetch_event_types.

Whether an invitation is required to join this organization.

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

Unsets the Response realm_invite_required.

Present if realm is present in fetch_event_types.

Whether an invitation is required to join this organization.

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

Builder function that sets the Response realm_invite_required.

Present if realm is present in fetch_event_types.

Whether an invitation is required to join this organization.

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

Gets the Response realm_inline_image_preview.

Present if realm is present in fetch_event_types.

Whether this organization has been configured to enable previews of linked images.

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

Sets the Response realm_inline_image_preview.

Present if realm is present in fetch_event_types.

Whether this organization has been configured to enable previews of linked images.

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

Unsets the Response realm_inline_image_preview.

Present if realm is present in fetch_event_types.

Whether this organization has been configured to enable previews of linked images.

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

Builder function that sets the Response realm_inline_image_preview.

Present if realm is present in fetch_event_types.

Whether this organization has been configured to enable previews of linked images.

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

Gets the Response realm_inline_url_embed_preview.

Whether this organization has been configured to enable previews of linked websites.

Present if realm is present in fetch_event_types.

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

Sets the Response realm_inline_url_embed_preview.

Whether this organization has been configured to enable previews of linked websites.

Present if realm is present in fetch_event_types.

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

Unsets the Response realm_inline_url_embed_preview.

Whether this organization has been configured to enable previews of linked websites.

Present if realm is present in fetch_event_types.

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

Builder function that sets the Response realm_inline_url_embed_preview.

Whether this organization has been configured to enable previews of linked websites.

Present if realm is present in fetch_event_types.

pub const fn realm_topics_policy(&self) -> Option<TopicsPolicy>

Gets the Response realm_topics_policy.

Present if realm is present in fetch_event_types.

pub fn set_realm_topics_policy(&mut self, val: TopicsPolicy)

Sets the Response realm_topics_policy.

Present if realm is present in fetch_event_types.

pub fn unset_realm_topics_policy(&mut self) -> Option<TopicsPolicy>

Unsets the Response realm_topics_policy.

Present if realm is present in fetch_event_types.

pub fn with_realm_topics_policy(self, val: TopicsPolicy) -> Self

Builder function that sets the Response realm_topics_policy.

Present if realm is present in fetch_event_types.

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

Gets the Response realm_mandatory_topics.

Whether topics are required for messages in this organization.

Present if realm is present in fetch_event_types.

Changes: Deprecated in Zulip 11.0 (feature level 392). This is now controlled by the realm topics_policy setting.

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

Sets the Response realm_mandatory_topics.

Whether topics are required for messages in this organization.

Present if realm is present in fetch_event_types.

Changes: Deprecated in Zulip 11.0 (feature level 392). This is now controlled by the realm topics_policy setting.

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

Unsets the Response realm_mandatory_topics.

Whether topics are required for messages in this organization.

Present if realm is present in fetch_event_types.

Changes: Deprecated in Zulip 11.0 (feature level 392). This is now controlled by the realm topics_policy setting.

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

Builder function that sets the Response realm_mandatory_topics.

Whether topics are required for messages in this organization.

Present if realm is present in fetch_event_types.

Changes: Deprecated in Zulip 11.0 (feature level 392). This is now controlled by the realm topics_policy setting.

pub const fn realm_message_retention_days(&self) -> Option<i64>

Gets the Response realm_message_retention_days.

The default message retention policy for this organization.

Present if realm is present in fetch_event_types.

It can have one special value:

• -1 denoting that the messages will be retained forever for this realm, by default.

Changes: Prior to Zulip 3.0 (feature level 22),

no limit was encoded as null instead of -1.

Clients can correctly handle all server versions by treating both -1 and null as indicating unlimited message retention.

pub fn set_realm_message_retention_days(&mut self, val: i64)

Sets the Response realm_message_retention_days.

The default message retention policy for this organization.

Present if realm is present in fetch_event_types.

It can have one special value:

• -1 denoting that the messages will be retained forever for this realm, by default.

Changes: Prior to Zulip 3.0 (feature level 22),

no limit was encoded as null instead of -1.

Clients can correctly handle all server versions by treating both -1 and null as indicating unlimited message retention.

pub fn unset_realm_message_retention_days(&mut self) -> Option<i64>

Unsets the Response realm_message_retention_days.

The default message retention policy for this organization.

Present if realm is present in fetch_event_types.

It can have one special value:

• -1 denoting that the messages will be retained forever for this realm, by default.

Changes: Prior to Zulip 3.0 (feature level 22),

no limit was encoded as null instead of -1.

Clients can correctly handle all server versions by treating both -1 and null as indicating unlimited message retention.

pub fn with_realm_message_retention_days(self, val: i64) -> Self

Builder function that sets the Response realm_message_retention_days.

The default message retention policy for this organization.

Present if realm is present in fetch_event_types.

It can have one special value:

• -1 denoting that the messages will be retained forever for this realm, by default.

Changes: Prior to Zulip 3.0 (feature level 22),

no limit was encoded as null instead of -1.

Clients can correctly handle all server versions by treating both -1 and null as indicating unlimited message retention.

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

Gets the Response realm_require_e2ee_push_notifications.

Whether this realm is configured to disallow sending mobile push notifications with message content through the legacy mobile push notifications APIs.

Present if realm is present in fetch_event_types.

The new API uses end-to-end encryption to protect message content and metadata from being accessible to the push bouncer service, APNs, and FCM.

Clients that support the new E2EE API will use it automatically regardless of this setting.

If true, mobile push notifications sent to clients that lack support for E2EE push notifications will always have "New message" as their content.

Note that these legacy mobile notifications will still contain metadata, which may include the message’s ID, the sender’s name, email address, and avatar.

In a future release, once the official mobile apps have implemented fully validated their E2EE protocol support,

this setting will become strict, and disable the legacy protocol entirely.

Changes: New in Zulip 11.0 (feature level 409). Previously, this behavior was available only via the PUSH_NOTIFICATION_REDACT_CONTENT global server setting.

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

Sets the Response realm_require_e2ee_push_notifications.

Whether this realm is configured to disallow sending mobile push notifications with message content through the legacy mobile push notifications APIs.

Present if realm is present in fetch_event_types.

The new API uses end-to-end encryption to protect message content and metadata from being accessible to the push bouncer service, APNs, and FCM.

Clients that support the new E2EE API will use it automatically regardless of this setting.

If true, mobile push notifications sent to clients that lack support for E2EE push notifications will always have "New message" as their content.

Note that these legacy mobile notifications will still contain metadata, which may include the message’s ID, the sender’s name, email address, and avatar.

In a future release, once the official mobile apps have implemented fully validated their E2EE protocol support,

this setting will become strict, and disable the legacy protocol entirely.

Changes: New in Zulip 11.0 (feature level 409). Previously, this behavior was available only via the PUSH_NOTIFICATION_REDACT_CONTENT global server setting.

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

Unsets the Response realm_require_e2ee_push_notifications.

Whether this realm is configured to disallow sending mobile push notifications with message content through the legacy mobile push notifications APIs.

Present if realm is present in fetch_event_types.

The new API uses end-to-end encryption to protect message content and metadata from being accessible to the push bouncer service, APNs, and FCM.

Clients that support the new E2EE API will use it automatically regardless of this setting.

If true, mobile push notifications sent to clients that lack support for E2EE push notifications will always have "New message" as their content.

Note that these legacy mobile notifications will still contain metadata, which may include the message’s ID, the sender’s name, email address, and avatar.

In a future release, once the official mobile apps have implemented fully validated their E2EE protocol support,

this setting will become strict, and disable the legacy protocol entirely.

Changes: New in Zulip 11.0 (feature level 409). Previously, this behavior was available only via the PUSH_NOTIFICATION_REDACT_CONTENT global server setting.

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

Builder function that sets the Response realm_require_e2ee_push_notifications.

Whether this realm is configured to disallow sending mobile push notifications with message content through the legacy mobile push notifications APIs.

Present if realm is present in fetch_event_types.

The new API uses end-to-end encryption to protect message content and metadata from being accessible to the push bouncer service, APNs, and FCM.

Clients that support the new E2EE API will use it automatically regardless of this setting.

If true, mobile push notifications sent to clients that lack support for E2EE push notifications will always have "New message" as their content.

Note that these legacy mobile notifications will still contain metadata, which may include the message’s ID, the sender’s name, email address, and avatar.

In a future release, once the official mobile apps have implemented fully validated their E2EE protocol support,

this setting will become strict, and disable the legacy protocol entirely.

Changes: New in Zulip 11.0 (feature level 409). Previously, this behavior was available only via the PUSH_NOTIFICATION_REDACT_CONTENT global server setting.

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

Gets the Response realm_require_unique_names.

Indicates whether the organization is configured to require users to have unique full names.

Present if realm is present in fetch_event_types.

If true, the server will reject attempts to create a new user, or change the name of an existing user,

where doing so would lead to two users whose names are identical modulo case and unicode normalization.

Changes: New in Zulip 9.0 (feature level 246). Previously, the Zulip server could not be configured to enforce unique names.

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

Sets the Response realm_require_unique_names.

Indicates whether the organization is configured to require users to have unique full names.

Present if realm is present in fetch_event_types.

If true, the server will reject attempts to create a new user, or change the name of an existing user,

where doing so would lead to two users whose names are identical modulo case and unicode normalization.

Changes: New in Zulip 9.0 (feature level 246). Previously, the Zulip server could not be configured to enforce unique names.

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

Unsets the Response realm_require_unique_names.

Indicates whether the organization is configured to require users to have unique full names.

Present if realm is present in fetch_event_types.

If true, the server will reject attempts to create a new user, or change the name of an existing user,

where doing so would lead to two users whose names are identical modulo case and unicode normalization.

Changes: New in Zulip 9.0 (feature level 246). Previously, the Zulip server could not be configured to enforce unique names.

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

Builder function that sets the Response realm_require_unique_names.

Indicates whether the organization is configured to require users to have unique full names.

Present if realm is present in fetch_event_types.

If true, the server will reject attempts to create a new user, or change the name of an existing user,

where doing so would lead to two users whose names are identical modulo case and unicode normalization.

Changes: New in Zulip 9.0 (feature level 246). Previously, the Zulip server could not be configured to enforce unique names.

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

Gets the Response realm_name_changes_disabled.

Indicates whether users are allowed to change their name via the Zulip UI in this organization.

Present if realm is present in fetch_event_types.

Typically disabled in organizations syncing this type of account information from an external user database like LDAP.

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

Sets the Response realm_name_changes_disabled.

Indicates whether users are allowed to change their name via the Zulip UI in this organization.

Present if realm is present in fetch_event_types.

Typically disabled in organizations syncing this type of account information from an external user database like LDAP.

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

Unsets the Response realm_name_changes_disabled.

Indicates whether users are allowed to change their name via the Zulip UI in this organization.

Present if realm is present in fetch_event_types.

Typically disabled in organizations syncing this type of account information from an external user database like LDAP.

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

Builder function that sets the Response realm_name_changes_disabled.

Indicates whether users are allowed to change their name via the Zulip UI in this organization.

Present if realm is present in fetch_event_types.

Typically disabled in organizations syncing this type of account information from an external user database like LDAP.

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

Gets the Response realm_avatar_changes_disabled.

Indicates whether users are allowed to change their avatar via the Zulip UI in this organization.

Present if realm is present in fetch_event_types.

Typically disabled in organizations syncing this type of account information from an external user database like LDAP.

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

Sets the Response realm_avatar_changes_disabled.

Indicates whether users are allowed to change their avatar via the Zulip UI in this organization.

Present if realm is present in fetch_event_types.

Typically disabled in organizations syncing this type of account information from an external user database like LDAP.

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

Unsets the Response realm_avatar_changes_disabled.

Indicates whether users are allowed to change their avatar via the Zulip UI in this organization.

Present if realm is present in fetch_event_types.

Typically disabled in organizations syncing this type of account information from an external user database like LDAP.

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

Builder function that sets the Response realm_avatar_changes_disabled.

Indicates whether users are allowed to change their avatar via the Zulip UI in this organization.

Present if realm is present in fetch_event_types.

Typically disabled in organizations syncing this type of account information from an external user database like LDAP.

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

Gets the Response realm_emails_restricted_to_domains.

Whether new users joining this organization are required to have an email address in one of the realm_domains configured for the organization.

Present if realm is present in fetch_event_types.

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

Sets the Response realm_emails_restricted_to_domains.

Whether new users joining this organization are required to have an email address in one of the realm_domains configured for the organization.

Present if realm is present in fetch_event_types.

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

Unsets the Response realm_emails_restricted_to_domains.

Whether new users joining this organization are required to have an email address in one of the realm_domains configured for the organization.

Present if realm is present in fetch_event_types.

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

Builder function that sets the Response realm_emails_restricted_to_domains.

Whether new users joining this organization are required to have an email address in one of the realm_domains configured for the organization.

Present if realm is present in fetch_event_types.

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

Gets the Response realm_send_welcome_emails.

Whether or not this organization is configured to send the standard Zulip welcome emails to new users joining the organization.

Present if realm is present in fetch_event_types.

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

Sets the Response realm_send_welcome_emails.

Whether or not this organization is configured to send the standard Zulip welcome emails to new users joining the organization.

Present if realm is present in fetch_event_types.

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

Unsets the Response realm_send_welcome_emails.

Whether or not this organization is configured to send the standard Zulip welcome emails to new users joining the organization.

Present if realm is present in fetch_event_types.

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

Builder function that sets the Response realm_send_welcome_emails.

Whether or not this organization is configured to send the standard Zulip welcome emails to new users joining the organization.

Present if realm is present in fetch_event_types.

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

Gets the Response realm_message_content_allowed_in_email_notifications.

Whether notification emails in this organization are allowed to contain Zulip the message content, or simply indicate that a new message was sent.

Present if realm is present in fetch_event_types.

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

Sets the Response realm_message_content_allowed_in_email_notifications.

Whether notification emails in this organization are allowed to contain Zulip the message content, or simply indicate that a new message was sent.

Present if realm is present in fetch_event_types.

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

Unsets the Response realm_message_content_allowed_in_email_notifications.

Whether notification emails in this organization are allowed to contain Zulip the message content, or simply indicate that a new message was sent.

Present if realm is present in fetch_event_types.

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

Builder function that sets the Response realm_message_content_allowed_in_email_notifications.

Whether notification emails in this organization are allowed to contain Zulip the message content, or simply indicate that a new message was sent.

Present if realm is present in fetch_event_types.

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

Gets the Response realm_enable_spectator_access.

Whether web-public channels and related anonymous access APIs/features are enabled in this organization.

Present if realm is present in fetch_event_types.

Can only be enabled if the WEB_PUBLIC_STREAMS_ENABLED server setting is enabled on the Zulip server.

See also the can_create_web_public_channel_group realm setting.

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

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

Sets the Response realm_enable_spectator_access.

Whether web-public channels and related anonymous access APIs/features are enabled in this organization.

Present if realm is present in fetch_event_types.

Can only be enabled if the WEB_PUBLIC_STREAMS_ENABLED server setting is enabled on the Zulip server.

See also the can_create_web_public_channel_group realm setting.

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

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

Unsets the Response realm_enable_spectator_access.

Whether web-public channels and related anonymous access APIs/features are enabled in this organization.

Present if realm is present in fetch_event_types.

Can only be enabled if the WEB_PUBLIC_STREAMS_ENABLED server setting is enabled on the Zulip server.

See also the can_create_web_public_channel_group realm setting.

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

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

Builder function that sets the Response realm_enable_spectator_access.

Whether web-public channels and related anonymous access APIs/features are enabled in this organization.

Present if realm is present in fetch_event_types.

Can only be enabled if the WEB_PUBLIC_STREAMS_ENABLED server setting is enabled on the Zulip server.

See also the can_create_web_public_channel_group realm setting.

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

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

Gets the Response realm_want_advertise_in_communities_directory.

Whether the organization has given permission to be advertised in the Zulip communities directory.

Present if realm is present in fetch_event_types.

Useful only to clients supporting changing this setting for the organization.

Giving permission via this setting does not guarantee that an organization will be listed in the Zulip communities directory.

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

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

Sets the Response realm_want_advertise_in_communities_directory.

Whether the organization has given permission to be advertised in the Zulip communities directory.

Present if realm is present in fetch_event_types.

Useful only to clients supporting changing this setting for the organization.

Giving permission via this setting does not guarantee that an organization will be listed in the Zulip communities directory.

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

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

Unsets the Response realm_want_advertise_in_communities_directory.

Whether the organization has given permission to be advertised in the Zulip communities directory.

Present if realm is present in fetch_event_types.

Useful only to clients supporting changing this setting for the organization.

Giving permission via this setting does not guarantee that an organization will be listed in the Zulip communities directory.

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

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

Builder function that sets the Response realm_want_advertise_in_communities_directory.

Whether the organization has given permission to be advertised in the Zulip communities directory.

Present if realm is present in fetch_event_types.

Useful only to clients supporting changing this setting for the organization.

Giving permission via this setting does not guarantee that an organization will be listed in the Zulip communities directory.

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

pub const fn realm_giphy_rating(&self) -> Option<i64>

Gets the Response realm_giphy_rating.

The configured GIPHY rating for the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 55).

pub fn set_realm_giphy_rating(&mut self, val: i64)

Sets the Response realm_giphy_rating.

The configured GIPHY rating for the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 55).

pub fn unset_realm_giphy_rating(&mut self) -> Option<i64>

Unsets the Response realm_giphy_rating.

The configured GIPHY rating for the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 55).

pub fn with_realm_giphy_rating(self, val: i64) -> Self

Builder function that sets the Response realm_giphy_rating.

The configured GIPHY rating for the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 55).

pub const fn realm_waiting_period_threshold(&self) -> Option<i64>

Gets the Response realm_waiting_period_threshold.

Members whose accounts have been created at least this many days ago will be treated as

full members for the purpose of settings that restrict access to new members.

Present if realm is present in fetch_event_types.

pub fn set_realm_waiting_period_threshold(&mut self, val: i64)

Sets the Response realm_waiting_period_threshold.

Members whose accounts have been created at least this many days ago will be treated as

full members for the purpose of settings that restrict access to new members.

Present if realm is present in fetch_event_types.

pub fn unset_realm_waiting_period_threshold(&mut self) -> Option<i64>

Unsets the Response realm_waiting_period_threshold.

Members whose accounts have been created at least this many days ago will be treated as

full members for the purpose of settings that restrict access to new members.

Present if realm is present in fetch_event_types.

pub fn with_realm_waiting_period_threshold(self, val: i64) -> Self

Builder function that sets the Response realm_waiting_period_threshold.

Members whose accounts have been created at least this many days ago will be treated as

full members for the purpose of settings that restrict access to new members.

Present if realm is present in fetch_event_types.

pub const fn realm_digest_weekday(&self) -> Option<i64>

Gets the Response realm_digest_weekday.

The day of the week when the organization will send its weekly digest email to inactive users.

Present if realm is present in fetch_event_types.

pub fn set_realm_digest_weekday(&mut self, val: i64)

Sets the Response realm_digest_weekday.

The day of the week when the organization will send its weekly digest email to inactive users.

Present if realm is present in fetch_event_types.

pub fn unset_realm_digest_weekday(&mut self) -> Option<i64>

Unsets the Response realm_digest_weekday.

The day of the week when the organization will send its weekly digest email to inactive users.

Present if realm is present in fetch_event_types.

pub fn with_realm_digest_weekday(self, val: i64) -> Self

Builder function that sets the Response realm_digest_weekday.

The day of the week when the organization will send its weekly digest email to inactive users.

Present if realm is present in fetch_event_types.

pub const fn realm_message_content_delete_limit_seconds(&self) -> Option<i64>

Gets the Response realm_message_content_delete_limit_seconds.

Messages sent more than this many seconds ago cannot be deleted with this organization’s message deletion policy.

Present if realm is present in fetch_event_types.

Will not be 0. A null value means no limit: messages can be deleted regardless of how long ago they were sent.

Changes: No limit was represented using the special value 0 before Zulip 5.0 (feature level 100).

pub fn set_realm_message_content_delete_limit_seconds(&mut self, val: i64)

Sets the Response realm_message_content_delete_limit_seconds.

Messages sent more than this many seconds ago cannot be deleted with this organization’s message deletion policy.

Present if realm is present in fetch_event_types.

Will not be 0. A null value means no limit: messages can be deleted regardless of how long ago they were sent.

Changes: No limit was represented using the special value 0 before Zulip 5.0 (feature level 100).

pub fn unset_realm_message_content_delete_limit_seconds( &mut self, ) -> Option<i64>

Unsets the Response realm_message_content_delete_limit_seconds.

Messages sent more than this many seconds ago cannot be deleted with this organization’s message deletion policy.

Present if realm is present in fetch_event_types.

Will not be 0. A null value means no limit: messages can be deleted regardless of how long ago they were sent.

Changes: No limit was represented using the special value 0 before Zulip 5.0 (feature level 100).

pub fn with_realm_message_content_delete_limit_seconds(self, val: i64) -> Self

Builder function that sets the Response realm_message_content_delete_limit_seconds.

Messages sent more than this many seconds ago cannot be deleted with this organization’s message deletion policy.

Present if realm is present in fetch_event_types.

Will not be 0. A null value means no limit: messages can be deleted regardless of how long ago they were sent.

Changes: No limit was represented using the special value 0 before Zulip 5.0 (feature level 100).

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

Gets the Response realm_allow_message_editing.

Whether this organization’s message edit policy allows editing the content of messages.

Present if realm is present in fetch_event_types.

See PATCH /messages/{message_id} for details and history of how message editing permissions work.

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

Sets the Response realm_allow_message_editing.

Whether this organization’s message edit policy allows editing the content of messages.

Present if realm is present in fetch_event_types.

See PATCH /messages/{message_id} for details and history of how message editing permissions work.

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

Unsets the Response realm_allow_message_editing.

Whether this organization’s message edit policy allows editing the content of messages.

Present if realm is present in fetch_event_types.

See PATCH /messages/{message_id} for details and history of how message editing permissions work.

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

Builder function that sets the Response realm_allow_message_editing.

Whether this organization’s message edit policy allows editing the content of messages.

Present if realm is present in fetch_event_types.

See PATCH /messages/{message_id} for details and history of how message editing permissions work.

pub const fn realm_message_content_edit_limit_seconds(&self) -> Option<i64>

Gets the Response realm_message_content_edit_limit_seconds.

Messages sent more than this many seconds ago cannot be edited with this organization’s message edit policy.

Present if realm is present in fetch_event_types.

Will not be 0. A null value means no limit, so messages can be edited regardless of how long ago they were sent.

See PATCH /messages/{message_id} for details and history of how message editing permissions work.

Changes: Before Zulip 6.0 (feature level 138), no limit was represented using the special value 0.

pub fn set_realm_message_content_edit_limit_seconds(&mut self, val: i64)

Sets the Response realm_message_content_edit_limit_seconds.

Messages sent more than this many seconds ago cannot be edited with this organization’s message edit policy.

Present if realm is present in fetch_event_types.

Will not be 0. A null value means no limit, so messages can be edited regardless of how long ago they were sent.

See PATCH /messages/{message_id} for details and history of how message editing permissions work.

Changes: Before Zulip 6.0 (feature level 138), no limit was represented using the special value 0.

pub fn unset_realm_message_content_edit_limit_seconds(&mut self) -> Option<i64>

Unsets the Response realm_message_content_edit_limit_seconds.

Messages sent more than this many seconds ago cannot be edited with this organization’s message edit policy.

Present if realm is present in fetch_event_types.

Will not be 0. A null value means no limit, so messages can be edited regardless of how long ago they were sent.

See PATCH /messages/{message_id} for details and history of how message editing permissions work.

Changes: Before Zulip 6.0 (feature level 138), no limit was represented using the special value 0.

pub fn with_realm_message_content_edit_limit_seconds(self, val: i64) -> Self

Builder function that sets the Response realm_message_content_edit_limit_seconds.

Messages sent more than this many seconds ago cannot be edited with this organization’s message edit policy.

Present if realm is present in fetch_event_types.

Will not be 0. A null value means no limit, so messages can be edited regardless of how long ago they were sent.

See PATCH /messages/{message_id} for details and history of how message editing permissions work.

Changes: Before Zulip 6.0 (feature level 138), no limit was represented using the special value 0.

pub const fn realm_move_messages_within_stream_limit_seconds( &self, ) -> Option<i64>

Gets the Response realm_move_messages_within_stream_limit_seconds.

Messages sent more than this many seconds ago cannot be moved within a channel to another topic by

users who have permission to do so based on this organization’s topic edit policy.

Present if realm is present in fetch_event_types.

This setting does not affect moderators and administrators.

Will not be 0. A null value means no limit, so message topics can be edited regardless of how long ago they were sent.

See PATCH /messages/{message_id} for details and history of how message editing permissions work.

Changes: New in Zulip 7.0 (feature level 162). Previously, this time limit was always 72 hours for users who were not administrators or moderators.

pub fn set_realm_move_messages_within_stream_limit_seconds(&mut self, val: i64)

Sets the Response realm_move_messages_within_stream_limit_seconds.

Messages sent more than this many seconds ago cannot be moved within a channel to another topic by

users who have permission to do so based on this organization’s topic edit policy.

Present if realm is present in fetch_event_types.

This setting does not affect moderators and administrators.

Will not be 0. A null value means no limit, so message topics can be edited regardless of how long ago they were sent.

See PATCH /messages/{message_id} for details and history of how message editing permissions work.

Changes: New in Zulip 7.0 (feature level 162). Previously, this time limit was always 72 hours for users who were not administrators or moderators.

pub fn unset_realm_move_messages_within_stream_limit_seconds( &mut self, ) -> Option<i64>

Unsets the Response realm_move_messages_within_stream_limit_seconds.

Messages sent more than this many seconds ago cannot be moved within a channel to another topic by

users who have permission to do so based on this organization’s topic edit policy.

Present if realm is present in fetch_event_types.

This setting does not affect moderators and administrators.

Will not be 0. A null value means no limit, so message topics can be edited regardless of how long ago they were sent.

See PATCH /messages/{message_id} for details and history of how message editing permissions work.

Changes: New in Zulip 7.0 (feature level 162). Previously, this time limit was always 72 hours for users who were not administrators or moderators.

pub fn with_realm_move_messages_within_stream_limit_seconds( self, val: i64, ) -> Self

Builder function that sets the Response realm_move_messages_within_stream_limit_seconds.

Messages sent more than this many seconds ago cannot be moved within a channel to another topic by

users who have permission to do so based on this organization’s topic edit policy.

Present if realm is present in fetch_event_types.

This setting does not affect moderators and administrators.

Will not be 0. A null value means no limit, so message topics can be edited regardless of how long ago they were sent.

See PATCH /messages/{message_id} for details and history of how message editing permissions work.

Changes: New in Zulip 7.0 (feature level 162). Previously, this time limit was always 72 hours for users who were not administrators or moderators.

pub const fn realm_move_messages_between_streams_limit_seconds( &self, ) -> Option<i64>

Gets the Response realm_move_messages_between_streams_limit_seconds.

Messages sent more than this many seconds ago cannot be moved between channels by users who have permission to do so based

on this organization’s message move policy.

Present if realm is present in fetch_event_types.

This setting does not affect moderators and administrators.

Will not be 0. A null value means no limit, so messages can be moved regardless of how long ago they were sent.

See PATCH /messages/{message_id} for details and history of how message editing permissions work.

Changes: New in Zulip 7.0 (feature level 162). Previously, there was no time limit for moving messages between channels for users with permission to do so.

pub fn set_realm_move_messages_between_streams_limit_seconds( &mut self, val: i64, )

Sets the Response realm_move_messages_between_streams_limit_seconds.

Messages sent more than this many seconds ago cannot be moved between channels by users who have permission to do so based

on this organization’s message move policy.

Present if realm is present in fetch_event_types.

This setting does not affect moderators and administrators.

Will not be 0. A null value means no limit, so messages can be moved regardless of how long ago they were sent.

See PATCH /messages/{message_id} for details and history of how message editing permissions work.

Changes: New in Zulip 7.0 (feature level 162). Previously, there was no time limit for moving messages between channels for users with permission to do so.

pub fn unset_realm_move_messages_between_streams_limit_seconds( &mut self, ) -> Option<i64>

Unsets the Response realm_move_messages_between_streams_limit_seconds.

Messages sent more than this many seconds ago cannot be moved between channels by users who have permission to do so based

on this organization’s message move policy.

Present if realm is present in fetch_event_types.

This setting does not affect moderators and administrators.

Will not be 0. A null value means no limit, so messages can be moved regardless of how long ago they were sent.

See PATCH /messages/{message_id} for details and history of how message editing permissions work.

Changes: New in Zulip 7.0 (feature level 162). Previously, there was no time limit for moving messages between channels for users with permission to do so.

pub fn with_realm_move_messages_between_streams_limit_seconds( self, val: i64, ) -> Self

Builder function that sets the Response realm_move_messages_between_streams_limit_seconds.

Messages sent more than this many seconds ago cannot be moved between channels by users who have permission to do so based

on this organization’s message move policy.

Present if realm is present in fetch_event_types.

This setting does not affect moderators and administrators.

Will not be 0. A null value means no limit, so messages can be moved regardless of how long ago they were sent.

See PATCH /messages/{message_id} for details and history of how message editing permissions work.

Changes: New in Zulip 7.0 (feature level 162). Previously, there was no time limit for moving messages between channels for users with permission to do so.

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

Gets the Response realm_enable_read_receipts.

Whether read receipts is enabled in the organization or not.

Present if realm is present in fetch_event_types.

If disabled, read receipt data will be unavailable to clients, regardless of individual users’ personal read receipt settings.

See also the send_read_receipts setting within realm_user_settings_defaults.

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

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

Sets the Response realm_enable_read_receipts.

Whether read receipts is enabled in the organization or not.

Present if realm is present in fetch_event_types.

If disabled, read receipt data will be unavailable to clients, regardless of individual users’ personal read receipt settings.

See also the send_read_receipts setting within realm_user_settings_defaults.

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

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

Unsets the Response realm_enable_read_receipts.

Whether read receipts is enabled in the organization or not.

Present if realm is present in fetch_event_types.

If disabled, read receipt data will be unavailable to clients, regardless of individual users’ personal read receipt settings.

See also the send_read_receipts setting within realm_user_settings_defaults.

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

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

Builder function that sets the Response realm_enable_read_receipts.

Whether read receipts is enabled in the organization or not.

Present if realm is present in fetch_event_types.

If disabled, read receipt data will be unavailable to clients, regardless of individual users’ personal read receipt settings.

See also the send_read_receipts setting within realm_user_settings_defaults.

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

pub const fn max_icon_file_size_mib(&self) -> Option<i64>

Gets the Response max_icon_file_size_mib.

The maximum file size allowed for the organization’s icon. Useful for UI allowing editing the organization’s icon.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 5.0 (feature level 72). Previously, this was called max_icon_file_size.

pub fn set_max_icon_file_size_mib(&mut self, val: i64)

Sets the Response max_icon_file_size_mib.

The maximum file size allowed for the organization’s icon. Useful for UI allowing editing the organization’s icon.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 5.0 (feature level 72). Previously, this was called max_icon_file_size.

pub fn unset_max_icon_file_size_mib(&mut self) -> Option<i64>

Unsets the Response max_icon_file_size_mib.

The maximum file size allowed for the organization’s icon. Useful for UI allowing editing the organization’s icon.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 5.0 (feature level 72). Previously, this was called max_icon_file_size.

pub fn with_max_icon_file_size_mib(self, val: i64) -> Self

Builder function that sets the Response max_icon_file_size_mib.

The maximum file size allowed for the organization’s icon. Useful for UI allowing editing the organization’s icon.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 5.0 (feature level 72). Previously, this was called max_icon_file_size.

pub const fn max_logo_file_size_mib(&self) -> Option<i64>

Gets the Response max_logo_file_size_mib.

The maximum file size allowed for the uploaded organization logos.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 5.0 (feature level 72). Previously, this was called max_logo_file_size.

pub fn set_max_logo_file_size_mib(&mut self, val: i64)

Sets the Response max_logo_file_size_mib.

The maximum file size allowed for the uploaded organization logos.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 5.0 (feature level 72). Previously, this was called max_logo_file_size.

pub fn unset_max_logo_file_size_mib(&mut self) -> Option<i64>

Unsets the Response max_logo_file_size_mib.

The maximum file size allowed for the uploaded organization logos.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 5.0 (feature level 72). Previously, this was called max_logo_file_size.

pub fn with_max_logo_file_size_mib(self, val: i64) -> Self

Builder function that sets the Response max_logo_file_size_mib.

The maximum file size allowed for the uploaded organization logos.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 5.0 (feature level 72). Previously, this was called max_logo_file_size.

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

Gets the Response realm_presence_disabled.

Whether online presence of other users is shown in this organization.

Present if realm is present in fetch_event_types.

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

Sets the Response realm_presence_disabled.

Whether online presence of other users is shown in this organization.

Present if realm is present in fetch_event_types.

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

Unsets the Response realm_presence_disabled.

Whether online presence of other users is shown in this organization.

Present if realm is present in fetch_event_types.

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

Builder function that sets the Response realm_presence_disabled.

Whether online presence of other users is shown in this organization.

Present if realm is present in fetch_event_types.

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

Gets the Response settings_send_digest_emails.

Whether this Zulip server is configured to allow organizations to enable digest emails.

Present if realm is present in fetch_event_types.

Relevant for administrative settings UI that can change the digest email settings.

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

Sets the Response settings_send_digest_emails.

Whether this Zulip server is configured to allow organizations to enable digest emails.

Present if realm is present in fetch_event_types.

Relevant for administrative settings UI that can change the digest email settings.

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

Unsets the Response settings_send_digest_emails.

Whether this Zulip server is configured to allow organizations to enable digest emails.

Present if realm is present in fetch_event_types.

Relevant for administrative settings UI that can change the digest email settings.

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

Builder function that sets the Response settings_send_digest_emails.

Whether this Zulip server is configured to allow organizations to enable digest emails.

Present if realm is present in fetch_event_types.

Relevant for administrative settings UI that can change the digest email settings.

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

Gets the Response realm_email_auth_enabled.

Whether the organization has enabled Zulip’s default email and password authentication feature.

Present if realm is present in fetch_event_types.

Determines whether Zulip stores a password for the user and clients should offer any UI for changing the user’s Zulip password.

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

Sets the Response realm_email_auth_enabled.

Whether the organization has enabled Zulip’s default email and password authentication feature.

Present if realm is present in fetch_event_types.

Determines whether Zulip stores a password for the user and clients should offer any UI for changing the user’s Zulip password.

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

Unsets the Response realm_email_auth_enabled.

Whether the organization has enabled Zulip’s default email and password authentication feature.

Present if realm is present in fetch_event_types.

Determines whether Zulip stores a password for the user and clients should offer any UI for changing the user’s Zulip password.

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

Builder function that sets the Response realm_email_auth_enabled.

Whether the organization has enabled Zulip’s default email and password authentication feature.

Present if realm is present in fetch_event_types.

Determines whether Zulip stores a password for the user and clients should offer any UI for changing the user’s Zulip password.

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

Gets the Response realm_password_auth_enabled.

Whether the organization allows any sort of password-based authentication (whether via EmailAuthBackend or LDAP passwords).

Present if realm is present in fetch_event_types.

Determines whether a client might ever need to display a password prompt

(clients will primarily look at this attribute in server_settings before presenting a login page).

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

Sets the Response realm_password_auth_enabled.

Whether the organization allows any sort of password-based authentication (whether via EmailAuthBackend or LDAP passwords).

Present if realm is present in fetch_event_types.

Determines whether a client might ever need to display a password prompt

(clients will primarily look at this attribute in server_settings before presenting a login page).

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

Unsets the Response realm_password_auth_enabled.

Whether the organization allows any sort of password-based authentication (whether via EmailAuthBackend or LDAP passwords).

Present if realm is present in fetch_event_types.

Determines whether a client might ever need to display a password prompt

(clients will primarily look at this attribute in server_settings before presenting a login page).

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

Builder function that sets the Response realm_password_auth_enabled.

Whether the organization allows any sort of password-based authentication (whether via EmailAuthBackend or LDAP passwords).

Present if realm is present in fetch_event_types.

Determines whether a client might ever need to display a password prompt

(clients will primarily look at this attribute in server_settings before presenting a login page).

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

Gets the Response realm_push_notifications_enabled.

Whether push notifications are enabled for this organization. Typically true for Zulip Cloud and self-hosted realms that have a

valid registration for the Mobile push notifications service,

and false for self-hosted servers that do not.

Present if realm is present in fetch_event_types.

Changes: Before Zulip 8.0 (feature level 231),

this incorrectly was true for servers that were partly configured to use the Mobile Push Notifications Service but not properly registered.

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

Sets the Response realm_push_notifications_enabled.

Whether push notifications are enabled for this organization. Typically true for Zulip Cloud and self-hosted realms that have a

valid registration for the Mobile push notifications service,

and false for self-hosted servers that do not.

Present if realm is present in fetch_event_types.

Changes: Before Zulip 8.0 (feature level 231),

this incorrectly was true for servers that were partly configured to use the Mobile Push Notifications Service but not properly registered.

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

Unsets the Response realm_push_notifications_enabled.

Whether push notifications are enabled for this organization. Typically true for Zulip Cloud and self-hosted realms that have a

valid registration for the Mobile push notifications service,

and false for self-hosted servers that do not.

Present if realm is present in fetch_event_types.

Changes: Before Zulip 8.0 (feature level 231),

this incorrectly was true for servers that were partly configured to use the Mobile Push Notifications Service but not properly registered.

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

Builder function that sets the Response realm_push_notifications_enabled.

Whether push notifications are enabled for this organization. Typically true for Zulip Cloud and self-hosted realms that have a

valid registration for the Mobile push notifications service,

and false for self-hosted servers that do not.

Present if realm is present in fetch_event_types.

Changes: Before Zulip 8.0 (feature level 231),

this incorrectly was true for servers that were partly configured to use the Mobile Push Notifications Service but not properly registered.

pub const fn realm_push_notifications_enabled_end_timestamp( &self, ) -> Option<i64>

Gets the Response realm_push_notifications_enabled_end_timestamp.

If the server expects the realm’s push notifications access to end at a definite time in the future,

the UNIX timestamp (UTC) at which this is expected to happen.

Present if realm is present in fetch_event_types.

Mobile clients should use this field to display warnings to users when the indicated timestamp is near.

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

pub fn set_realm_push_notifications_enabled_end_timestamp(&mut self, val: i64)

Sets the Response realm_push_notifications_enabled_end_timestamp.

If the server expects the realm’s push notifications access to end at a definite time in the future,

the UNIX timestamp (UTC) at which this is expected to happen.

Present if realm is present in fetch_event_types.

Mobile clients should use this field to display warnings to users when the indicated timestamp is near.

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

pub fn unset_realm_push_notifications_enabled_end_timestamp( &mut self, ) -> Option<i64>

Unsets the Response realm_push_notifications_enabled_end_timestamp.

If the server expects the realm’s push notifications access to end at a definite time in the future,

the UNIX timestamp (UTC) at which this is expected to happen.

Present if realm is present in fetch_event_types.

Mobile clients should use this field to display warnings to users when the indicated timestamp is near.

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

pub fn with_realm_push_notifications_enabled_end_timestamp( self, val: i64, ) -> Self

Builder function that sets the Response realm_push_notifications_enabled_end_timestamp.

If the server expects the realm’s push notifications access to end at a definite time in the future,

the UNIX timestamp (UTC) at which this is expected to happen.

Present if realm is present in fetch_event_types.

Mobile clients should use this field to display warnings to users when the indicated timestamp is near.

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

pub const fn realm_upload_quota_mib(&self) -> Option<i64>

Gets the Response realm_upload_quota_mib.

The total quota for uploaded files in this organization.

Present if realm is present in fetch_event_types.

Clients are not responsible for checking this quota; it is included in the API only for display purposes.

If null, there is no limit.

Changes: Before Zulip 9.0 (feature level 251), this field was incorrectly measured in bytes, not MiB.

New in Zulip 5.0 (feature level 72). Previously, this was called realm_upload_quota.

pub fn set_realm_upload_quota_mib(&mut self, val: i64)

Sets the Response realm_upload_quota_mib.

The total quota for uploaded files in this organization.

Present if realm is present in fetch_event_types.

Clients are not responsible for checking this quota; it is included in the API only for display purposes.

If null, there is no limit.

Changes: Before Zulip 9.0 (feature level 251), this field was incorrectly measured in bytes, not MiB.

New in Zulip 5.0 (feature level 72). Previously, this was called realm_upload_quota.

pub fn unset_realm_upload_quota_mib(&mut self) -> Option<i64>

Unsets the Response realm_upload_quota_mib.

The total quota for uploaded files in this organization.

Present if realm is present in fetch_event_types.

Clients are not responsible for checking this quota; it is included in the API only for display purposes.

If null, there is no limit.

Changes: Before Zulip 9.0 (feature level 251), this field was incorrectly measured in bytes, not MiB.

New in Zulip 5.0 (feature level 72). Previously, this was called realm_upload_quota.

pub fn with_realm_upload_quota_mib(self, val: i64) -> Self

Builder function that sets the Response realm_upload_quota_mib.

The total quota for uploaded files in this organization.

Present if realm is present in fetch_event_types.

Clients are not responsible for checking this quota; it is included in the API only for display purposes.

If null, there is no limit.

Changes: Before Zulip 9.0 (feature level 251), this field was incorrectly measured in bytes, not MiB.

New in Zulip 5.0 (feature level 72). Previously, this was called realm_upload_quota.

pub const fn realm_org_type(&self) -> Option<RealmOrganizationType>

Gets the Response realm_org_type.

Represents the organization type for the realm.

Present if realm is present in fetch_event_types.

pub fn set_realm_org_type(&mut self, val: RealmOrganizationType)

Sets the Response realm_org_type.

Represents the organization type for the realm.

Present if realm is present in fetch_event_types.

pub fn unset_realm_org_type(&mut self) -> Option<RealmOrganizationType>

Unsets the Response realm_org_type.

Represents the organization type for the realm.

Present if realm is present in fetch_event_types.

pub fn with_realm_org_type(self, val: RealmOrganizationType) -> Self

Builder function that sets the Response realm_org_type.

Represents the organization type for the realm.

Present if realm is present in fetch_event_types.

pub const fn realm_plan_type(&self) -> Option<RealmPlanType>

Gets the Response realm_plan_type.

Represents the plan type of the organization.

Present if realm is present in fetch_event_types.

pub fn set_realm_plan_type(&mut self, val: RealmPlanType)

Sets the Response realm_plan_type.

Represents the plan type of the organization.

Present if realm is present in fetch_event_types.

pub fn unset_realm_plan_type(&mut self) -> Option<RealmPlanType>

Unsets the Response realm_plan_type.

Represents the plan type of the organization.

Present if realm is present in fetch_event_types.

pub fn with_realm_plan_type(self, val: RealmPlanType) -> Self

Builder function that sets the Response realm_plan_type.

Represents the plan type of the organization.

Present if realm is present in fetch_event_types.

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

Gets the Response realm_enable_guest_user_dm_warning.

Whether clients should show a warning when a user is composing a DM to a guest user in this organization.

Present if realm is present in fetch_event_types.

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

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

Sets the Response realm_enable_guest_user_dm_warning.

Whether clients should show a warning when a user is composing a DM to a guest user in this organization.

Present if realm is present in fetch_event_types.

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

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

Unsets the Response realm_enable_guest_user_dm_warning.

Whether clients should show a warning when a user is composing a DM to a guest user in this organization.

Present if realm is present in fetch_event_types.

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

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

Builder function that sets the Response realm_enable_guest_user_dm_warning.

Whether clients should show a warning when a user is composing a DM to a guest user in this organization.

Present if realm is present in fetch_event_types.

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

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

Gets the Response realm_enable_guest_user_indicator.

Whether clients should display "(guest)" after the names of guest users to prominently highlight their status.

Present if realm is present in fetch_event_types.

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

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

Sets the Response realm_enable_guest_user_indicator.

Whether clients should display "(guest)" after the names of guest users to prominently highlight their status.

Present if realm is present in fetch_event_types.

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

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

Unsets the Response realm_enable_guest_user_indicator.

Whether clients should display "(guest)" after the names of guest users to prominently highlight their status.

Present if realm is present in fetch_event_types.

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

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

Builder function that sets the Response realm_enable_guest_user_indicator.

Whether clients should display "(guest)" after the names of guest users to prominently highlight their status.

Present if realm is present in fetch_event_types.

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

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

Gets the Response zulip_plan_is_not_limited.

Whether the organization is using a limited (Zulip Cloud Free) plan.

Present if realm is present in fetch_event_types.

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

Sets the Response zulip_plan_is_not_limited.

Whether the organization is using a limited (Zulip Cloud Free) plan.

Present if realm is present in fetch_event_types.

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

Unsets the Response zulip_plan_is_not_limited.

Whether the organization is using a limited (Zulip Cloud Free) plan.

Present if realm is present in fetch_event_types.

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

Builder function that sets the Response zulip_plan_is_not_limited.

Whether the organization is using a limited (Zulip Cloud Free) plan.

Present if realm is present in fetch_event_types.

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

Gets the Response development_environment.

Whether this Zulip server is a development environment.

Present if realm is present in fetch_event_types.

Used to control certain features or UI (such as error popups) that should only apply when connected to a Zulip development environment.

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

Sets the Response development_environment.

Whether this Zulip server is a development environment.

Present if realm is present in fetch_event_types.

Used to control certain features or UI (such as error popups) that should only apply when connected to a Zulip development environment.

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

Unsets the Response development_environment.

Whether this Zulip server is a development environment.

Present if realm is present in fetch_event_types.

Used to control certain features or UI (such as error popups) that should only apply when connected to a Zulip development environment.

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

Builder function that sets the Response development_environment.

Whether this Zulip server is a development environment.

Present if realm is present in fetch_event_types.

Used to control certain features or UI (such as error popups) that should only apply when connected to a Zulip development environment.

pub const fn server_generation(&self) -> Option<i64>

Gets the Response server_generation.

A timestamp indicating when the process hosting this event queue was started.

Present if realm is present in fetch_event_types.

Clients will likely only find this value useful for inclusion in detailed error reports.

pub fn set_server_generation(&mut self, val: i64)

Sets the Response server_generation.

A timestamp indicating when the process hosting this event queue was started.

Present if realm is present in fetch_event_types.

Clients will likely only find this value useful for inclusion in detailed error reports.

pub fn unset_server_generation(&mut self) -> Option<i64>

Unsets the Response server_generation.

A timestamp indicating when the process hosting this event queue was started.

Present if realm is present in fetch_event_types.

Clients will likely only find this value useful for inclusion in detailed error reports.

pub fn with_server_generation(self, val: i64) -> Self

Builder function that sets the Response server_generation.

A timestamp indicating when the process hosting this event queue was started.

Present if realm is present in fetch_event_types.

Clients will likely only find this value useful for inclusion in detailed error reports.

pub const fn password_min_length(&self) -> Option<i64>

Gets the Response password_min_length.

This Zulip server’s configured minimum required length for passwords.

Present if realm is present in fetch_event_types.

Necessary for password change UI to show whether the password will be accepted.

pub fn set_password_min_length(&mut self, val: i64)

Sets the Response password_min_length.

This Zulip server’s configured minimum required length for passwords.

Present if realm is present in fetch_event_types.

Necessary for password change UI to show whether the password will be accepted.

pub fn unset_password_min_length(&mut self) -> Option<i64>

Unsets the Response password_min_length.

This Zulip server’s configured minimum required length for passwords.

Present if realm is present in fetch_event_types.

Necessary for password change UI to show whether the password will be accepted.

pub fn with_password_min_length(self, val: i64) -> Self

Builder function that sets the Response password_min_length.

This Zulip server’s configured minimum required length for passwords.

Present if realm is present in fetch_event_types.

Necessary for password change UI to show whether the password will be accepted.

pub const fn password_max_length(&self) -> Option<i64>

Gets the Response password_max_length.

This Zulip server’s configured maximum length for passwords.

Present if realm is present in fetch_event_types.

Necessary for password change UI to show whether the password will be accepted.

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

pub fn set_password_max_length(&mut self, val: i64)

Sets the Response password_max_length.

This Zulip server’s configured maximum length for passwords.

Present if realm is present in fetch_event_types.

Necessary for password change UI to show whether the password will be accepted.

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

pub fn unset_password_max_length(&mut self) -> Option<i64>

Unsets the Response password_max_length.

This Zulip server’s configured maximum length for passwords.

Present if realm is present in fetch_event_types.

Necessary for password change UI to show whether the password will be accepted.

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

pub fn with_password_max_length(self, val: i64) -> Self

Builder function that sets the Response password_max_length.

This Zulip server’s configured maximum length for passwords.

Present if realm is present in fetch_event_types.

Necessary for password change UI to show whether the password will be accepted.

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

pub const fn password_min_guesses(&self) -> Option<i64>

Gets the Response password_min_guesses.

This Zulip server’s configured minimum zxcvbn minimum guesses.

Present if realm is present in fetch_event_types.

Necessary for password change UI to show whether the password will be accepted.

pub fn set_password_min_guesses(&mut self, val: i64)

Sets the Response password_min_guesses.

This Zulip server’s configured minimum zxcvbn minimum guesses.

Present if realm is present in fetch_event_types.

Necessary for password change UI to show whether the password will be accepted.

pub fn unset_password_min_guesses(&mut self) -> Option<i64>

Unsets the Response password_min_guesses.

This Zulip server’s configured minimum zxcvbn minimum guesses.

Present if realm is present in fetch_event_types.

Necessary for password change UI to show whether the password will be accepted.

pub fn with_password_min_guesses(self, val: i64) -> Self

Builder function that sets the Response password_min_guesses.

This Zulip server’s configured minimum zxcvbn minimum guesses.

Present if realm is present in fetch_event_types.

Necessary for password change UI to show whether the password will be accepted.

pub const fn max_file_upload_size_mib(&self) -> Option<i64>

Gets the Response max_file_upload_size_mib.

The maximum file size that can be uploaded to this Zulip organization.

Present if realm is present in fetch_event_types.

pub fn set_max_file_upload_size_mib(&mut self, val: i64)

Sets the Response max_file_upload_size_mib.

The maximum file size that can be uploaded to this Zulip organization.

Present if realm is present in fetch_event_types.

pub fn unset_max_file_upload_size_mib(&mut self) -> Option<i64>

Unsets the Response max_file_upload_size_mib.

The maximum file size that can be uploaded to this Zulip organization.

Present if realm is present in fetch_event_types.

pub fn with_max_file_upload_size_mib(self, val: i64) -> Self

Builder function that sets the Response max_file_upload_size_mib.

The maximum file size that can be uploaded to this Zulip organization.

Present if realm is present in fetch_event_types.

pub const fn max_avatar_file_size_mib(&self) -> Option<i64>

Gets the Response max_avatar_file_size_mib.

The maximum avatar size that can be uploaded to this Zulip server.

Present if realm is present in fetch_event_types.

pub fn set_max_avatar_file_size_mib(&mut self, val: i64)

Sets the Response max_avatar_file_size_mib.

The maximum avatar size that can be uploaded to this Zulip server.

Present if realm is present in fetch_event_types.

pub fn unset_max_avatar_file_size_mib(&mut self) -> Option<i64>

Unsets the Response max_avatar_file_size_mib.

The maximum avatar size that can be uploaded to this Zulip server.

Present if realm is present in fetch_event_types.

pub fn with_max_avatar_file_size_mib(self, val: i64) -> Self

Builder function that sets the Response max_avatar_file_size_mib.

The maximum avatar size that can be uploaded to this Zulip server.

Present if realm is present in fetch_event_types.

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

Gets the Response server_inline_image_preview.

Whether the server is configured with support for inline image previews.

Present if realm is present in fetch_event_types.

Clients containing administrative UI for changing realm_inline_image_preview should consult this field before offering that feature.

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

Sets the Response server_inline_image_preview.

Whether the server is configured with support for inline image previews.

Present if realm is present in fetch_event_types.

Clients containing administrative UI for changing realm_inline_image_preview should consult this field before offering that feature.

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

Unsets the Response server_inline_image_preview.

Whether the server is configured with support for inline image previews.

Present if realm is present in fetch_event_types.

Clients containing administrative UI for changing realm_inline_image_preview should consult this field before offering that feature.

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

Builder function that sets the Response server_inline_image_preview.

Whether the server is configured with support for inline image previews.

Present if realm is present in fetch_event_types.

Clients containing administrative UI for changing realm_inline_image_preview should consult this field before offering that feature.

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

Gets the Response server_inline_url_embed_preview.

Whether the server is configured with support for inline URL previews.

Present if realm is present in fetch_event_types.

Clients containing administrative UI for changing realm_inline_url_embed_preview should consult this field before offering that feature.

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

Sets the Response server_inline_url_embed_preview.

Whether the server is configured with support for inline URL previews.

Present if realm is present in fetch_event_types.

Clients containing administrative UI for changing realm_inline_url_embed_preview should consult this field before offering that feature.

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

Unsets the Response server_inline_url_embed_preview.

Whether the server is configured with support for inline URL previews.

Present if realm is present in fetch_event_types.

Clients containing administrative UI for changing realm_inline_url_embed_preview should consult this field before offering that feature.

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

Builder function that sets the Response server_inline_url_embed_preview.

Whether the server is configured with support for inline URL previews.

Present if realm is present in fetch_event_types.

Clients containing administrative UI for changing realm_inline_url_embed_preview should consult this field before offering that feature.

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

Gets the Response server_avatar_changes_disabled.

Whether the server allows avatar changes.

Present if realm is present in fetch_event_types.

Similar to realm_avatar_changes_disabled but based on the AVATAR_CHANGES_DISABLED Zulip server level setting.

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

Sets the Response server_avatar_changes_disabled.

Whether the server allows avatar changes.

Present if realm is present in fetch_event_types.

Similar to realm_avatar_changes_disabled but based on the AVATAR_CHANGES_DISABLED Zulip server level setting.

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

Unsets the Response server_avatar_changes_disabled.

Whether the server allows avatar changes.

Present if realm is present in fetch_event_types.

Similar to realm_avatar_changes_disabled but based on the AVATAR_CHANGES_DISABLED Zulip server level setting.

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

Builder function that sets the Response server_avatar_changes_disabled.

Whether the server allows avatar changes.

Present if realm is present in fetch_event_types.

Similar to realm_avatar_changes_disabled but based on the AVATAR_CHANGES_DISABLED Zulip server level setting.

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

Gets the Response server_name_changes_disabled.

Whether the server allows name changes.

Present if realm is present in fetch_event_types.

Similar to realm_name_changes_disabled but based on the NAME_CHANGES_DISABLED Zulip server level setting.

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

Sets the Response server_name_changes_disabled.

Whether the server allows name changes.

Present if realm is present in fetch_event_types.

Similar to realm_name_changes_disabled but based on the NAME_CHANGES_DISABLED Zulip server level setting.

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

Unsets the Response server_name_changes_disabled.

Whether the server allows name changes.

Present if realm is present in fetch_event_types.

Similar to realm_name_changes_disabled but based on the NAME_CHANGES_DISABLED Zulip server level setting.

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

Builder function that sets the Response server_name_changes_disabled.

Whether the server allows name changes.

Present if realm is present in fetch_event_types.

Similar to realm_name_changes_disabled but based on the NAME_CHANGES_DISABLED Zulip server level setting.

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

Gets the Response server_needs_upgrade.

Whether the server is running an old version based on the Zulip server release lifecycle,

such that the web app will display to the current user a prominent warning.

Present if realm is present in fetch_event_types.

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

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

Sets the Response server_needs_upgrade.

Whether the server is running an old version based on the Zulip server release lifecycle,

such that the web app will display to the current user a prominent warning.

Present if realm is present in fetch_event_types.

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

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

Unsets the Response server_needs_upgrade.

Whether the server is running an old version based on the Zulip server release lifecycle,

such that the web app will display to the current user a prominent warning.

Present if realm is present in fetch_event_types.

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

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

Builder function that sets the Response server_needs_upgrade.

Whether the server is running an old version based on the Zulip server release lifecycle,

such that the web app will display to the current user a prominent warning.

Present if realm is present in fetch_event_types.

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

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

Gets the Response server_web_public_streams_enabled.

The value of the WEB_PUBLIC_STREAMS_ENABLED Zulip server level setting.

Present if realm is present in fetch_event_types.

A server that has disabled this setting intends to not offer web public channels to realms it hosts.

(Zulip Cloud defaults to true; self-hosted servers default to false).

Clients should use this to determine whether to offer UI for the realm-level setting for enabling web-public channels (realm_enable_spectator_access).

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

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

Sets the Response server_web_public_streams_enabled.

The value of the WEB_PUBLIC_STREAMS_ENABLED Zulip server level setting.

Present if realm is present in fetch_event_types.

A server that has disabled this setting intends to not offer web public channels to realms it hosts.

(Zulip Cloud defaults to true; self-hosted servers default to false).

Clients should use this to determine whether to offer UI for the realm-level setting for enabling web-public channels (realm_enable_spectator_access).

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

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

Unsets the Response server_web_public_streams_enabled.

The value of the WEB_PUBLIC_STREAMS_ENABLED Zulip server level setting.

Present if realm is present in fetch_event_types.

A server that has disabled this setting intends to not offer web public channels to realms it hosts.

(Zulip Cloud defaults to true; self-hosted servers default to false).

Clients should use this to determine whether to offer UI for the realm-level setting for enabling web-public channels (realm_enable_spectator_access).

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

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

Builder function that sets the Response server_web_public_streams_enabled.

The value of the WEB_PUBLIC_STREAMS_ENABLED Zulip server level setting.

Present if realm is present in fetch_event_types.

A server that has disabled this setting intends to not offer web public channels to realms it hosts.

(Zulip Cloud defaults to true; self-hosted servers default to false).

Clients should use this to determine whether to offer UI for the realm-level setting for enabling web-public channels (realm_enable_spectator_access).

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

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

Gets the Response server_can_summarize_topics.

Whether topic summarization is enabled in the server or not depending upon whether TOPIC_SUMMARIZATION_MODEL is set or not.

Present if realm is present in fetch_event_types.

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

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

Sets the Response server_can_summarize_topics.

Whether topic summarization is enabled in the server or not depending upon whether TOPIC_SUMMARIZATION_MODEL is set or not.

Present if realm is present in fetch_event_types.

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

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

Unsets the Response server_can_summarize_topics.

Whether topic summarization is enabled in the server or not depending upon whether TOPIC_SUMMARIZATION_MODEL is set or not.

Present if realm is present in fetch_event_types.

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

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

Builder function that sets the Response server_can_summarize_topics.

Whether topic summarization is enabled in the server or not depending upon whether TOPIC_SUMMARIZATION_MODEL is set or not.

Present if realm is present in fetch_event_types.

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

pub const fn event_queue_longpoll_timeout_seconds(&self) -> Option<i64>

Gets the Response event_queue_longpoll_timeout_seconds.

Recommended client-side HTTP request timeout for GET /events calls.

Present if realm is present in fetch_event_types.

This is guaranteed to be somewhat greater than the heartbeat frequency.

It is important that clients respect this parameter, so that increases in the heartbeat frequency do not break clients.

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

Previously, this was hardcoded to 90 seconds, and clients should use that as a fallback value when interacting with servers where this field is not present.

pub fn set_event_queue_longpoll_timeout_seconds(&mut self, val: i64)

Sets the Response event_queue_longpoll_timeout_seconds.

Recommended client-side HTTP request timeout for GET /events calls.

Present if realm is present in fetch_event_types.

This is guaranteed to be somewhat greater than the heartbeat frequency.

It is important that clients respect this parameter, so that increases in the heartbeat frequency do not break clients.

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

Previously, this was hardcoded to 90 seconds, and clients should use that as a fallback value when interacting with servers where this field is not present.

pub fn unset_event_queue_longpoll_timeout_seconds(&mut self) -> Option<i64>

Unsets the Response event_queue_longpoll_timeout_seconds.

Recommended client-side HTTP request timeout for GET /events calls.

Present if realm is present in fetch_event_types.

This is guaranteed to be somewhat greater than the heartbeat frequency.

It is important that clients respect this parameter, so that increases in the heartbeat frequency do not break clients.

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

Previously, this was hardcoded to 90 seconds, and clients should use that as a fallback value when interacting with servers where this field is not present.

pub fn with_event_queue_longpoll_timeout_seconds(self, val: i64) -> Self

Builder function that sets the Response event_queue_longpoll_timeout_seconds.

Recommended client-side HTTP request timeout for GET /events calls.

Present if realm is present in fetch_event_types.

This is guaranteed to be somewhat greater than the heartbeat frequency.

It is important that clients respect this parameter, so that increases in the heartbeat frequency do not break clients.

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

Previously, this was hardcoded to 90 seconds, and clients should use that as a fallback value when interacting with servers where this field is not present.

pub const fn realm_moderation_request_channel_id(&self) -> Option<i64>

Gets the Response realm_moderation_request_channel_id.

The ID of the private channel to which messages flagged by users for moderation are sent.

Present if realm is present in fetch_event_types.

Moderators can use this channel to review and act on reported content.

Will be -1 if moderation requests are disabled.

Clients should check whether moderation requests are disabled to determine whether to present a "report message" feature in their UI within a given organization.

Changes: New in Zulip 10.0 (feature level 331). Previously, no "report message" feature existed in Zulip.

pub fn set_realm_moderation_request_channel_id(&mut self, val: i64)

Sets the Response realm_moderation_request_channel_id.

The ID of the private channel to which messages flagged by users for moderation are sent.

Present if realm is present in fetch_event_types.

Moderators can use this channel to review and act on reported content.

Will be -1 if moderation requests are disabled.

Clients should check whether moderation requests are disabled to determine whether to present a "report message" feature in their UI within a given organization.

Changes: New in Zulip 10.0 (feature level 331). Previously, no "report message" feature existed in Zulip.

pub fn unset_realm_moderation_request_channel_id(&mut self) -> Option<i64>

Unsets the Response realm_moderation_request_channel_id.

The ID of the private channel to which messages flagged by users for moderation are sent.

Present if realm is present in fetch_event_types.

Moderators can use this channel to review and act on reported content.

Will be -1 if moderation requests are disabled.

Clients should check whether moderation requests are disabled to determine whether to present a "report message" feature in their UI within a given organization.

Changes: New in Zulip 10.0 (feature level 331). Previously, no "report message" feature existed in Zulip.

pub fn with_realm_moderation_request_channel_id(self, val: i64) -> Self

Builder function that sets the Response realm_moderation_request_channel_id.

The ID of the private channel to which messages flagged by users for moderation are sent.

Present if realm is present in fetch_event_types.

Moderators can use this channel to review and act on reported content.

Will be -1 if moderation requests are disabled.

Clients should check whether moderation requests are disabled to determine whether to present a "report message" feature in their UI within a given organization.

Changes: New in Zulip 10.0 (feature level 331). Previously, no "report message" feature existed in Zulip.

pub const fn realm_new_stream_announcements_stream_id(&self) -> Option<i64>

Gets the Response realm_new_stream_announcements_stream_id.

The ID of the channel to which automated messages announcing the creation of new channels are sent.

Present if realm is present in fetch_event_types.

Will be -1 if such automated messages are disabled.

Since these automated messages are sent by the server, this field is primarily relevant to clients containing UI for changing it.

Changes: In Zulip 9.0 (feature level 241), renamed ‘realm_notifications_stream_id’ to realm_new_stream_announcements_stream_id.)

pub fn set_realm_new_stream_announcements_stream_id(&mut self, val: i64)

Sets the Response realm_new_stream_announcements_stream_id.

The ID of the channel to which automated messages announcing the creation of new channels are sent.

Present if realm is present in fetch_event_types.

Will be -1 if such automated messages are disabled.

Since these automated messages are sent by the server, this field is primarily relevant to clients containing UI for changing it.

Changes: In Zulip 9.0 (feature level 241), renamed ‘realm_notifications_stream_id’ to realm_new_stream_announcements_stream_id.)

pub fn unset_realm_new_stream_announcements_stream_id(&mut self) -> Option<i64>

Unsets the Response realm_new_stream_announcements_stream_id.

The ID of the channel to which automated messages announcing the creation of new channels are sent.

Present if realm is present in fetch_event_types.

Will be -1 if such automated messages are disabled.

Since these automated messages are sent by the server, this field is primarily relevant to clients containing UI for changing it.

Changes: In Zulip 9.0 (feature level 241), renamed ‘realm_notifications_stream_id’ to realm_new_stream_announcements_stream_id.)

pub fn with_realm_new_stream_announcements_stream_id(self, val: i64) -> Self

Builder function that sets the Response realm_new_stream_announcements_stream_id.

The ID of the channel to which automated messages announcing the creation of new channels are sent.

Present if realm is present in fetch_event_types.

Will be -1 if such automated messages are disabled.

Since these automated messages are sent by the server, this field is primarily relevant to clients containing UI for changing it.

Changes: In Zulip 9.0 (feature level 241), renamed ‘realm_notifications_stream_id’ to realm_new_stream_announcements_stream_id.)

pub const fn realm_signup_announcements_stream_id(&self) -> Option<i64>

Gets the Response realm_signup_announcements_stream_id.

The ID of the channel to which automated messages announcing that new users have joined the organization are sent.

Present if realm is present in fetch_event_types.

Will be -1 if such automated messages are disabled.

Since these automated messages are sent by the server, this field is primarily relevant to clients containing UI for changing it.

Changes: In Zulip 9.0 (feature level 241), renamed ‘realm_signup_notifications_stream_id’ to realm_signup_announcements_stream_id.

pub fn set_realm_signup_announcements_stream_id(&mut self, val: i64)

Sets the Response realm_signup_announcements_stream_id.

The ID of the channel to which automated messages announcing that new users have joined the organization are sent.

Present if realm is present in fetch_event_types.

Will be -1 if such automated messages are disabled.

Since these automated messages are sent by the server, this field is primarily relevant to clients containing UI for changing it.

Changes: In Zulip 9.0 (feature level 241), renamed ‘realm_signup_notifications_stream_id’ to realm_signup_announcements_stream_id.

pub fn unset_realm_signup_announcements_stream_id(&mut self) -> Option<i64>

Unsets the Response realm_signup_announcements_stream_id.

The ID of the channel to which automated messages announcing that new users have joined the organization are sent.

Present if realm is present in fetch_event_types.

Will be -1 if such automated messages are disabled.

Since these automated messages are sent by the server, this field is primarily relevant to clients containing UI for changing it.

Changes: In Zulip 9.0 (feature level 241), renamed ‘realm_signup_notifications_stream_id’ to realm_signup_announcements_stream_id.

pub fn with_realm_signup_announcements_stream_id(self, val: i64) -> Self

Builder function that sets the Response realm_signup_announcements_stream_id.

The ID of the channel to which automated messages announcing that new users have joined the organization are sent.

Present if realm is present in fetch_event_types.

Will be -1 if such automated messages are disabled.

Since these automated messages are sent by the server, this field is primarily relevant to clients containing UI for changing it.

Changes: In Zulip 9.0 (feature level 241), renamed ‘realm_signup_notifications_stream_id’ to realm_signup_announcements_stream_id.

pub const fn realm_zulip_update_announcements_stream_id(&self) -> Option<i64>

Gets the Response realm_zulip_update_announcements_stream_id.

The ID of the channel to which automated messages announcing new features or other end-user updates about the Zulip software are sent.

Present if realm is present in fetch_event_types.

Will be -1 if such automated messages are disabled.

Since these automated messages are sent by the server, this field is primarily relevant to clients containing UI for changing it.

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

pub fn set_realm_zulip_update_announcements_stream_id(&mut self, val: i64)

Sets the Response realm_zulip_update_announcements_stream_id.

The ID of the channel to which automated messages announcing new features or other end-user updates about the Zulip software are sent.

Present if realm is present in fetch_event_types.

Will be -1 if such automated messages are disabled.

Since these automated messages are sent by the server, this field is primarily relevant to clients containing UI for changing it.

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

pub fn unset_realm_zulip_update_announcements_stream_id( &mut self, ) -> Option<i64>

Unsets the Response realm_zulip_update_announcements_stream_id.

The ID of the channel to which automated messages announcing new features or other end-user updates about the Zulip software are sent.

Present if realm is present in fetch_event_types.

Will be -1 if such automated messages are disabled.

Since these automated messages are sent by the server, this field is primarily relevant to clients containing UI for changing it.

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

pub fn with_realm_zulip_update_announcements_stream_id(self, val: i64) -> Self

Builder function that sets the Response realm_zulip_update_announcements_stream_id.

The ID of the channel to which automated messages announcing new features or other end-user updates about the Zulip software are sent.

Present if realm is present in fetch_event_types.

Will be -1 if such automated messages are disabled.

Since these automated messages are sent by the server, this field is primarily relevant to clients containing UI for changing it.

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

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

Gets the Response can_create_streams.

Whether the current user is allowed to create at least one type of channel with the organization’s channel creation policy.

Its value will always equal can_create_public_streams || can_create_private_streams.

Present if realm_user is present in fetch_event_types.

Changes: Deprecated in Zulip 5.0 (feature level 102),

when the new create_private_stream_policy and create_public_stream_policy properties introduced the possibility that a user could only create one type of channel.

This field will be removed in a future release.

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

Sets the Response can_create_streams.

Whether the current user is allowed to create at least one type of channel with the organization’s channel creation policy.

Its value will always equal can_create_public_streams || can_create_private_streams.

Present if realm_user is present in fetch_event_types.

Changes: Deprecated in Zulip 5.0 (feature level 102),

when the new create_private_stream_policy and create_public_stream_policy properties introduced the possibility that a user could only create one type of channel.

This field will be removed in a future release.

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

Unsets the Response can_create_streams.

Whether the current user is allowed to create at least one type of channel with the organization’s channel creation policy.

Its value will always equal can_create_public_streams || can_create_private_streams.

Present if realm_user is present in fetch_event_types.

Changes: Deprecated in Zulip 5.0 (feature level 102),

when the new create_private_stream_policy and create_public_stream_policy properties introduced the possibility that a user could only create one type of channel.

This field will be removed in a future release.

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

Builder function that sets the Response can_create_streams.

Whether the current user is allowed to create at least one type of channel with the organization’s channel creation policy.

Its value will always equal can_create_public_streams || can_create_private_streams.

Present if realm_user is present in fetch_event_types.

Changes: Deprecated in Zulip 5.0 (feature level 102),

when the new create_private_stream_policy and create_public_stream_policy properties introduced the possibility that a user could only create one type of channel.

This field will be removed in a future release.

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

Gets the Response can_create_public_streams.

Whether the current user is allowed to create public channels with the organization’s channel creation policy.

Present if realm_user is present in fetch_event_types.

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

In older versions, the deprecated can_create_streams property should be used to determine whether the user can create public channels.

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

Sets the Response can_create_public_streams.

Whether the current user is allowed to create public channels with the organization’s channel creation policy.

Present if realm_user is present in fetch_event_types.

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

In older versions, the deprecated can_create_streams property should be used to determine whether the user can create public channels.

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

Unsets the Response can_create_public_streams.

Whether the current user is allowed to create public channels with the organization’s channel creation policy.

Present if realm_user is present in fetch_event_types.

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

In older versions, the deprecated can_create_streams property should be used to determine whether the user can create public channels.

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

Builder function that sets the Response can_create_public_streams.

Whether the current user is allowed to create public channels with the organization’s channel creation policy.

Present if realm_user is present in fetch_event_types.

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

In older versions, the deprecated can_create_streams property should be used to determine whether the user can create public channels.

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

Gets the Response can_create_private_streams.

Whether the current user is allowed to create private channels with the organization’s channel creation policy.

Present if realm_user is present in fetch_event_types.

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

In older versions, the deprecated can_create_streams property should be used to determine whether the user can create private channels.

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

Sets the Response can_create_private_streams.

Whether the current user is allowed to create private channels with the organization’s channel creation policy.

Present if realm_user is present in fetch_event_types.

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

In older versions, the deprecated can_create_streams property should be used to determine whether the user can create private channels.

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

Unsets the Response can_create_private_streams.

Whether the current user is allowed to create private channels with the organization’s channel creation policy.

Present if realm_user is present in fetch_event_types.

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

In older versions, the deprecated can_create_streams property should be used to determine whether the user can create private channels.

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

Builder function that sets the Response can_create_private_streams.

Whether the current user is allowed to create private channels with the organization’s channel creation policy.

Present if realm_user is present in fetch_event_types.

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

In older versions, the deprecated can_create_streams property should be used to determine whether the user can create private channels.

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

Gets the Response can_create_web_public_streams.

Whether the current user is allowed to create public channels with the organization’s channel creation policy.

Present if realm_user is present in fetch_event_types.

Note that this will be false if the Zulip server does not have the WEB_PUBLIC_STREAMS_ENABLED setting enabled or if the organization has not enabled the enable_spectator_access realm setting.

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

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

Sets the Response can_create_web_public_streams.

Whether the current user is allowed to create public channels with the organization’s channel creation policy.

Present if realm_user is present in fetch_event_types.

Note that this will be false if the Zulip server does not have the WEB_PUBLIC_STREAMS_ENABLED setting enabled or if the organization has not enabled the enable_spectator_access realm setting.

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

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

Unsets the Response can_create_web_public_streams.

Whether the current user is allowed to create public channels with the organization’s channel creation policy.

Present if realm_user is present in fetch_event_types.

Note that this will be false if the Zulip server does not have the WEB_PUBLIC_STREAMS_ENABLED setting enabled or if the organization has not enabled the enable_spectator_access realm setting.

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

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

Builder function that sets the Response can_create_web_public_streams.

Whether the current user is allowed to create public channels with the organization’s channel creation policy.

Present if realm_user is present in fetch_event_types.

Note that this will be false if the Zulip server does not have the WEB_PUBLIC_STREAMS_ENABLED setting enabled or if the organization has not enabled the enable_spectator_access realm setting.

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

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

Gets the Response can_subscribe_other_users.

Whether the current user is allowed to subscribe other users to channels with the organization’s channels policy.

Present if realm_user is present in fetch_event_types.

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

Sets the Response can_subscribe_other_users.

Whether the current user is allowed to subscribe other users to channels with the organization’s channels policy.

Present if realm_user is present in fetch_event_types.

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

Unsets the Response can_subscribe_other_users.

Whether the current user is allowed to subscribe other users to channels with the organization’s channels policy.

Present if realm_user is present in fetch_event_types.

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

Builder function that sets the Response can_subscribe_other_users.

Whether the current user is allowed to subscribe other users to channels with the organization’s channels policy.

Present if realm_user is present in fetch_event_types.

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

Gets the Response can_invite_others_to_realm.

Whether the current user is allowed to invite others to the organization.

Present if realm_user is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 51).

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

Sets the Response can_invite_others_to_realm.

Whether the current user is allowed to invite others to the organization.

Present if realm_user is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 51).

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

Unsets the Response can_invite_others_to_realm.

Whether the current user is allowed to invite others to the organization.

Present if realm_user is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 51).

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

Builder function that sets the Response can_invite_others_to_realm.

Whether the current user is allowed to invite others to the organization.

Present if realm_user is present in fetch_event_types.

Changes: New in Zulip 4.0 (feature level 51).

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

Gets the Response is_admin.

Whether the current user is at least an organization administrator.

Present if realm_user is present in fetch_event_types.

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

Sets the Response is_admin.

Whether the current user is at least an organization administrator.

Present if realm_user is present in fetch_event_types.

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

Unsets the Response is_admin.

Whether the current user is at least an organization administrator.

Present if realm_user is present in fetch_event_types.

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

Builder function that sets the Response is_admin.

Whether the current user is at least an organization administrator.

Present if realm_user is present in fetch_event_types.

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

Gets the Response is_owner.

Whether the current user is an organization owner.

Present if realm_user is present in fetch_event_types.

Changes: New in Zulip 3.0 (feature level 11).

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

Sets the Response is_owner.

Whether the current user is an organization owner.

Present if realm_user is present in fetch_event_types.

Changes: New in Zulip 3.0 (feature level 11).

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

Unsets the Response is_owner.

Whether the current user is an organization owner.

Present if realm_user is present in fetch_event_types.

Changes: New in Zulip 3.0 (feature level 11).

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

Builder function that sets the Response is_owner.

Whether the current user is an organization owner.

Present if realm_user is present in fetch_event_types.

Changes: New in Zulip 3.0 (feature level 11).

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

Gets the Response is_moderator.

Present if realm_user is present in fetch_event_types.

Whether the current user is at least an organization moderator.

Changes: Prior to Zulip 11.0 (feature level 380), this was only true for users whose role was exactly the moderator role.

New in Zulip 4.0 (feature level 60).

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

Sets the Response is_moderator.

Present if realm_user is present in fetch_event_types.

Whether the current user is at least an organization moderator.

Changes: Prior to Zulip 11.0 (feature level 380), this was only true for users whose role was exactly the moderator role.

New in Zulip 4.0 (feature level 60).

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

Unsets the Response is_moderator.

Present if realm_user is present in fetch_event_types.

Whether the current user is at least an organization moderator.

Changes: Prior to Zulip 11.0 (feature level 380), this was only true for users whose role was exactly the moderator role.

New in Zulip 4.0 (feature level 60).

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

Builder function that sets the Response is_moderator.

Present if realm_user is present in fetch_event_types.

Whether the current user is at least an organization moderator.

Changes: Prior to Zulip 11.0 (feature level 380), this was only true for users whose role was exactly the moderator role.

New in Zulip 4.0 (feature level 60).

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

Gets the Response is_guest.

Whether the current user is a guest user.

Present if realm_user is present in fetch_event_types.

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

Sets the Response is_guest.

Whether the current user is a guest user.

Present if realm_user is present in fetch_event_types.

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

Unsets the Response is_guest.

Whether the current user is a guest user.

Present if realm_user is present in fetch_event_types.

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

Builder function that sets the Response is_guest.

Whether the current user is a guest user.

Present if realm_user is present in fetch_event_types.

pub const fn user_id(&self) -> Option<i64>

Gets the Response user_id.

The unique ID for the current user.

Present if realm_user is present in fetch_event_types.

pub fn set_user_id(&mut self, val: i64)

Sets the Response user_id.

The unique ID for the current user.

Present if realm_user is present in fetch_event_types.

pub fn unset_user_id(&mut self) -> Option<i64>

Unsets the Response user_id.

The unique ID for the current user.

Present if realm_user is present in fetch_event_types.

pub fn with_user_id(self, val: i64) -> Self

Builder function that sets the Response user_id.

The unique ID for the current user.

Present if realm_user is present in fetch_event_types.

pub const fn max_bulk_new_subscription_messages(&self) -> Option<f64>

Gets the Response max_bulk_new_subscription_messages.

Maximum number of new subscribers for which the server will respect the send_new_subscription_messages parameter when adding subscribers to a channel.

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

pub fn set_max_bulk_new_subscription_messages(&mut self, val: f64)

Sets the Response max_bulk_new_subscription_messages.

Maximum number of new subscribers for which the server will respect the send_new_subscription_messages parameter when adding subscribers to a channel.

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

pub fn unset_max_bulk_new_subscription_messages(&mut self) -> Option<f64>

Unsets the Response max_bulk_new_subscription_messages.

Maximum number of new subscribers for which the server will respect the send_new_subscription_messages parameter when adding subscribers to a channel.

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

pub fn with_max_bulk_new_subscription_messages(self, val: f64) -> Self

Builder function that sets the Response max_bulk_new_subscription_messages.

Maximum number of new subscribers for which the server will respect the send_new_subscription_messages parameter when adding subscribers to a channel.

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

pub const fn realm_message_edit_history_visibility_policy( &self, ) -> Option<RealmMessageEditHistoryVisibilityPolicy>

Gets the Response realm_message_edit_history_visibility_policy.

What typesof message edit history are accessible to users via message edit history.

Present if realm is present in fetch_event_types.

• "all" = All edit history is visible.

• "moves" = Only moves are visible.

• "none" = No edit history is visible.

Changes: New in Zulip 10.0 (feature level 358), replacing the previous allow_edit_history boolean setting; true corresponds to all, and false to none.

pub fn set_realm_message_edit_history_visibility_policy( &mut self, val: RealmMessageEditHistoryVisibilityPolicy, )

Sets the Response realm_message_edit_history_visibility_policy.

What typesof message edit history are accessible to users via message edit history.

Present if realm is present in fetch_event_types.

• "all" = All edit history is visible.

• "moves" = Only moves are visible.

• "none" = No edit history is visible.

Changes: New in Zulip 10.0 (feature level 358), replacing the previous allow_edit_history boolean setting; true corresponds to all, and false to none.

pub fn unset_realm_message_edit_history_visibility_policy( &mut self, ) -> Option<RealmMessageEditHistoryVisibilityPolicy>

Unsets the Response realm_message_edit_history_visibility_policy.

What typesof message edit history are accessible to users via message edit history.

Present if realm is present in fetch_event_types.

• "all" = All edit history is visible.

• "moves" = Only moves are visible.

• "none" = No edit history is visible.

Changes: New in Zulip 10.0 (feature level 358), replacing the previous allow_edit_history boolean setting; true corresponds to all, and false to none.

pub fn with_realm_message_edit_history_visibility_policy( self, val: RealmMessageEditHistoryVisibilityPolicy, ) -> Self

Builder function that sets the Response realm_message_edit_history_visibility_policy.

What typesof message edit history are accessible to users via message edit history.

Present if realm is present in fetch_event_types.

• "all" = All edit history is visible.

• "moves" = Only moves are visible.

• "none" = No edit history is visible.

Changes: New in Zulip 10.0 (feature level 358), replacing the previous allow_edit_history boolean setting; true corresponds to all, and false to none.

impl Response

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

Gets the Response ignored_parameters_unsupported.

An array of any parameters sent in the request that are not

supported by the endpoint.

See error handling documentation for details on this and its change history.

ignored_params

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

Sets the Response ignored_parameters_unsupported.

An array of any parameters sent in the request that are not

supported by the endpoint.

See error handling documentation for details on this and its change history.

ignored_params

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

Unsets the Response ignored_parameters_unsupported.

An array of any parameters sent in the request that are not

supported by the endpoint.

See error handling documentation for details on this and its change history.

ignored_params

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

Builder function that sets the Response ignored_parameters_unsupported.

An array of any parameters sent in the request that are not

supported by the endpoint.

See error handling documentation for details on this and its change history.

ignored_params

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

Gets the Response queue_id.

The ID of the queue that has been allocated for your client.

Will be null only for unauthenticated access in realms that have enabled the public access option.

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

Sets the Response queue_id.

The ID of the queue that has been allocated for your client.

Will be null only for unauthenticated access in realms that have enabled the public access option.

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

Unsets the Response queue_id.

The ID of the queue that has been allocated for your client.

Will be null only for unauthenticated access in realms that have enabled the public access option.

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

Builder function that sets the Response queue_id.

The ID of the queue that has been allocated for your client.

Will be null only for unauthenticated access in realms that have enabled the public access option.

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

Gets the Response zulip_version.

The server’s version number.

This is often a release version number, like 2.1.7. But for a server running a version from Git,

it will be a Git reference to the commit, like 5.0-dev-1650-gc3fd37755f.

Changes: As of Zulip 3.0 (feature level 3), this is always present in the endpoint’s response. Previously, it was only present if event_types included zulip_version.

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

Sets the Response zulip_version.

The server’s version number.

This is often a release version number, like 2.1.7. But for a server running a version from Git,

it will be a Git reference to the commit, like 5.0-dev-1650-gc3fd37755f.

Changes: As of Zulip 3.0 (feature level 3), this is always present in the endpoint’s response. Previously, it was only present if event_types included zulip_version.

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

Unsets the Response zulip_version.

The server’s version number.

This is often a release version number, like 2.1.7. But for a server running a version from Git,

it will be a Git reference to the commit, like 5.0-dev-1650-gc3fd37755f.

Changes: As of Zulip 3.0 (feature level 3), this is always present in the endpoint’s response. Previously, it was only present if event_types included zulip_version.

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

Builder function that sets the Response zulip_version.

The server’s version number.

This is often a release version number, like 2.1.7. But for a server running a version from Git,

it will be a Git reference to the commit, like 5.0-dev-1650-gc3fd37755f.

Changes: As of Zulip 3.0 (feature level 3), this is always present in the endpoint’s response. Previously, it was only present if event_types included zulip_version.

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

Gets the Response zulip_merge_base.

The git merge-base between zulip_version and official branches in the public Zulip server and web app repository,

in the same format as zulip_version. This will equal zulip_version if the server is not running a fork of the Zulip server.

This will be \"\" if the server does not know its merge-base.

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

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

Sets the Response zulip_merge_base.

The git merge-base between zulip_version and official branches in the public Zulip server and web app repository,

in the same format as zulip_version. This will equal zulip_version if the server is not running a fork of the Zulip server.

This will be \"\" if the server does not know its merge-base.

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

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

Unsets the Response zulip_merge_base.

The git merge-base between zulip_version and official branches in the public Zulip server and web app repository,

in the same format as zulip_version. This will equal zulip_version if the server is not running a fork of the Zulip server.

This will be \"\" if the server does not know its merge-base.

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

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

Builder function that sets the Response zulip_merge_base.

The git merge-base between zulip_version and official branches in the public Zulip server and web app repository,

in the same format as zulip_version. This will equal zulip_version if the server is not running a fork of the Zulip server.

This will be \"\" if the server does not know its merge-base.

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

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

Gets the Response alert_words.

Present if alert_words is present in fetch_event_types.

An array of strings, each an alert word that the current user has configured.

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

Sets the Response alert_words.

Present if alert_words is present in fetch_event_types.

An array of strings, each an alert word that the current user has configured.

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

Unsets the Response alert_words.

Present if alert_words is present in fetch_event_types.

An array of strings, each an alert word that the current user has configured.

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

Builder function that sets the Response alert_words.

Present if alert_words is present in fetch_event_types.

An array of strings, each an alert word that the current user has configured.

pub fn custom_profile_fields(&self) -> Option<&[CustomProfileField]>

Gets the Response custom_profile_fields.

Present if custom_profile_fields is present in fetch_event_types.

An array of dictionaries where each dictionary contains the details of a single custom profile field that is available to users in this Zulip organization.

This must be combined with the custom profile field values on individual user objects to display users’ profiles.

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

Sets the Response custom_profile_fields.

Present if custom_profile_fields is present in fetch_event_types.

An array of dictionaries where each dictionary contains the details of a single custom profile field that is available to users in this Zulip organization.

This must be combined with the custom profile field values on individual user objects to display users’ profiles.

pub fn unset_custom_profile_fields(&mut self) -> Option<Vec<CustomProfileField>>

Unsets the Response custom_profile_fields.

Present if custom_profile_fields is present in fetch_event_types.

An array of dictionaries where each dictionary contains the details of a single custom profile field that is available to users in this Zulip organization.

This must be combined with the custom profile field values on individual user objects to display users’ profiles.

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

Builder function that sets the Response custom_profile_fields.

Present if custom_profile_fields is present in fetch_event_types.

An array of dictionaries where each dictionary contains the details of a single custom profile field that is available to users in this Zulip organization.

This must be combined with the custom profile field values on individual user objects to display users’ profiles.

pub fn drafts(&self) -> Option<&[Draft]>

Gets the Response drafts.

An array containing draft objects for the user.

These drafts are being stored on the backend for the purpose of syncing across devices.

This array will be empty if enable_drafts_synchronization is set to false.

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

Sets the Response drafts.

An array containing draft objects for the user.

These drafts are being stored on the backend for the purpose of syncing across devices.

This array will be empty if enable_drafts_synchronization is set to false.

pub fn unset_drafts(&mut self) -> Option<Vec<Draft>>

Unsets the Response drafts.

An array containing draft objects for the user.

These drafts are being stored on the backend for the purpose of syncing across devices.

This array will be empty if enable_drafts_synchronization is set to false.

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

Builder function that sets the Response drafts.

An array containing draft objects for the user.

These drafts are being stored on the backend for the purpose of syncing across devices.

This array will be empty if enable_drafts_synchronization is set to false.

pub fn onboarding_steps(&self) -> Option<&[OnboardingStep]>

Gets the Response onboarding_steps.

Present if onboarding_steps is present in fetch_event_types.

An array of dictionaries, where each dictionary contains details about a single onboarding step that should be shown to the user.

We expect that only official Zulip clients will interact with this data.

Changes: Before Zulip 8.0 (feature level 233), this array was named hotspots.

Prior to this feature level, one-time notice onboarding steps were not supported,

and the type field in these objects did not exist as all onboarding steps were implicitly hotspots.

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

Sets the Response onboarding_steps.

Present if onboarding_steps is present in fetch_event_types.

An array of dictionaries, where each dictionary contains details about a single onboarding step that should be shown to the user.

We expect that only official Zulip clients will interact with this data.

Changes: Before Zulip 8.0 (feature level 233), this array was named hotspots.

Prior to this feature level, one-time notice onboarding steps were not supported,

and the type field in these objects did not exist as all onboarding steps were implicitly hotspots.

pub fn unset_onboarding_steps(&mut self) -> Option<Vec<OnboardingStep>>

Unsets the Response onboarding_steps.

Present if onboarding_steps is present in fetch_event_types.

An array of dictionaries, where each dictionary contains details about a single onboarding step that should be shown to the user.

We expect that only official Zulip clients will interact with this data.

Changes: Before Zulip 8.0 (feature level 233), this array was named hotspots.

Prior to this feature level, one-time notice onboarding steps were not supported,

and the type field in these objects did not exist as all onboarding steps were implicitly hotspots.

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

Builder function that sets the Response onboarding_steps.

Present if onboarding_steps is present in fetch_event_types.

An array of dictionaries, where each dictionary contains details about a single onboarding step that should be shown to the user.

We expect that only official Zulip clients will interact with this data.

Changes: Before Zulip 8.0 (feature level 233), this array was named hotspots.

Prior to this feature level, one-time notice onboarding steps were not supported,

and the type field in these objects did not exist as all onboarding steps were implicitly hotspots.

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

Gets the Response navigation_tour_video_url.

Present if onboarding_steps is present in fetch_event_types.

URL of the navigation tour video to display to new users during onboarding. If null, the onboarding video experience is disabled.

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

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

Sets the Response navigation_tour_video_url.

Present if onboarding_steps is present in fetch_event_types.

URL of the navigation tour video to display to new users during onboarding. If null, the onboarding video experience is disabled.

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

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

Unsets the Response navigation_tour_video_url.

Present if onboarding_steps is present in fetch_event_types.

URL of the navigation tour video to display to new users during onboarding. If null, the onboarding video experience is disabled.

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

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

Builder function that sets the Response navigation_tour_video_url.

Present if onboarding_steps is present in fetch_event_types.

URL of the navigation tour video to display to new users during onboarding. If null, the onboarding video experience is disabled.

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

pub fn scheduled_messages(&self) -> Option<&[ScheduledMessage]>

Gets the Response scheduled_messages.

Present if scheduled_messages is present in fetch_event_types.

An array of all undelivered scheduled messages by the user.

Changes: New in Zulip 7.0 (feature level 179).

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

Sets the Response scheduled_messages.

Present if scheduled_messages is present in fetch_event_types.

An array of all undelivered scheduled messages by the user.

Changes: New in Zulip 7.0 (feature level 179).

pub fn unset_scheduled_messages(&mut self) -> Option<Vec<ScheduledMessage>>

Unsets the Response scheduled_messages.

Present if scheduled_messages is present in fetch_event_types.

An array of all undelivered scheduled messages by the user.

Changes: New in Zulip 7.0 (feature level 179).

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

Builder function that sets the Response scheduled_messages.

Present if scheduled_messages is present in fetch_event_types.

An array of all undelivered scheduled messages by the user.

Changes: New in Zulip 7.0 (feature level 179).

pub fn reminders(&self) -> Option<&[ScheduledMessage]>

Gets the Response reminders.

Present if reminders is present in fetch_event_types.

An array of all undelivered reminders scheduled by the user.

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

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

Sets the Response reminders.

Present if reminders is present in fetch_event_types.

An array of all undelivered reminders scheduled by the user.

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

pub fn unset_reminders(&mut self) -> Option<Vec<ScheduledMessage>>

Unsets the Response reminders.

Present if reminders is present in fetch_event_types.

An array of all undelivered reminders scheduled by the user.

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

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

Builder function that sets the Response reminders.

Present if reminders is present in fetch_event_types.

An array of all undelivered reminders scheduled by the user.

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

pub fn muted_topics(&self) -> Option<&[MutedTopic]>

Gets the Response muted_topics.

Present if muted_topics is present in fetch_event_types.

Array of tuples, where each tuple describes a muted topic.

The first element of the tuple is the channel name in which the topic has to be muted,

the second element is the topic name to be muted and the third element is an integer UNIX timestamp representing when the topic was muted.

Changes: Deprecated in Zulip 6.0 (feature level 134).

Starting with this version, muted_topics will only be present in the response if the user_topic object,

which generalizes and replaces this field, is not explicitly requested via fetch_event_types.

Before Zulip 3.0 (feature level 1), the muted_topics array objects were 2-item tuples and did not include the timestamp information for when the topic was muted.

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

Sets the Response muted_topics.

Present if muted_topics is present in fetch_event_types.

Array of tuples, where each tuple describes a muted topic.

The first element of the tuple is the channel name in which the topic has to be muted,

the second element is the topic name to be muted and the third element is an integer UNIX timestamp representing when the topic was muted.

Changes: Deprecated in Zulip 6.0 (feature level 134).

Starting with this version, muted_topics will only be present in the response if the user_topic object,

which generalizes and replaces this field, is not explicitly requested via fetch_event_types.

Before Zulip 3.0 (feature level 1), the muted_topics array objects were 2-item tuples and did not include the timestamp information for when the topic was muted.

pub fn unset_muted_topics(&mut self) -> Option<Vec<MutedTopic>>

Unsets the Response muted_topics.

Present if muted_topics is present in fetch_event_types.

Array of tuples, where each tuple describes a muted topic.

The first element of the tuple is the channel name in which the topic has to be muted,

the second element is the topic name to be muted and the third element is an integer UNIX timestamp representing when the topic was muted.

Changes: Deprecated in Zulip 6.0 (feature level 134).

Starting with this version, muted_topics will only be present in the response if the user_topic object,

which generalizes and replaces this field, is not explicitly requested via fetch_event_types.

Before Zulip 3.0 (feature level 1), the muted_topics array objects were 2-item tuples and did not include the timestamp information for when the topic was muted.

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

Builder function that sets the Response muted_topics.

Present if muted_topics is present in fetch_event_types.

Array of tuples, where each tuple describes a muted topic.

The first element of the tuple is the channel name in which the topic has to be muted,

the second element is the topic name to be muted and the third element is an integer UNIX timestamp representing when the topic was muted.

Changes: Deprecated in Zulip 6.0 (feature level 134).

Starting with this version, muted_topics will only be present in the response if the user_topic object,

which generalizes and replaces this field, is not explicitly requested via fetch_event_types.

Before Zulip 3.0 (feature level 1), the muted_topics array objects were 2-item tuples and did not include the timestamp information for when the topic was muted.

pub fn muted_users(&self) -> Option<&[MutedUser]>

Gets the Response muted_users.

Present if muted_users is present in fetch_event_types.

A list of dictionaries where each dictionary describes a MutedUser.

Changes: New in Zulip 4.0 (feature level 48).

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

Sets the Response muted_users.

Present if muted_users is present in fetch_event_types.

A list of dictionaries where each dictionary describes a MutedUser.

Changes: New in Zulip 4.0 (feature level 48).

pub fn unset_muted_users(&mut self) -> Option<Vec<MutedUser>>

Unsets the Response muted_users.

Present if muted_users is present in fetch_event_types.

A list of dictionaries where each dictionary describes a MutedUser.

Changes: New in Zulip 4.0 (feature level 48).

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

Builder function that sets the Response muted_users.

Present if muted_users is present in fetch_event_types.

A list of dictionaries where each dictionary describes a MutedUser.

Changes: New in Zulip 4.0 (feature level 48).

pub fn realm_domains(&self) -> Option<&[RealmDomain]>

Gets the Response realm_domains.

Present if realm_domains is present in fetch_event_types.

An array of dictionaries where each dictionary describes a domain within which users can join the organization without and invitation.

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

Sets the Response realm_domains.

Present if realm_domains is present in fetch_event_types.

An array of dictionaries where each dictionary describes a domain within which users can join the organization without and invitation.

pub fn unset_realm_domains(&mut self) -> Option<Vec<RealmDomain>>

Unsets the Response realm_domains.

Present if realm_domains is present in fetch_event_types.

An array of dictionaries where each dictionary describes a domain within which users can join the organization without and invitation.

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

Builder function that sets the Response realm_domains.

Present if realm_domains is present in fetch_event_types.

An array of dictionaries where each dictionary describes a domain within which users can join the organization without and invitation.

pub fn realm_linkifiers(&self) -> Option<&[RealmLinkifier]>

Gets the Response realm_linkifiers.

Present if realm_linkifiers is present in fetch_event_types.

An ordered array of objects where each object describes a single linkifier.

The order of the array reflects the order that each linkifier should be processed when linkifying messages and topics.

By default, new linkifiers are ordered last. This order can be modified with PATCH /realm/linkifiers.

Clients will receive an empty array unless the event queue is registered with the client capability {\"linkifier_url_template\": true}.

See client_capabilities parameter for how this can be specified.

Changes: Before Zulip 7.0 (feature level 176), the linkifier_url_template client capability was not required.

The requirement was added because linkifiers were updated to contain a URL template instead of a URL format string,

which was a not backwards-compatible change.

New in Zulip 4.0 (feature level 54). Clients can access this data for servers on earlier feature levels via the legacy realm_filters property.

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

Sets the Response realm_linkifiers.

Present if realm_linkifiers is present in fetch_event_types.

An ordered array of objects where each object describes a single linkifier.

The order of the array reflects the order that each linkifier should be processed when linkifying messages and topics.

By default, new linkifiers are ordered last. This order can be modified with PATCH /realm/linkifiers.

Clients will receive an empty array unless the event queue is registered with the client capability {\"linkifier_url_template\": true}.

See client_capabilities parameter for how this can be specified.

Changes: Before Zulip 7.0 (feature level 176), the linkifier_url_template client capability was not required.

The requirement was added because linkifiers were updated to contain a URL template instead of a URL format string,

which was a not backwards-compatible change.

New in Zulip 4.0 (feature level 54). Clients can access this data for servers on earlier feature levels via the legacy realm_filters property.

pub fn unset_realm_linkifiers(&mut self) -> Option<Vec<RealmLinkifier>>

Unsets the Response realm_linkifiers.

Present if realm_linkifiers is present in fetch_event_types.

An ordered array of objects where each object describes a single linkifier.

The order of the array reflects the order that each linkifier should be processed when linkifying messages and topics.

By default, new linkifiers are ordered last. This order can be modified with PATCH /realm/linkifiers.

Clients will receive an empty array unless the event queue is registered with the client capability {\"linkifier_url_template\": true}.

See client_capabilities parameter for how this can be specified.

Changes: Before Zulip 7.0 (feature level 176), the linkifier_url_template client capability was not required.

The requirement was added because linkifiers were updated to contain a URL template instead of a URL format string,

which was a not backwards-compatible change.

New in Zulip 4.0 (feature level 54). Clients can access this data for servers on earlier feature levels via the legacy realm_filters property.

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

Builder function that sets the Response realm_linkifiers.

Present if realm_linkifiers is present in fetch_event_types.

An ordered array of objects where each object describes a single linkifier.

The order of the array reflects the order that each linkifier should be processed when linkifying messages and topics.

By default, new linkifiers are ordered last. This order can be modified with PATCH /realm/linkifiers.

Clients will receive an empty array unless the event queue is registered with the client capability {\"linkifier_url_template\": true}.

See client_capabilities parameter for how this can be specified.

Changes: Before Zulip 7.0 (feature level 176), the linkifier_url_template client capability was not required.

The requirement was added because linkifiers were updated to contain a URL template instead of a URL format string,

which was a not backwards-compatible change.

New in Zulip 4.0 (feature level 54). Clients can access this data for servers on earlier feature levels via the legacy realm_filters property.

pub fn realm_filters(&self) -> Option<&[RealmFilter]>

Gets the Response realm_filters.

Legacy property for linkifiers.

Present if realm_filters is present in fetch_event_types.

When present, this is always an empty array.

Changes: Prior to Zulip 7.0 (feature level 176), this was an array of tuples, where each tuple described a linkifier.

The first element of the tuple was a string regex pattern which represented the pattern to be linkified on matching, for example \"#(?P<id>[123])\".

The second element was a URL format string that the pattern should be linkified with.

A URL format string for the above example would be \"https://realm.com/my_realm_filter/%(id)s\".

And the third element was the ID of the realm filter.

Deprecated in Zulip 4.0 (feature level 54), replaced by the realm_linkifiers key.

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

Sets the Response realm_filters.

Legacy property for linkifiers.

Present if realm_filters is present in fetch_event_types.

When present, this is always an empty array.

Changes: Prior to Zulip 7.0 (feature level 176), this was an array of tuples, where each tuple described a linkifier.

The first element of the tuple was a string regex pattern which represented the pattern to be linkified on matching, for example \"#(?P<id>[123])\".

The second element was a URL format string that the pattern should be linkified with.

A URL format string for the above example would be \"https://realm.com/my_realm_filter/%(id)s\".

And the third element was the ID of the realm filter.

Deprecated in Zulip 4.0 (feature level 54), replaced by the realm_linkifiers key.

pub fn unset_realm_filters(&mut self) -> Option<Vec<RealmFilter>>

Unsets the Response realm_filters.

Legacy property for linkifiers.

Present if realm_filters is present in fetch_event_types.

When present, this is always an empty array.

Changes: Prior to Zulip 7.0 (feature level 176), this was an array of tuples, where each tuple described a linkifier.

The first element of the tuple was a string regex pattern which represented the pattern to be linkified on matching, for example \"#(?P<id>[123])\".

The second element was a URL format string that the pattern should be linkified with.

A URL format string for the above example would be \"https://realm.com/my_realm_filter/%(id)s\".

And the third element was the ID of the realm filter.

Deprecated in Zulip 4.0 (feature level 54), replaced by the realm_linkifiers key.

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

Builder function that sets the Response realm_filters.

Legacy property for linkifiers.

Present if realm_filters is present in fetch_event_types.

When present, this is always an empty array.

Changes: Prior to Zulip 7.0 (feature level 176), this was an array of tuples, where each tuple described a linkifier.

The first element of the tuple was a string regex pattern which represented the pattern to be linkified on matching, for example \"#(?P<id>[123])\".

The second element was a URL format string that the pattern should be linkified with.

A URL format string for the above example would be \"https://realm.com/my_realm_filter/%(id)s\".

And the third element was the ID of the realm filter.

Deprecated in Zulip 4.0 (feature level 54), replaced by the realm_linkifiers key.

pub fn realm_playgrounds(&self) -> Option<&[RealmPlayground]>

Gets the Response realm_playgrounds.

Present if realm_playgrounds is present in fetch_event_types.

An array of dictionaries where each dictionary describes a code playground configured for this Zulip organization.

Changes: New in Zulip 4.0 (feature level 49).

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

Sets the Response realm_playgrounds.

Present if realm_playgrounds is present in fetch_event_types.

An array of dictionaries where each dictionary describes a code playground configured for this Zulip organization.

Changes: New in Zulip 4.0 (feature level 49).

pub fn unset_realm_playgrounds(&mut self) -> Option<Vec<RealmPlayground>>

Unsets the Response realm_playgrounds.

Present if realm_playgrounds is present in fetch_event_types.

An array of dictionaries where each dictionary describes a code playground configured for this Zulip organization.

Changes: New in Zulip 4.0 (feature level 49).

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

Builder function that sets the Response realm_playgrounds.

Present if realm_playgrounds is present in fetch_event_types.

An array of dictionaries where each dictionary describes a code playground configured for this Zulip organization.

Changes: New in Zulip 4.0 (feature level 49).

pub fn realm_user_groups(&self) -> Option<&[UserGroup]>

Gets the Response realm_user_groups.

Present if realm_user_groups is present in fetch_event_types.

An array of dictionaries where each dictionary describes a user group in the Zulip organization.

Deactivated groups will only be included if include_deactivated_groups client capability is set to true.

Changes: Prior to Zulip 10.0 (feature level 294), deactivated groups were included for all the clients.

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

Sets the Response realm_user_groups.

Present if realm_user_groups is present in fetch_event_types.

An array of dictionaries where each dictionary describes a user group in the Zulip organization.

Deactivated groups will only be included if include_deactivated_groups client capability is set to true.

Changes: Prior to Zulip 10.0 (feature level 294), deactivated groups were included for all the clients.

pub fn unset_realm_user_groups(&mut self) -> Option<Vec<UserGroup>>

Unsets the Response realm_user_groups.

Present if realm_user_groups is present in fetch_event_types.

An array of dictionaries where each dictionary describes a user group in the Zulip organization.

Deactivated groups will only be included if include_deactivated_groups client capability is set to true.

Changes: Prior to Zulip 10.0 (feature level 294), deactivated groups were included for all the clients.

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

Builder function that sets the Response realm_user_groups.

Present if realm_user_groups is present in fetch_event_types.

An array of dictionaries where each dictionary describes a user group in the Zulip organization.

Deactivated groups will only be included if include_deactivated_groups client capability is set to true.

Changes: Prior to Zulip 10.0 (feature level 294), deactivated groups were included for all the clients.

pub fn realm_bots(&self) -> Option<&[Bot]>

Gets the Response realm_bots.

Present if realm_bot is present in fetch_event_types.

An array of dictionaries where each dictionary describes a bot that the current user can administer.

If the current user is an organization administrator, this will include all bots in the organization.

Otherwise, it will only include bots owned by the user (either because the user created the bot or an administrator transferred the bot’s ownership to the user).

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

Sets the Response realm_bots.

Present if realm_bot is present in fetch_event_types.

An array of dictionaries where each dictionary describes a bot that the current user can administer.

If the current user is an organization administrator, this will include all bots in the organization.

Otherwise, it will only include bots owned by the user (either because the user created the bot or an administrator transferred the bot’s ownership to the user).

pub fn unset_realm_bots(&mut self) -> Option<Vec<Bot>>

Unsets the Response realm_bots.

Present if realm_bot is present in fetch_event_types.

An array of dictionaries where each dictionary describes a bot that the current user can administer.

If the current user is an organization administrator, this will include all bots in the organization.

Otherwise, it will only include bots owned by the user (either because the user created the bot or an administrator transferred the bot’s ownership to the user).

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

Builder function that sets the Response realm_bots.

Present if realm_bot is present in fetch_event_types.

An array of dictionaries where each dictionary describes a bot that the current user can administer.

If the current user is an organization administrator, this will include all bots in the organization.

Otherwise, it will only include bots owned by the user (either because the user created the bot or an administrator transferred the bot’s ownership to the user).

pub fn realm_embedded_bots(&self) -> Option<&[RealmEmbeddedBot]>

Gets the Response realm_embedded_bots.

Present if realm_embedded_bots is present in fetch_event_types.

An array of dictionaries where each dictionary describes an type of embedded bot that is available to be configured on this Zulip server.

Clients only need these data if they contain UI for creating or administering bots.

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

Sets the Response realm_embedded_bots.

Present if realm_embedded_bots is present in fetch_event_types.

An array of dictionaries where each dictionary describes an type of embedded bot that is available to be configured on this Zulip server.

Clients only need these data if they contain UI for creating or administering bots.

pub fn unset_realm_embedded_bots(&mut self) -> Option<Vec<RealmEmbeddedBot>>

Unsets the Response realm_embedded_bots.

Present if realm_embedded_bots is present in fetch_event_types.

An array of dictionaries where each dictionary describes an type of embedded bot that is available to be configured on this Zulip server.

Clients only need these data if they contain UI for creating or administering bots.

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

Builder function that sets the Response realm_embedded_bots.

Present if realm_embedded_bots is present in fetch_event_types.

An array of dictionaries where each dictionary describes an type of embedded bot that is available to be configured on this Zulip server.

Clients only need these data if they contain UI for creating or administering bots.

pub fn realm_incoming_webhook_bots(&self) -> Option<&[RealmIncomingWebhookBot]>

Gets the Response realm_incoming_webhook_bots.

Present if realm_incoming_webhook_bots is present in fetch_event_types.

An array of dictionaries where each dictionary describes a type of incoming webhook integration that is available to be configured on this Zulip server.

Clients only need these data if they contain UI for creating or administering bots.

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

Sets the Response realm_incoming_webhook_bots.

Present if realm_incoming_webhook_bots is present in fetch_event_types.

An array of dictionaries where each dictionary describes a type of incoming webhook integration that is available to be configured on this Zulip server.

Clients only need these data if they contain UI for creating or administering bots.

pub fn unset_realm_incoming_webhook_bots( &mut self, ) -> Option<Vec<RealmIncomingWebhookBot>>

Unsets the Response realm_incoming_webhook_bots.

Present if realm_incoming_webhook_bots is present in fetch_event_types.

An array of dictionaries where each dictionary describes a type of incoming webhook integration that is available to be configured on this Zulip server.

Clients only need these data if they contain UI for creating or administering bots.

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

Builder function that sets the Response realm_incoming_webhook_bots.

Present if realm_incoming_webhook_bots is present in fetch_event_types.

An array of dictionaries where each dictionary describes a type of incoming webhook integration that is available to be configured on this Zulip server.

Clients only need these data if they contain UI for creating or administering bots.

pub fn navigation_views(&self) -> Option<&[NavigationView]>

Gets the Response navigation_views.

Present if recent_private_conversations is present in fetch_event_types.

An array of dictionaries containing data on all direct message and group direct message conversations that the user has received (or sent) messages in, organized by conversation.

This data set is designed to support UI elements such as the "Direct messages" widget in the web application showing recent direct message conversations that the user has participated in.

"Recent" is defined as the server’s discretion; the original implementation interpreted that as "the 1000 most recent direct messages the user received".

Present if navigation_views is present in fetch_event_types. An array of dictionaries containing data on all of the current user’s navigation views.

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

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

Sets the Response navigation_views.

Present if recent_private_conversations is present in fetch_event_types.

An array of dictionaries containing data on all direct message and group direct message conversations that the user has received (or sent) messages in, organized by conversation.

This data set is designed to support UI elements such as the "Direct messages" widget in the web application showing recent direct message conversations that the user has participated in.

"Recent" is defined as the server’s discretion; the original implementation interpreted that as "the 1000 most recent direct messages the user received".

Present if navigation_views is present in fetch_event_types. An array of dictionaries containing data on all of the current user’s navigation views.

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

pub fn unset_navigation_views(&mut self) -> Option<Vec<NavigationView>>

Unsets the Response navigation_views.

Present if recent_private_conversations is present in fetch_event_types.

An array of dictionaries containing data on all direct message and group direct message conversations that the user has received (or sent) messages in, organized by conversation.

This data set is designed to support UI elements such as the "Direct messages" widget in the web application showing recent direct message conversations that the user has participated in.

"Recent" is defined as the server’s discretion; the original implementation interpreted that as "the 1000 most recent direct messages the user received".

Present if navigation_views is present in fetch_event_types. An array of dictionaries containing data on all of the current user’s navigation views.

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

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

Builder function that sets the Response navigation_views.

Present if recent_private_conversations is present in fetch_event_types.

An array of dictionaries containing data on all direct message and group direct message conversations that the user has received (or sent) messages in, organized by conversation.

This data set is designed to support UI elements such as the "Direct messages" widget in the web application showing recent direct message conversations that the user has participated in.

"Recent" is defined as the server’s discretion; the original implementation interpreted that as "the 1000 most recent direct messages the user received".

Present if navigation_views is present in fetch_event_types. An array of dictionaries containing data on all of the current user’s navigation views.

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

pub fn saved_snippets(&self) -> Option<&[SavedSnippet]>

Gets the Response saved_snippets.

Present if saved_snippets is present in fetch_event_types.

An array of dictionaries containing data on all of the current user’s saved snippets.

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

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

Sets the Response saved_snippets.

Present if saved_snippets is present in fetch_event_types.

An array of dictionaries containing data on all of the current user’s saved snippets.

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

pub fn unset_saved_snippets(&mut self) -> Option<Vec<SavedSnippet>>

Unsets the Response saved_snippets.

Present if saved_snippets is present in fetch_event_types.

An array of dictionaries containing data on all of the current user’s saved snippets.

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

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

Builder function that sets the Response saved_snippets.

Present if saved_snippets is present in fetch_event_types.

An array of dictionaries containing data on all of the current user’s saved snippets.

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

pub fn subscriptions(&self) -> Option<&[Subscription]>

Gets the Response subscriptions.

Present if subscription is present in fetch_event_types.

An array of dictionaries where each dictionary describes the properties of a channel the user is subscribed to (as well as that user’s personal per-channel settings).

Changes: Removed email_address field from the dictionary in Zulip 8.0 (feature level 226).

Removed role field from the dictionary in Zulip 6.0 (feature level 133).

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

Sets the Response subscriptions.

Present if subscription is present in fetch_event_types.

An array of dictionaries where each dictionary describes the properties of a channel the user is subscribed to (as well as that user’s personal per-channel settings).

Changes: Removed email_address field from the dictionary in Zulip 8.0 (feature level 226).

Removed role field from the dictionary in Zulip 6.0 (feature level 133).

pub fn unset_subscriptions(&mut self) -> Option<Vec<Subscription>>

Unsets the Response subscriptions.

Present if subscription is present in fetch_event_types.

An array of dictionaries where each dictionary describes the properties of a channel the user is subscribed to (as well as that user’s personal per-channel settings).

Changes: Removed email_address field from the dictionary in Zulip 8.0 (feature level 226).

Removed role field from the dictionary in Zulip 6.0 (feature level 133).

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

Builder function that sets the Response subscriptions.

Present if subscription is present in fetch_event_types.

An array of dictionaries where each dictionary describes the properties of a channel the user is subscribed to (as well as that user’s personal per-channel settings).

Changes: Removed email_address field from the dictionary in Zulip 8.0 (feature level 226).

Removed role field from the dictionary in Zulip 6.0 (feature level 133).

pub fn unsubscribed(&self) -> Option<&[Subscription]>

Gets the Response unsubscribed.

Present if subscription is present in fetch_event_types.

A array of dictionaries where each dictionary describes one of the channels the user has unsubscribed from but was previously subscribed to along with the subscription details.

Unlike never_subscribed, the user might have messages in their personal message history that were sent to these channels.

Changes: Prior to Zulip 10.0 (feature level 349), if a user was in can_administer_channel_group of a channel that they had unsubscribed from,

but not an organization administrator, the channel in question would not be part of this array.

Removed email_address field from the dictionary in Zulip 8.0 (feature level 226). Removed role field from the dictionary in Zulip 6.0 (feature level 133).

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

Sets the Response unsubscribed.

Present if subscription is present in fetch_event_types.

A array of dictionaries where each dictionary describes one of the channels the user has unsubscribed from but was previously subscribed to along with the subscription details.

Unlike never_subscribed, the user might have messages in their personal message history that were sent to these channels.

Changes: Prior to Zulip 10.0 (feature level 349), if a user was in can_administer_channel_group of a channel that they had unsubscribed from,

but not an organization administrator, the channel in question would not be part of this array.

Removed email_address field from the dictionary in Zulip 8.0 (feature level 226). Removed role field from the dictionary in Zulip 6.0 (feature level 133).

pub fn unset_unsubscribed(&mut self) -> Option<Vec<Subscription>>

Unsets the Response unsubscribed.

Present if subscription is present in fetch_event_types.

A array of dictionaries where each dictionary describes one of the channels the user has unsubscribed from but was previously subscribed to along with the subscription details.

Unlike never_subscribed, the user might have messages in their personal message history that were sent to these channels.

Changes: Prior to Zulip 10.0 (feature level 349), if a user was in can_administer_channel_group of a channel that they had unsubscribed from,

but not an organization administrator, the channel in question would not be part of this array.

Removed email_address field from the dictionary in Zulip 8.0 (feature level 226). Removed role field from the dictionary in Zulip 6.0 (feature level 133).

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

Builder function that sets the Response unsubscribed.

Present if subscription is present in fetch_event_types.

A array of dictionaries where each dictionary describes one of the channels the user has unsubscribed from but was previously subscribed to along with the subscription details.

Unlike never_subscribed, the user might have messages in their personal message history that were sent to these channels.

Changes: Prior to Zulip 10.0 (feature level 349), if a user was in can_administer_channel_group of a channel that they had unsubscribed from,

but not an organization administrator, the channel in question would not be part of this array.

Removed email_address field from the dictionary in Zulip 8.0 (feature level 226). Removed role field from the dictionary in Zulip 6.0 (feature level 133).

pub fn never_subscribed(&self) -> Option<&[NeverSubscribed]>

Gets the Response never_subscribed.

Present if subscription is present in fetch_event_types.

A array of dictionaries where each dictionary describes one of the channels that is visible to the user and the user has never been subscribed to.

Important for clients containing UI where one can browse channels to subscribe to.

Changes: Before Zulip 10.0 (feature level 362),

archived channels did not appear in this list,

even if the archived_channels client capability was declared by the client.

Prior to Zulip 10.0 (feature level 349), if a user was in can_administer_channel_group of a channel that they never subscribed to,

but not an organization administrator, the channel in question would not be part of this array.

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

Sets the Response never_subscribed.

Present if subscription is present in fetch_event_types.

A array of dictionaries where each dictionary describes one of the channels that is visible to the user and the user has never been subscribed to.

Important for clients containing UI where one can browse channels to subscribe to.

Changes: Before Zulip 10.0 (feature level 362),

archived channels did not appear in this list,

even if the archived_channels client capability was declared by the client.

Prior to Zulip 10.0 (feature level 349), if a user was in can_administer_channel_group of a channel that they never subscribed to,

but not an organization administrator, the channel in question would not be part of this array.

pub fn unset_never_subscribed(&mut self) -> Option<Vec<NeverSubscribed>>

Unsets the Response never_subscribed.

Present if subscription is present in fetch_event_types.

A array of dictionaries where each dictionary describes one of the channels that is visible to the user and the user has never been subscribed to.

Important for clients containing UI where one can browse channels to subscribe to.

Changes: Before Zulip 10.0 (feature level 362),

archived channels did not appear in this list,

even if the archived_channels client capability was declared by the client.

Prior to Zulip 10.0 (feature level 349), if a user was in can_administer_channel_group of a channel that they never subscribed to,

but not an organization administrator, the channel in question would not be part of this array.

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

Builder function that sets the Response never_subscribed.

Present if subscription is present in fetch_event_types.

A array of dictionaries where each dictionary describes one of the channels that is visible to the user and the user has never been subscribed to.

Important for clients containing UI where one can browse channels to subscribe to.

Changes: Before Zulip 10.0 (feature level 362),

archived channels did not appear in this list,

even if the archived_channels client capability was declared by the client.

Prior to Zulip 10.0 (feature level 349), if a user was in can_administer_channel_group of a channel that they never subscribed to,

but not an organization administrator, the channel in question would not be part of this array.

pub fn channel_folders(&self) -> Option<&[ChannelFolder]>

Gets the Response channel_folders.

Present if channel_folders is present in fetch_event_types.

An array of dictionaries where each dictionary describes one of the channel folders in the organization.

Only channel folders with one or more public web channels are visible to spectators.

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

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

Sets the Response channel_folders.

Present if channel_folders is present in fetch_event_types.

An array of dictionaries where each dictionary describes one of the channel folders in the organization.

Only channel folders with one or more public web channels are visible to spectators.

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

pub fn unset_channel_folders(&mut self) -> Option<Vec<ChannelFolder>>

Unsets the Response channel_folders.

Present if channel_folders is present in fetch_event_types.

An array of dictionaries where each dictionary describes one of the channel folders in the organization.

Only channel folders with one or more public web channels are visible to spectators.

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

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

Builder function that sets the Response channel_folders.

Present if channel_folders is present in fetch_event_types.

An array of dictionaries where each dictionary describes one of the channel folders in the organization.

Only channel folders with one or more public web channels are visible to spectators.

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

pub fn starred_messages(&self) -> Option<&[i64]>

Gets the Response starred_messages.

Present if starred_messages is present in fetch_event_types. Array containing the IDs of all messages which have been starred by the user.

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

Sets the Response starred_messages.

Present if starred_messages is present in fetch_event_types. Array containing the IDs of all messages which have been starred by the user.

pub fn unset_starred_messages(&mut self) -> Option<Vec<i64>>

Unsets the Response starred_messages.

Present if starred_messages is present in fetch_event_types. Array containing the IDs of all messages which have been starred by the user.

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

Builder function that sets the Response starred_messages.

Present if starred_messages is present in fetch_event_types. Array containing the IDs of all messages which have been starred by the user.

pub fn streams(&self) -> Option<&[BasicChannel]>

Gets the Response streams.

Present if stream is present in fetch_event_types.

Array of dictionaries where each dictionary contains details about a single channel in the organization that is visible to the user.

For organization administrators, this will include all private channels in the organization.

Changes: Before Zulip 11.0 (feature level 378),

archived channels did not appear in this list,

even if the archived_channels client capability was declared by the client.

As of Zulip 8.0 (feature level 205), this will include all web-public channels in the organization as well.

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

Sets the Response streams.

Present if stream is present in fetch_event_types.

Array of dictionaries where each dictionary contains details about a single channel in the organization that is visible to the user.

For organization administrators, this will include all private channels in the organization.

Changes: Before Zulip 11.0 (feature level 378),

archived channels did not appear in this list,

even if the archived_channels client capability was declared by the client.

As of Zulip 8.0 (feature level 205), this will include all web-public channels in the organization as well.

pub fn unset_streams(&mut self) -> Option<Vec<BasicChannel>>

Unsets the Response streams.

Present if stream is present in fetch_event_types.

Array of dictionaries where each dictionary contains details about a single channel in the organization that is visible to the user.

For organization administrators, this will include all private channels in the organization.

Changes: Before Zulip 11.0 (feature level 378),

archived channels did not appear in this list,

even if the archived_channels client capability was declared by the client.

As of Zulip 8.0 (feature level 205), this will include all web-public channels in the organization as well.

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

Builder function that sets the Response streams.

Present if stream is present in fetch_event_types.

Array of dictionaries where each dictionary contains details about a single channel in the organization that is visible to the user.

For organization administrators, this will include all private channels in the organization.

Changes: Before Zulip 11.0 (feature level 378),

archived channels did not appear in this list,

even if the archived_channels client capability was declared by the client.

As of Zulip 8.0 (feature level 205), this will include all web-public channels in the organization as well.

pub fn realm_default_streams(&self) -> Option<&[i64]>

Gets the Response realm_default_streams.

An array of IDs of all the default channels in the organization.

Present if default_streams is present in fetch_event_types.

Changes: Before Zulip 10.0 (feature level 330), we sent array of dictionaries where each dictionary contained details about a single default stream for the Zulip organization.

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

Sets the Response realm_default_streams.

An array of IDs of all the default channels in the organization.

Present if default_streams is present in fetch_event_types.

Changes: Before Zulip 10.0 (feature level 330), we sent array of dictionaries where each dictionary contained details about a single default stream for the Zulip organization.

pub fn unset_realm_default_streams(&mut self) -> Option<Vec<i64>>

Unsets the Response realm_default_streams.

An array of IDs of all the default channels in the organization.

Present if default_streams is present in fetch_event_types.

Changes: Before Zulip 10.0 (feature level 330), we sent array of dictionaries where each dictionary contained details about a single default stream for the Zulip organization.

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

Builder function that sets the Response realm_default_streams.

An array of IDs of all the default channels in the organization.

Present if default_streams is present in fetch_event_types.

Changes: Before Zulip 10.0 (feature level 330), we sent array of dictionaries where each dictionary contained details about a single default stream for the Zulip organization.

pub fn realm_default_stream_groups(&self) -> Option<&[DefaultChannelGroup]>

Gets the Response realm_default_stream_groups.

An array of dictionaries where each dictionary contains details about a single default channel group configured for this Zulip organization.

Present if default_stream_groups is present in fetch_event_types.

Default channel groups are an experimental feature.

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

Sets the Response realm_default_stream_groups.

An array of dictionaries where each dictionary contains details about a single default channel group configured for this Zulip organization.

Present if default_stream_groups is present in fetch_event_types.

Default channel groups are an experimental feature.

pub fn unset_realm_default_stream_groups( &mut self, ) -> Option<Vec<DefaultChannelGroup>>

Unsets the Response realm_default_stream_groups.

An array of dictionaries where each dictionary contains details about a single default channel group configured for this Zulip organization.

Present if default_stream_groups is present in fetch_event_types.

Default channel groups are an experimental feature.

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

Builder function that sets the Response realm_default_stream_groups.

An array of dictionaries where each dictionary contains details about a single default channel group configured for this Zulip organization.

Present if default_stream_groups is present in fetch_event_types.

Default channel groups are an experimental feature.

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

Gets the Response stop_words.

An array containing the stop words used by the Zulip server’s full-text search implementation.

Present if stop_words is present in fetch_event_types.

Useful for showing helpful error messages when a search returns limited results because a stop word in the query was ignored.

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

Sets the Response stop_words.

An array containing the stop words used by the Zulip server’s full-text search implementation.

Present if stop_words is present in fetch_event_types.

Useful for showing helpful error messages when a search returns limited results because a stop word in the query was ignored.

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

Unsets the Response stop_words.

An array containing the stop words used by the Zulip server’s full-text search implementation.

Present if stop_words is present in fetch_event_types.

Useful for showing helpful error messages when a search returns limited results because a stop word in the query was ignored.

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

Builder function that sets the Response stop_words.

An array containing the stop words used by the Zulip server’s full-text search implementation.

Present if stop_words is present in fetch_event_types.

Useful for showing helpful error messages when a search returns limited results because a stop word in the query was ignored.

pub fn user_topics(&self) -> Option<&[UserTopic]>

Gets the Response user_topics.

Present if user_topic is present in fetch_event_types.

Changes: New in Zulip 6.0 (feature level 134), deprecating and replacing the previous muted_topics structure.

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

Sets the Response user_topics.

Present if user_topic is present in fetch_event_types.

Changes: New in Zulip 6.0 (feature level 134), deprecating and replacing the previous muted_topics structure.

pub fn unset_user_topics(&mut self) -> Option<Vec<UserTopic>>

Unsets the Response user_topics.

Present if user_topic is present in fetch_event_types.

Changes: New in Zulip 6.0 (feature level 134), deprecating and replacing the previous muted_topics structure.

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

Builder function that sets the Response user_topics.

Present if user_topic is present in fetch_event_types.

Changes: New in Zulip 6.0 (feature level 134), deprecating and replacing the previous muted_topics structure.

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

Gets the Response giphy_api_key.

GIPHY’s client-side SDKs needs this API key to use the GIPHY API.

Present if giphy is present in fetch_event_types.

GIPHY API keys are not secret (their main purpose appears to be allowing GIPHY to block a problematic app).

Please don’t use our API key for an app unrelated to Zulip.

Developers of clients should also read the GIPHY API TOS before using this API key.

Changes: Added in Zulip 4.0 (feature level 47).

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

Sets the Response giphy_api_key.

GIPHY’s client-side SDKs needs this API key to use the GIPHY API.

Present if giphy is present in fetch_event_types.

GIPHY API keys are not secret (their main purpose appears to be allowing GIPHY to block a problematic app).

Please don’t use our API key for an app unrelated to Zulip.

Developers of clients should also read the GIPHY API TOS before using this API key.

Changes: Added in Zulip 4.0 (feature level 47).

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

Unsets the Response giphy_api_key.

GIPHY’s client-side SDKs needs this API key to use the GIPHY API.

Present if giphy is present in fetch_event_types.

GIPHY API keys are not secret (their main purpose appears to be allowing GIPHY to block a problematic app).

Please don’t use our API key for an app unrelated to Zulip.

Developers of clients should also read the GIPHY API TOS before using this API key.

Changes: Added in Zulip 4.0 (feature level 47).

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

Builder function that sets the Response giphy_api_key.

GIPHY’s client-side SDKs needs this API key to use the GIPHY API.

Present if giphy is present in fetch_event_types.

GIPHY API keys are not secret (their main purpose appears to be allowing GIPHY to block a problematic app).

Please don’t use our API key for an app unrelated to Zulip.

Developers of clients should also read the GIPHY API TOS before using this API key.

Changes: Added in Zulip 4.0 (feature level 47).

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

Gets the Response notification_sound.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response notification_sound.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response notification_sound.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response notification_sound.

The current value of this global notification setting for the user.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response available_notification_sounds.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Only relevant to support UI for configuring notification sounds.

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response available_notification_sounds.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Only relevant to support UI for configuring notification sounds.

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response available_notification_sounds.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Only relevant to support UI for configuring notification sounds.

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response available_notification_sounds.

Present if update_global_notifications is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Only relevant to support UI for configuring notification sounds.

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response default_language.

The default language chosen by the user.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response default_language.

The default language chosen by the user.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response default_language.

The default language chosen by the user.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response default_language.

The default language chosen by the user.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response emojiset.

The name of the emoji set that the user has chosen.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response emojiset.

The name of the emoji set that the user has chosen.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response emojiset.

The name of the emoji set that the user has chosen.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response emojiset.

The name of the emoji set that the user has chosen.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response web_home_view.

The home view in Zulip, represented as the URL suffix after # to be rendered when Zulip loads.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

Currently supported values are all_messages and recent_topics.

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

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

Previously, this was called default_view, which was new in Zulip 4.0 (feature level 42).

Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response web_home_view.

The home view in Zulip, represented as the URL suffix after # to be rendered when Zulip loads.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

Currently supported values are all_messages and recent_topics.

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

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

Previously, this was called default_view, which was new in Zulip 4.0 (feature level 42).

Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response web_home_view.

The home view in Zulip, represented as the URL suffix after # to be rendered when Zulip loads.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

Currently supported values are all_messages and recent_topics.

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

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

Previously, this was called default_view, which was new in Zulip 4.0 (feature level 42).

Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response web_home_view.

The home view in Zulip, represented as the URL suffix after # to be rendered when Zulip loads.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

Currently supported values are all_messages and recent_topics.

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

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

Previously, this was called default_view, which was new in Zulip 4.0 (feature level 42).

Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response timezone.

The user’s profile time zone,

which is used primarily to display the user’s local time to other users.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response timezone.

The user’s profile time zone,

which is used primarily to display the user’s local time to other users.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response timezone.

The user’s profile time zone,

which is used primarily to display the user’s local time to other users.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response timezone.

The user’s profile time zone,

which is used primarily to display the user’s local time to other users.

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response emojiset_choices.

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

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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.

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Sets the Response emojiset_choices.

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

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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.

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Unsets the Response emojiset_choices.

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

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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.

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Builder function that sets the Response emojiset_choices.

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

Present if update_display_settings is present in fetch_event_types and only for clients that did not include user_settings_object

in their client_capabilities when registering the event queue.

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.

Changes: Deprecated in Zulip 5.0 (feature level 89).

Clients connecting to newer servers should declare the user_settings_object client capability and access the user_settings object instead.

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

Gets the Response realm_default_language.

The organization language for automated messages and invitation emails.

Present if realm is present in fetch_event_types.

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

Sets the Response realm_default_language.

The organization language for automated messages and invitation emails.

Present if realm is present in fetch_event_types.

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

Unsets the Response realm_default_language.

The organization language for automated messages and invitation emails.

Present if realm is present in fetch_event_types.

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

Builder function that sets the Response realm_default_language.

The organization language for automated messages and invitation emails.

Present if realm is present in fetch_event_types.

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

Gets the Response realm_welcome_message_custom_text.

This organization’s configured custom message for Welcome Bot to send to new user accounts, in Zulip Markdown format.

Present if realm is present in fetch_event_types.

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

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

Sets the Response realm_welcome_message_custom_text.

This organization’s configured custom message for Welcome Bot to send to new user accounts, in Zulip Markdown format.

Present if realm is present in fetch_event_types.

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

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

Unsets the Response realm_welcome_message_custom_text.

This organization’s configured custom message for Welcome Bot to send to new user accounts, in Zulip Markdown format.

Present if realm is present in fetch_event_types.

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

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

Builder function that sets the Response realm_welcome_message_custom_text.

This organization’s configured custom message for Welcome Bot to send to new user accounts, in Zulip Markdown format.

Present if realm is present in fetch_event_types.

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

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

Gets the Response realm_description.

Present if realm is present in fetch_event_types. The description of the organization, used on login and registration pages.

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

Sets the Response realm_description.

Present if realm is present in fetch_event_types. The description of the organization, used on login and registration pages.

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

Unsets the Response realm_description.

Present if realm is present in fetch_event_types. The description of the organization, used on login and registration pages.

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

Builder function that sets the Response realm_description.

Present if realm is present in fetch_event_types. The description of the organization, used on login and registration pages.

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

Gets the Response realm_name.

Present if realm is present in fetch_event_types. The name of the organization, used in login pages etc.

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

Sets the Response realm_name.

Present if realm is present in fetch_event_types. The name of the organization, used in login pages etc.

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

Unsets the Response realm_name.

Present if realm is present in fetch_event_types. The name of the organization, used in login pages etc.

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

Builder function that sets the Response realm_name.

Present if realm is present in fetch_event_types. The name of the organization, used in login pages etc.

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

Gets the Response realm_jitsi_server_url.

The URL of the custom Jitsi Meet server configured in this organization’s settings.

Present if realm is present in fetch_event_types.

null, the default, means that the organization is using the should use the server-level configuration, server_jitsi_server_url.

A correct client supporting only the modern API should use realm_jitsi_server_url || server_jitsi_server_url to create calls.

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

Previously, this was only available as a server-level configuration, which was available via the jitsi_server_url field.

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

Sets the Response realm_jitsi_server_url.

The URL of the custom Jitsi Meet server configured in this organization’s settings.

Present if realm is present in fetch_event_types.

null, the default, means that the organization is using the should use the server-level configuration, server_jitsi_server_url.

A correct client supporting only the modern API should use realm_jitsi_server_url || server_jitsi_server_url to create calls.

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

Previously, this was only available as a server-level configuration, which was available via the jitsi_server_url field.

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

Unsets the Response realm_jitsi_server_url.

The URL of the custom Jitsi Meet server configured in this organization’s settings.

Present if realm is present in fetch_event_types.

null, the default, means that the organization is using the should use the server-level configuration, server_jitsi_server_url.

A correct client supporting only the modern API should use realm_jitsi_server_url || server_jitsi_server_url to create calls.

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

Previously, this was only available as a server-level configuration, which was available via the jitsi_server_url field.

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

Builder function that sets the Response realm_jitsi_server_url.

The URL of the custom Jitsi Meet server configured in this organization’s settings.

Present if realm is present in fetch_event_types.

null, the default, means that the organization is using the should use the server-level configuration, server_jitsi_server_url.

A correct client supporting only the modern API should use realm_jitsi_server_url || server_jitsi_server_url to create calls.

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

Previously, this was only available as a server-level configuration, which was available via the jitsi_server_url field.

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

Gets the Response realm_default_code_block_language.

The default pygments language code to be used for code blocks in this organization.

Present if realm is present in fetch_event_types.

If an empty string, no default has been set.

Changes: Prior to Zulip 8.0 (feature level 195),

a server bug meant that both null and an empty string could represent that no default was set for this realm setting.

Clients supporting older server versions should treat either value (null or \"\") as no default being set.

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

Sets the Response realm_default_code_block_language.

The default pygments language code to be used for code blocks in this organization.

Present if realm is present in fetch_event_types.

If an empty string, no default has been set.

Changes: Prior to Zulip 8.0 (feature level 195),

a server bug meant that both null and an empty string could represent that no default was set for this realm setting.

Clients supporting older server versions should treat either value (null or \"\") as no default being set.

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

Unsets the Response realm_default_code_block_language.

The default pygments language code to be used for code blocks in this organization.

Present if realm is present in fetch_event_types.

If an empty string, no default has been set.

Changes: Prior to Zulip 8.0 (feature level 195),

a server bug meant that both null and an empty string could represent that no default was set for this realm setting.

Clients supporting older server versions should treat either value (null or \"\") as no default being set.

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

Builder function that sets the Response realm_default_code_block_language.

The default pygments language code to be used for code blocks in this organization.

Present if realm is present in fetch_event_types.

If an empty string, no default has been set.

Changes: Prior to Zulip 8.0 (feature level 195),

a server bug meant that both null and an empty string could represent that no default was set for this realm setting.

Clients supporting older server versions should treat either value (null or \"\") as no default being set.

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

Gets the Response realm_icon_url.

The URL of the organization’s profile icon.

Present if realm is present in fetch_event_types.

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

Sets the Response realm_icon_url.

The URL of the organization’s profile icon.

Present if realm is present in fetch_event_types.

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

Unsets the Response realm_icon_url.

The URL of the organization’s profile icon.

Present if realm is present in fetch_event_types.

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

Builder function that sets the Response realm_icon_url.

The URL of the organization’s profile icon.

Present if realm is present in fetch_event_types.

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

Gets the Response realm_icon_source.

String indicating whether the organization’s profile icon was uploaded by a user or is the default.

Present if realm is present in fetch_event_types.

Useful for UI allowing editing the organization’s icon.

• "G" means generated by Gravatar (the default).

• "U" means uploaded by an organization administrator.

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

Sets the Response realm_icon_source.

String indicating whether the organization’s profile icon was uploaded by a user or is the default.

Present if realm is present in fetch_event_types.

Useful for UI allowing editing the organization’s icon.

• "G" means generated by Gravatar (the default).

• "U" means uploaded by an organization administrator.

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

Unsets the Response realm_icon_source.

String indicating whether the organization’s profile icon was uploaded by a user or is the default.

Present if realm is present in fetch_event_types.

Useful for UI allowing editing the organization’s icon.

• "G" means generated by Gravatar (the default).

• "U" means uploaded by an organization administrator.

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

Builder function that sets the Response realm_icon_source.

String indicating whether the organization’s profile icon was uploaded by a user or is the default.

Present if realm is present in fetch_event_types.

Useful for UI allowing editing the organization’s icon.

• "G" means generated by Gravatar (the default).

• "U" means uploaded by an organization administrator.

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

Gets the Response realm_logo_url.

The URL of the organization’s wide logo configured in the organization profile.

Present if realm is present in fetch_event_types.

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

Sets the Response realm_logo_url.

The URL of the organization’s wide logo configured in the organization profile.

Present if realm is present in fetch_event_types.

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

Unsets the Response realm_logo_url.

The URL of the organization’s wide logo configured in the organization profile.

Present if realm is present in fetch_event_types.

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

Builder function that sets the Response realm_logo_url.

The URL of the organization’s wide logo configured in the organization profile.

Present if realm is present in fetch_event_types.

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

Gets the Response realm_logo_source.

String indicating whether the organization’s profile wide logo was uploaded by a user or is the default.

Present if realm is present in fetch_event_types.

Useful for UI allowing editing the organization’s wide logo.

• "D" means the logo is the default Zulip logo.

• "U" means uploaded by an organization administrator.

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

Sets the Response realm_logo_source.

String indicating whether the organization’s profile wide logo was uploaded by a user or is the default.

Present if realm is present in fetch_event_types.

Useful for UI allowing editing the organization’s wide logo.

• "D" means the logo is the default Zulip logo.

• "U" means uploaded by an organization administrator.

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

Unsets the Response realm_logo_source.

String indicating whether the organization’s profile wide logo was uploaded by a user or is the default.

Present if realm is present in fetch_event_types.

Useful for UI allowing editing the organization’s wide logo.

• "D" means the logo is the default Zulip logo.

• "U" means uploaded by an organization administrator.

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

Builder function that sets the Response realm_logo_source.

String indicating whether the organization’s profile wide logo was uploaded by a user or is the default.

Present if realm is present in fetch_event_types.

Useful for UI allowing editing the organization’s wide logo.

• "D" means the logo is the default Zulip logo.

• "U" means uploaded by an organization administrator.

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

Gets the Response realm_night_logo_url.

The URL of the organization’s dark theme wide-format logo configured in the organization profile.

Present if realm is present in fetch_event_types.

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

Sets the Response realm_night_logo_url.

The URL of the organization’s dark theme wide-format logo configured in the organization profile.

Present if realm is present in fetch_event_types.

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

Unsets the Response realm_night_logo_url.

The URL of the organization’s dark theme wide-format logo configured in the organization profile.

Present if realm is present in fetch_event_types.

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

Builder function that sets the Response realm_night_logo_url.

The URL of the organization’s dark theme wide-format logo configured in the organization profile.

Present if realm is present in fetch_event_types.

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

Gets the Response realm_night_logo_source.

String indicating whether the organization’s dark theme profile wide logo was uploaded by a user or is the default.

Present if realm is present in fetch_event_types.

Useful for UI allowing editing the organization’s wide logo.

• "D" means the logo is the default Zulip logo.

• "U" means uploaded by an organization administrator.

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

Sets the Response realm_night_logo_source.

String indicating whether the organization’s dark theme profile wide logo was uploaded by a user or is the default.

Present if realm is present in fetch_event_types.

Useful for UI allowing editing the organization’s wide logo.

• "D" means the logo is the default Zulip logo.

• "U" means uploaded by an organization administrator.

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

Unsets the Response realm_night_logo_source.

String indicating whether the organization’s dark theme profile wide logo was uploaded by a user or is the default.

Present if realm is present in fetch_event_types.

Useful for UI allowing editing the organization’s wide logo.

• "D" means the logo is the default Zulip logo.

• "U" means uploaded by an organization administrator.

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

Builder function that sets the Response realm_night_logo_source.

String indicating whether the organization’s dark theme profile wide logo was uploaded by a user or is the default.

Present if realm is present in fetch_event_types.

Useful for UI allowing editing the organization’s wide logo.

• "D" means the logo is the default Zulip logo.

• "U" means uploaded by an organization administrator.

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

Gets the Response realm_bot_domain.

The fake email domain that will be used for new bots created this organization.

Useful for UI for creating bots.

Present if realm is present in fetch_event_types.

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

Sets the Response realm_bot_domain.

The fake email domain that will be used for new bots created this organization.

Useful for UI for creating bots.

Present if realm is present in fetch_event_types.

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

Unsets the Response realm_bot_domain.

The fake email domain that will be used for new bots created this organization.

Useful for UI for creating bots.

Present if realm is present in fetch_event_types.

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

Builder function that sets the Response realm_bot_domain.

The fake email domain that will be used for new bots created this organization.

Useful for UI for creating bots.

Present if realm is present in fetch_event_types.

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

Gets the Response realm_uri.

The URL for the organization. Alias of realm_url.

Present if realm is present in fetch_event_types.

Changes: Deprecated in Zulip 9.0 (feature level 257).

The term "URI" is deprecated in web standards.

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

Sets the Response realm_uri.

The URL for the organization. Alias of realm_url.

Present if realm is present in fetch_event_types.

Changes: Deprecated in Zulip 9.0 (feature level 257).

The term "URI" is deprecated in web standards.

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

Unsets the Response realm_uri.

The URL for the organization. Alias of realm_url.

Present if realm is present in fetch_event_types.

Changes: Deprecated in Zulip 9.0 (feature level 257).

The term "URI" is deprecated in web standards.

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

Builder function that sets the Response realm_uri.

The URL for the organization. Alias of realm_url.

Present if realm is present in fetch_event_types.

Changes: Deprecated in Zulip 9.0 (feature level 257).

The term "URI" is deprecated in web standards.

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

Gets the Response realm_url.

The URL for the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 9.0 (feature level 257), replacing the deprecated realm_uri.

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

Sets the Response realm_url.

The URL for the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 9.0 (feature level 257), replacing the deprecated realm_uri.

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

Unsets the Response realm_url.

The URL for the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 9.0 (feature level 257), replacing the deprecated realm_uri.

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

Builder function that sets the Response realm_url.

The URL for the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 9.0 (feature level 257), replacing the deprecated realm_uri.

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

Gets the Response upgrade_text_for_wide_organization_logo.

Text to use when displaying UI for wide organization logos, a feature that is currently not available on the Zulip Cloud Free plan.

Present if realm is present in fetch_event_types.

Useful only for clients supporting administrative UI for uploading a new wide organization logo to brand the organization.

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

Sets the Response upgrade_text_for_wide_organization_logo.

Text to use when displaying UI for wide organization logos, a feature that is currently not available on the Zulip Cloud Free plan.

Present if realm is present in fetch_event_types.

Useful only for clients supporting administrative UI for uploading a new wide organization logo to brand the organization.

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

Unsets the Response upgrade_text_for_wide_organization_logo.

Text to use when displaying UI for wide organization logos, a feature that is currently not available on the Zulip Cloud Free plan.

Present if realm is present in fetch_event_types.

Useful only for clients supporting administrative UI for uploading a new wide organization logo to brand the organization.

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

Builder function that sets the Response upgrade_text_for_wide_organization_logo.

Text to use when displaying UI for wide organization logos, a feature that is currently not available on the Zulip Cloud Free plan.

Present if realm is present in fetch_event_types.

Useful only for clients supporting administrative UI for uploading a new wide organization logo to brand the organization.

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

Gets the Response jitsi_server_url.

The base URL to be used to create Jitsi video calls.

Equals realm_jitsi_server_url || server_jitsi_server_url.

Present if realm is present in fetch_event_types.

Changes: Deprecated in Zulip 8.0 (feature level 212) and will eventually be removed.

Previously, the Jitsi server to use was not configurable on a per-realm basis, and this field contained the server’s configured Jitsi server.

(Which is now provided as server_jitsi_server_url).

Clients supporting older versions should fall back to this field when creating calls:

using realm_jitsi_server_url || server_jitsi_server_url with newer servers and using jitsi_server_url with servers below feature level 212.

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

Sets the Response jitsi_server_url.

The base URL to be used to create Jitsi video calls.

Equals realm_jitsi_server_url || server_jitsi_server_url.

Present if realm is present in fetch_event_types.

Changes: Deprecated in Zulip 8.0 (feature level 212) and will eventually be removed.

Previously, the Jitsi server to use was not configurable on a per-realm basis, and this field contained the server’s configured Jitsi server.

(Which is now provided as server_jitsi_server_url).

Clients supporting older versions should fall back to this field when creating calls:

using realm_jitsi_server_url || server_jitsi_server_url with newer servers and using jitsi_server_url with servers below feature level 212.

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

Unsets the Response jitsi_server_url.

The base URL to be used to create Jitsi video calls.

Equals realm_jitsi_server_url || server_jitsi_server_url.

Present if realm is present in fetch_event_types.

Changes: Deprecated in Zulip 8.0 (feature level 212) and will eventually be removed.

Previously, the Jitsi server to use was not configurable on a per-realm basis, and this field contained the server’s configured Jitsi server.

(Which is now provided as server_jitsi_server_url).

Clients supporting older versions should fall back to this field when creating calls:

using realm_jitsi_server_url || server_jitsi_server_url with newer servers and using jitsi_server_url with servers below feature level 212.

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

Builder function that sets the Response jitsi_server_url.

The base URL to be used to create Jitsi video calls.

Equals realm_jitsi_server_url || server_jitsi_server_url.

Present if realm is present in fetch_event_types.

Changes: Deprecated in Zulip 8.0 (feature level 212) and will eventually be removed.

Previously, the Jitsi server to use was not configurable on a per-realm basis, and this field contained the server’s configured Jitsi server.

(Which is now provided as server_jitsi_server_url).

Clients supporting older versions should fall back to this field when creating calls:

using realm_jitsi_server_url || server_jitsi_server_url with newer servers and using jitsi_server_url with servers below feature level 212.

pub fn server_thumbnail_formats(&self) -> Option<&[ServerThumbnailFormat]>

Gets the Response server_thumbnail_formats.

A list describing the image formats that uploaded images will be thumbnailed into.

Present if realm is present in fetch_event_types.

Any image with a source starting with /user_uploads/thumbnail/

can have its last path component replaced with any of the names contained in this list, to obtain the desired thumbnail size.

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

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

Sets the Response server_thumbnail_formats.

A list describing the image formats that uploaded images will be thumbnailed into.

Present if realm is present in fetch_event_types.

Any image with a source starting with /user_uploads/thumbnail/

can have its last path component replaced with any of the names contained in this list, to obtain the desired thumbnail size.

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

pub fn unset_server_thumbnail_formats( &mut self, ) -> Option<Vec<ServerThumbnailFormat>>

Unsets the Response server_thumbnail_formats.

A list describing the image formats that uploaded images will be thumbnailed into.

Present if realm is present in fetch_event_types.

Any image with a source starting with /user_uploads/thumbnail/

can have its last path component replaced with any of the names contained in this list, to obtain the desired thumbnail size.

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

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

Builder function that sets the Response server_thumbnail_formats.

A list describing the image formats that uploaded images will be thumbnailed into.

Present if realm is present in fetch_event_types.

Any image with a source starting with /user_uploads/thumbnail/

can have its last path component replaced with any of the names contained in this list, to obtain the desired thumbnail size.

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

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

Gets the Response server_emoji_data_url.

The URL to a JSON file that describes which emoji names map to which emoji codes, for all Unicode emoji this Zulip server accepts.

Present if realm is present in fetch_event_types.

The data at the given URL is a JSON object with one property, code_to_names.

The value of that property is a JSON object where each key is an emoji code for an available Unicode emoji,

and each value is the corresponding emoji names for this emoji,

with the canonical name for the emoji always appearing first.

The HTTP response at that URL will have appropriate HTTP caching headers, such any HTTP implementation should get a cached version if emoji haven’t changed since the last request.

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

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

Sets the Response server_emoji_data_url.

The URL to a JSON file that describes which emoji names map to which emoji codes, for all Unicode emoji this Zulip server accepts.

Present if realm is present in fetch_event_types.

The data at the given URL is a JSON object with one property, code_to_names.

The value of that property is a JSON object where each key is an emoji code for an available Unicode emoji,

and each value is the corresponding emoji names for this emoji,

with the canonical name for the emoji always appearing first.

The HTTP response at that URL will have appropriate HTTP caching headers, such any HTTP implementation should get a cached version if emoji haven’t changed since the last request.

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

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

Unsets the Response server_emoji_data_url.

The URL to a JSON file that describes which emoji names map to which emoji codes, for all Unicode emoji this Zulip server accepts.

Present if realm is present in fetch_event_types.

The data at the given URL is a JSON object with one property, code_to_names.

The value of that property is a JSON object where each key is an emoji code for an available Unicode emoji,

and each value is the corresponding emoji names for this emoji,

with the canonical name for the emoji always appearing first.

The HTTP response at that URL will have appropriate HTTP caching headers, such any HTTP implementation should get a cached version if emoji haven’t changed since the last request.

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

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

Builder function that sets the Response server_emoji_data_url.

The URL to a JSON file that describes which emoji names map to which emoji codes, for all Unicode emoji this Zulip server accepts.

Present if realm is present in fetch_event_types.

The data at the given URL is a JSON object with one property, code_to_names.

The value of that property is a JSON object where each key is an emoji code for an available Unicode emoji,

and each value is the corresponding emoji names for this emoji,

with the canonical name for the emoji always appearing first.

The HTTP response at that URL will have appropriate HTTP caching headers, such any HTTP implementation should get a cached version if emoji haven’t changed since the last request.

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

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

Gets the Response server_jitsi_server_url.

The URL of the Jitsi server that the Zulip server is configured to use by default;

the organization-level setting realm_jitsi_server_url takes precedence over this setting when both are set.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 8.0 (feature level 212). Previously, this value was available as the now-deprecated jitsi_server_url.

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

Sets the Response server_jitsi_server_url.

The URL of the Jitsi server that the Zulip server is configured to use by default;

the organization-level setting realm_jitsi_server_url takes precedence over this setting when both are set.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 8.0 (feature level 212). Previously, this value was available as the now-deprecated jitsi_server_url.

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

Unsets the Response server_jitsi_server_url.

The URL of the Jitsi server that the Zulip server is configured to use by default;

the organization-level setting realm_jitsi_server_url takes precedence over this setting when both are set.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 8.0 (feature level 212). Previously, this value was available as the now-deprecated jitsi_server_url.

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

Builder function that sets the Response server_jitsi_server_url.

The URL of the Jitsi server that the Zulip server is configured to use by default;

the organization-level setting realm_jitsi_server_url takes precedence over this setting when both are set.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 8.0 (feature level 212). Previously, this value was available as the now-deprecated jitsi_server_url.

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

Gets the Response realm_empty_topic_display_name.

Clients declaring the empty_topic_name client capability should use the value of realm_empty_topic_display_name to determine how to display the empty string topic.

Present if realm is present in fetch_event_types.

Clients not declaring the empty_topic_name client capability receive realm_empty_topic_display_name value as the topic name replacing empty string.

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

Previously, the empty string was not a valid topic name.

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

Sets the Response realm_empty_topic_display_name.

Clients declaring the empty_topic_name client capability should use the value of realm_empty_topic_display_name to determine how to display the empty string topic.

Present if realm is present in fetch_event_types.

Clients not declaring the empty_topic_name client capability receive realm_empty_topic_display_name value as the topic name replacing empty string.

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

Previously, the empty string was not a valid topic name.

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

Unsets the Response realm_empty_topic_display_name.

Clients declaring the empty_topic_name client capability should use the value of realm_empty_topic_display_name to determine how to display the empty string topic.

Present if realm is present in fetch_event_types.

Clients not declaring the empty_topic_name client capability receive realm_empty_topic_display_name value as the topic name replacing empty string.

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

Previously, the empty string was not a valid topic name.

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

Builder function that sets the Response realm_empty_topic_display_name.

Clients declaring the empty_topic_name client capability should use the value of realm_empty_topic_display_name to determine how to display the empty string topic.

Present if realm is present in fetch_event_types.

Clients not declaring the empty_topic_name client capability receive realm_empty_topic_display_name value as the topic name replacing empty string.

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

Previously, the empty string was not a valid topic name.

pub fn realm_users(&self) -> Option<&[User]>

Gets the Response realm_users.

A array of dictionaries where each entry describes a user whose account has not been deactivated.

Present if realm_user is present in fetch_event_types.

Note that unlike the usual User dictionary, this does not contain the is_active key, as all the users present in this array have active accounts.

If the current user is a guest whose access to users is limited by a can_access_all_users_group policy,

and the event queue was registered with the user_list_incomplete client capability,

then users that the current user cannot access will not be included in this array.

If the current user’s access to a user is restricted but the client lacks this capability,

then that inaccessible user will appear in the users array as an "Unknown user" object with the usual format but placeholder data whose only variable content is the user ID.

See also cross_realm_bots and realm_non_active_users.

Changes: Before Zulip 8.0 (feature level 232), the user_list_incomplete client capability did not exist,

and so all clients whose access to a new user was prevented by can_access_all_users_group policy would receive a fake "Unknown user" event for such users.

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

Sets the Response realm_users.

A array of dictionaries where each entry describes a user whose account has not been deactivated.

Present if realm_user is present in fetch_event_types.

Note that unlike the usual User dictionary, this does not contain the is_active key, as all the users present in this array have active accounts.

If the current user is a guest whose access to users is limited by a can_access_all_users_group policy,

and the event queue was registered with the user_list_incomplete client capability,

then users that the current user cannot access will not be included in this array.

If the current user’s access to a user is restricted but the client lacks this capability,

then that inaccessible user will appear in the users array as an "Unknown user" object with the usual format but placeholder data whose only variable content is the user ID.

See also cross_realm_bots and realm_non_active_users.

Changes: Before Zulip 8.0 (feature level 232), the user_list_incomplete client capability did not exist,

and so all clients whose access to a new user was prevented by can_access_all_users_group policy would receive a fake "Unknown user" event for such users.

pub fn unset_realm_users(&mut self) -> Option<Vec<User>>

Unsets the Response realm_users.

A array of dictionaries where each entry describes a user whose account has not been deactivated.

Present if realm_user is present in fetch_event_types.

Note that unlike the usual User dictionary, this does not contain the is_active key, as all the users present in this array have active accounts.

If the current user is a guest whose access to users is limited by a can_access_all_users_group policy,

and the event queue was registered with the user_list_incomplete client capability,

then users that the current user cannot access will not be included in this array.

If the current user’s access to a user is restricted but the client lacks this capability,

then that inaccessible user will appear in the users array as an "Unknown user" object with the usual format but placeholder data whose only variable content is the user ID.

See also cross_realm_bots and realm_non_active_users.

Changes: Before Zulip 8.0 (feature level 232), the user_list_incomplete client capability did not exist,

and so all clients whose access to a new user was prevented by can_access_all_users_group policy would receive a fake "Unknown user" event for such users.

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

Builder function that sets the Response realm_users.

A array of dictionaries where each entry describes a user whose account has not been deactivated.

Present if realm_user is present in fetch_event_types.

Note that unlike the usual User dictionary, this does not contain the is_active key, as all the users present in this array have active accounts.

If the current user is a guest whose access to users is limited by a can_access_all_users_group policy,

and the event queue was registered with the user_list_incomplete client capability,

then users that the current user cannot access will not be included in this array.

If the current user’s access to a user is restricted but the client lacks this capability,

then that inaccessible user will appear in the users array as an "Unknown user" object with the usual format but placeholder data whose only variable content is the user ID.

See also cross_realm_bots and realm_non_active_users.

Changes: Before Zulip 8.0 (feature level 232), the user_list_incomplete client capability did not exist,

and so all clients whose access to a new user was prevented by can_access_all_users_group policy would receive a fake "Unknown user" event for such users.

pub fn realm_non_active_users(&self) -> Option<&[User]>

Gets the Response realm_non_active_users.

A array of dictionaries where each entry describes a user whose account has been deactivated.

Present if realm_user is present in fetch_event_types.

Note that unlike the usual User dictionary this does not contain the is_active key as all the users present in this array have deactivated accounts.

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

Sets the Response realm_non_active_users.

A array of dictionaries where each entry describes a user whose account has been deactivated.

Present if realm_user is present in fetch_event_types.

Note that unlike the usual User dictionary this does not contain the is_active key as all the users present in this array have deactivated accounts.

pub fn unset_realm_non_active_users(&mut self) -> Option<Vec<User>>

Unsets the Response realm_non_active_users.

A array of dictionaries where each entry describes a user whose account has been deactivated.

Present if realm_user is present in fetch_event_types.

Note that unlike the usual User dictionary this does not contain the is_active key as all the users present in this array have deactivated accounts.

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

Builder function that sets the Response realm_non_active_users.

A array of dictionaries where each entry describes a user whose account has been deactivated.

Present if realm_user is present in fetch_event_types.

Note that unlike the usual User dictionary this does not contain the is_active key as all the users present in this array have deactivated accounts.

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

Gets the Response avatar_source.

The avatar data source type for the current user. Value values are G (gravatar) and U (uploaded by user).

Present if realm_user is present in fetch_event_types.

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

Sets the Response avatar_source.

The avatar data source type for the current user. Value values are G (gravatar) and U (uploaded by user).

Present if realm_user is present in fetch_event_types.

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

Unsets the Response avatar_source.

The avatar data source type for the current user. Value values are G (gravatar) and U (uploaded by user).

Present if realm_user is present in fetch_event_types.

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

Builder function that sets the Response avatar_source.

The avatar data source type for the current user. Value values are G (gravatar) and U (uploaded by user).

Present if realm_user is present in fetch_event_types.

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

Gets the Response avatar_url_medium.

The avatar URL for the current user at 500x500 resolution, appropriate for use in settings UI showing the user’s avatar.

Present if realm_user is present in fetch_event_types.

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

Sets the Response avatar_url_medium.

The avatar URL for the current user at 500x500 resolution, appropriate for use in settings UI showing the user’s avatar.

Present if realm_user is present in fetch_event_types.

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

Unsets the Response avatar_url_medium.

The avatar URL for the current user at 500x500 resolution, appropriate for use in settings UI showing the user’s avatar.

Present if realm_user is present in fetch_event_types.

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

Builder function that sets the Response avatar_url_medium.

The avatar URL for the current user at 500x500 resolution, appropriate for use in settings UI showing the user’s avatar.

Present if realm_user is present in fetch_event_types.

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

Gets the Response avatar_url.

The URL of the avatar for the current user at 100x100 resolution. See also avatar_url_medium.

Present if realm_user is present in fetch_event_types.

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

Sets the Response avatar_url.

The URL of the avatar for the current user at 100x100 resolution. See also avatar_url_medium.

Present if realm_user is present in fetch_event_types.

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

Unsets the Response avatar_url.

The URL of the avatar for the current user at 100x100 resolution. See also avatar_url_medium.

Present if realm_user is present in fetch_event_types.

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

Builder function that sets the Response avatar_url.

The URL of the avatar for the current user at 100x100 resolution. See also avatar_url_medium.

Present if realm_user is present in fetch_event_types.

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

Gets the Response email.

The Zulip API email address for the current user. See also delivery_email; these may be the same or different depending on the user’s email_address_visibility policy.

Present if realm_user is present in fetch_event_types.

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

Sets the Response email.

The Zulip API email address for the current user. See also delivery_email; these may be the same or different depending on the user’s email_address_visibility policy.

Present if realm_user is present in fetch_event_types.

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

Unsets the Response email.

The Zulip API email address for the current user. See also delivery_email; these may be the same or different depending on the user’s email_address_visibility policy.

Present if realm_user is present in fetch_event_types.

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

Builder function that sets the Response email.

The Zulip API email address for the current user. See also delivery_email; these may be the same or different depending on the user’s email_address_visibility policy.

Present if realm_user is present in fetch_event_types.

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

Gets the Response delivery_email.

The user’s email address, appropriate for UI for changing the user’s email address. See also email.

Present if realm_user is present in fetch_event_types.

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

Sets the Response delivery_email.

The user’s email address, appropriate for UI for changing the user’s email address. See also email.

Present if realm_user is present in fetch_event_types.

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

Unsets the Response delivery_email.

The user’s email address, appropriate for UI for changing the user’s email address. See also email.

Present if realm_user is present in fetch_event_types.

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

Builder function that sets the Response delivery_email.

The user’s email address, appropriate for UI for changing the user’s email address. See also email.

Present if realm_user is present in fetch_event_types.

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

Gets the Response full_name.

The full name of the current user.

Present if realm_user is present in fetch_event_types.

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

Sets the Response full_name.

The full name of the current user.

Present if realm_user is present in fetch_event_types.

pub fn unset_full_name(&mut self) -> Option<String>

Unsets the Response full_name.

The full name of the current user.

Present if realm_user is present in fetch_event_types.

pub fn with_full_name<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self

Builder function that sets the Response full_name.

The full name of the current user.

Present if realm_user is present in fetch_event_types.

pub fn cross_realm_bots(&self) -> Option<&[CrossRealmBot]>

Gets the Response cross_realm_bots.

Array of dictionaries where each dictionary contains details of a single cross realm bot.

Cross-realm bots are special system bot accounts like Notification Bot.

Most clients will want to combine this with realm_users in many contexts.

Present if realm_user is present in fetch_event_types.

pub fn set_cross_realm_bots<'a, C: Into<Cow<'a, [CrossRealmBot]>>>( &mut self, val: C, )

Sets the Response cross_realm_bots.

Array of dictionaries where each dictionary contains details of a single cross realm bot.

Cross-realm bots are special system bot accounts like Notification Bot.

Most clients will want to combine this with realm_users in many contexts.

Present if realm_user is present in fetch_event_types.

pub fn unset_cross_realm_bots(&mut self) -> Option<Vec<CrossRealmBot>>

Unsets the Response cross_realm_bots.

Array of dictionaries where each dictionary contains details of a single cross realm bot.

Cross-realm bots are special system bot accounts like Notification Bot.

Most clients will want to combine this with realm_users in many contexts.

Present if realm_user is present in fetch_event_types.

pub fn with_cross_realm_bots<'a, C: Into<Cow<'a, [CrossRealmBot]>>>( self, val: C, ) -> Self

Builder function that sets the Response cross_realm_bots.

Array of dictionaries where each dictionary contains details of a single cross realm bot.

Cross-realm bots are special system bot accounts like Notification Bot.

Most clients will want to combine this with realm_users in many contexts.

Present if realm_user is present in fetch_event_types.

impl Response

pub fn user_settings(&self) -> Option<&UserSettings>

Gets the Response user_settings.

Present if user_settings is present in fetch_event_types.

A dictionary containing 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.

pub fn set_user_settings(&mut self, val: UserSettings)

Sets the Response user_settings.

Present if user_settings is present in fetch_event_types.

A dictionary containing 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.

pub fn unset_user_settings(&mut self) -> Option<UserSettings>

Unsets the Response user_settings.

Present if user_settings is present in fetch_event_types.

A dictionary containing 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.

pub fn with_user_settings(self, val: UserSettings) -> Self

Builder function that sets the Response user_settings.

Present if user_settings is present in fetch_event_types.

A dictionary containing 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.

pub fn unread_msgs(&self) -> Option<&UnreadMsgs>

Gets the Response unread_msgs.

Present if message and update_message_flags are both present in

event_types.

A set of data structures describing the conversations containing

the 50000 most recent unread messages the user has received. This will usually

contain every unread message the user has received, but clients should support

users with even more unread messages (and not hardcode the number 50000).

pub fn set_unread_msgs(&mut self, val: UnreadMsgs)

Sets the Response unread_msgs.

Present if message and update_message_flags are both present in

event_types.

A set of data structures describing the conversations containing

the 50000 most recent unread messages the user has received. This will usually

contain every unread message the user has received, but clients should support

users with even more unread messages (and not hardcode the number 50000).

pub fn unset_unread_msgs(&mut self) -> Option<UnreadMsgs>

Unsets the Response unread_msgs.

Present if message and update_message_flags are both present in

event_types.

A set of data structures describing the conversations containing

the 50000 most recent unread messages the user has received. This will usually

contain every unread message the user has received, but clients should support

users with even more unread messages (and not hardcode the number 50000).

pub fn with_unread_msgs(self, val: UnreadMsgs) -> Self

Builder function that sets the Response unread_msgs.

Present if message and update_message_flags are both present in

event_types.

A set of data structures describing the conversations containing

the 50000 most recent unread messages the user has received. This will usually

contain every unread message the user has received, but clients should support

users with even more unread messages (and not hardcode the number 50000).

pub fn custom_profile_field_types( &self, ) -> Option<&HashMap<String, CustomProfileFieldType>>

Gets the Response custom_profile_field_types.

An array of objects; each object describes a type of custom profile field that could be configured on this Zulip server.

Present if custom_profile_fields is present in fetch_event_types.

Each custom profile type has an ID and the type property of a custom profile field is equal to one of these IDs.

This attribute is only useful for clients containing UI for changing the set of configured custom profile fields in a Zulip organization.

pub fn set_custom_profile_field_types( &mut self, val: HashMap<String, CustomProfileFieldType>, )

Sets the Response custom_profile_field_types.

An array of objects; each object describes a type of custom profile field that could be configured on this Zulip server.

Present if custom_profile_fields is present in fetch_event_types.

Each custom profile type has an ID and the type property of a custom profile field is equal to one of these IDs.

This attribute is only useful for clients containing UI for changing the set of configured custom profile fields in a Zulip organization.

pub fn unset_custom_profile_field_types( &mut self, ) -> Option<HashMap<String, CustomProfileFieldType>>

Unsets the Response custom_profile_field_types.

An array of objects; each object describes a type of custom profile field that could be configured on this Zulip server.

Present if custom_profile_fields is present in fetch_event_types.

Each custom profile type has an ID and the type property of a custom profile field is equal to one of these IDs.

This attribute is only useful for clients containing UI for changing the set of configured custom profile fields in a Zulip organization.

pub fn with_custom_profile_field_types( self, val: HashMap<String, CustomProfileFieldType>, ) -> Self

Builder function that sets the Response custom_profile_field_types.

An array of objects; each object describes a type of custom profile field that could be configured on this Zulip server.

Present if custom_profile_fields is present in fetch_event_types.

Each custom profile type has an ID and the type property of a custom profile field is equal to one of these IDs.

This attribute is only useful for clients containing UI for changing the set of configured custom profile fields in a Zulip organization.

pub fn presences(&self) -> Option<&PresenceList>

Gets the Response presences.

A dictionary where each entry describes the presence details of a user in the Zulip organization.

Present if presence is present in fetch_event_types.

The format of the entry (modern or legacy) depends on the value of slim_presence. Users who have been offline for multiple weeks may not appear in this object.

pub fn set_presences(&mut self, val: PresenceList)

Sets the Response presences.

A dictionary where each entry describes the presence details of a user in the Zulip organization.

Present if presence is present in fetch_event_types.

The format of the entry (modern or legacy) depends on the value of slim_presence. Users who have been offline for multiple weeks may not appear in this object.

pub fn unset_presences(&mut self) -> Option<PresenceList>

Unsets the Response presences.

A dictionary where each entry describes the presence details of a user in the Zulip organization.

Present if presence is present in fetch_event_types.

The format of the entry (modern or legacy) depends on the value of slim_presence. Users who have been offline for multiple weeks may not appear in this object.

pub fn with_presences(self, val: PresenceList) -> Self

Builder function that sets the Response presences.

A dictionary where each entry describes the presence details of a user in the Zulip organization.

Present if presence is present in fetch_event_types.

The format of the entry (modern or legacy) depends on the value of slim_presence. Users who have been offline for multiple weeks may not appear in this object.

pub fn realm_emoji(&self) -> Option<&HashMap<String, RealmEmoji>>

Gets the Response realm_emoji.

A dictionary of objects where each object describes a custom emoji that has been uploaded in this Zulip organization.

Present if realm_emoji is present in fetch_event_types.

pub fn set_realm_emoji(&mut self, val: HashMap<String, RealmEmoji>)

Sets the Response realm_emoji.

A dictionary of objects where each object describes a custom emoji that has been uploaded in this Zulip organization.

Present if realm_emoji is present in fetch_event_types.

pub fn unset_realm_emoji(&mut self) -> Option<HashMap<String, RealmEmoji>>

Unsets the Response realm_emoji.

A dictionary of objects where each object describes a custom emoji that has been uploaded in this Zulip organization.

Present if realm_emoji is present in fetch_event_types.

pub fn with_realm_emoji(self, val: HashMap<String, RealmEmoji>) -> Self

Builder function that sets the Response realm_emoji.

A dictionary of objects where each object describes a custom emoji that has been uploaded in this Zulip organization.

Present if realm_emoji is present in fetch_event_types.

pub fn user_status(&self) -> Option<&HashMap<String, UserStatus>>

Gets the Response user_status.

A dictionary which contains the status of all users in the Zulip organization who have set a status.

Present if user_status is present in fetch_event_types.

Changes: The emoji parameters are new in Zulip 5.0 (feature level 86). Previously, Zulip did not support emoji associated with statuses.

pub fn set_user_status(&mut self, val: HashMap<String, UserStatus>)

Sets the Response user_status.

A dictionary which contains the status of all users in the Zulip organization who have set a status.

Present if user_status is present in fetch_event_types.

Changes: The emoji parameters are new in Zulip 5.0 (feature level 86). Previously, Zulip did not support emoji associated with statuses.

pub fn unset_user_status(&mut self) -> Option<HashMap<String, UserStatus>>

Unsets the Response user_status.

A dictionary which contains the status of all users in the Zulip organization who have set a status.

Present if user_status is present in fetch_event_types.

Changes: The emoji parameters are new in Zulip 5.0 (feature level 86). Previously, Zulip did not support emoji associated with statuses.

pub fn with_user_status(self, val: HashMap<String, UserStatus>) -> Self

Builder function that sets the Response user_status.

A dictionary which contains the status of all users in the Zulip organization who have set a status.

Present if user_status is present in fetch_event_types.

Changes: The emoji parameters are new in Zulip 5.0 (feature level 86). Previously, Zulip did not support emoji associated with statuses.

pub fn push_devices(&self) -> Option<&HashMap<String, PushDevice>>

Gets the Response push_devices.

Dictionary where each entry describes the user’s push device’s registration status and error code (if registration failed).

Present if push_device is present in fetch_event_types.

Changes: New in Zulip 11.0 (feature level 406).

pub fn set_push_devices(&mut self, val: HashMap<String, PushDevice>)

Sets the Response push_devices.

Dictionary where each entry describes the user’s push device’s registration status and error code (if registration failed).

Present if push_device is present in fetch_event_types.

Changes: New in Zulip 11.0 (feature level 406).

pub fn unset_push_devices(&mut self) -> Option<HashMap<String, PushDevice>>

Unsets the Response push_devices.

Dictionary where each entry describes the user’s push device’s registration status and error code (if registration failed).

Present if push_device is present in fetch_event_types.

Changes: New in Zulip 11.0 (feature level 406).

pub fn with_push_devices(self, val: HashMap<String, PushDevice>) -> Self

Builder function that sets the Response push_devices.

Dictionary where each entry describes the user’s push device’s registration status and error code (if registration failed).

Present if push_device is present in fetch_event_types.

Changes: New in Zulip 11.0 (feature level 406).

pub fn realm_video_chat_provider(&self) -> Option<&RealmVideoChatProvider>

Gets the Response realm_video_chat_provider.

The configured video call provider for the organization.

Present if realm is present in fetch_event_types.

pub fn set_realm_video_chat_provider(&mut self, val: RealmVideoChatProvider)

Sets the Response realm_video_chat_provider.

The configured video call provider for the organization.

Present if realm is present in fetch_event_types.

pub fn unset_realm_video_chat_provider( &mut self, ) -> Option<RealmVideoChatProvider>

Unsets the Response realm_video_chat_provider.

The configured video call provider for the organization.

Present if realm is present in fetch_event_types.

pub fn with_realm_video_chat_provider(self, val: RealmVideoChatProvider) -> Self

Builder function that sets the Response realm_video_chat_provider.

The configured video call provider for the organization.

Present if realm is present in fetch_event_types.

pub fn realm_can_add_custom_emoji_group(&self) -> Option<&GroupSetting>

Gets the Response realm_can_add_custom_emoji_group.

A group-setting value defining the set of users who have permission to add custom emoji in the organization.

Present if realm is present in fetch_event_types.

pub fn set_realm_can_add_custom_emoji_group(&mut self, val: GroupSetting)

Sets the Response realm_can_add_custom_emoji_group.

A group-setting value defining the set of users who have permission to add custom emoji in the organization.

Present if realm is present in fetch_event_types.

pub fn unset_realm_can_add_custom_emoji_group(&mut self) -> Option<GroupSetting>

Unsets the Response realm_can_add_custom_emoji_group.

A group-setting value defining the set of users who have permission to add custom emoji in the organization.

Present if realm is present in fetch_event_types.

pub fn with_realm_can_add_custom_emoji_group(self, val: GroupSetting) -> Self

Builder function that sets the Response realm_can_add_custom_emoji_group.

A group-setting value defining the set of users who have permission to add custom emoji in the organization.

Present if realm is present in fetch_event_types.

pub fn realm_direct_message_initiator_group(&self) -> Option<&GroupSetting>

Gets the Response realm_direct_message_initiator_group.

A group-setting value defining the set of users who have permission to start a new direct message conversation involving other non-bot users.

Present if realm is present in fetch_event_types.

Users who are outside this group and attempt to send the first direct message to a given collection of recipient users will receive an error, unless all other recipients are bots or the sender.

Changes: New in Zulip 9.0 (feature level 270). Previously, access to send direct messages was controlled by the private_message_policy realm setting, which supported values of 1 (enabled) and 2 (disabled).

pub fn set_realm_direct_message_initiator_group(&mut self, val: GroupSetting)

Sets the Response realm_direct_message_initiator_group.

A group-setting value defining the set of users who have permission to start a new direct message conversation involving other non-bot users.

Present if realm is present in fetch_event_types.

Users who are outside this group and attempt to send the first direct message to a given collection of recipient users will receive an error, unless all other recipients are bots or the sender.

Changes: New in Zulip 9.0 (feature level 270). Previously, access to send direct messages was controlled by the private_message_policy realm setting, which supported values of 1 (enabled) and 2 (disabled).

pub fn unset_realm_direct_message_initiator_group( &mut self, ) -> Option<GroupSetting>

Unsets the Response realm_direct_message_initiator_group.

A group-setting value defining the set of users who have permission to start a new direct message conversation involving other non-bot users.

Present if realm is present in fetch_event_types.

Users who are outside this group and attempt to send the first direct message to a given collection of recipient users will receive an error, unless all other recipients are bots or the sender.

Changes: New in Zulip 9.0 (feature level 270). Previously, access to send direct messages was controlled by the private_message_policy realm setting, which supported values of 1 (enabled) and 2 (disabled).

pub fn with_realm_direct_message_initiator_group( self, val: GroupSetting, ) -> Self

Builder function that sets the Response realm_direct_message_initiator_group.

A group-setting value defining the set of users who have permission to start a new direct message conversation involving other non-bot users.

Present if realm is present in fetch_event_types.

Users who are outside this group and attempt to send the first direct message to a given collection of recipient users will receive an error, unless all other recipients are bots or the sender.

Changes: New in Zulip 9.0 (feature level 270). Previously, access to send direct messages was controlled by the private_message_policy realm setting, which supported values of 1 (enabled) and 2 (disabled).

pub fn realm_can_add_subscribers_group(&self) -> Option<&GroupSetting>

Gets the Response realm_can_add_subscribers_group.

A group-setting value defining the set of users who have permission to add subscribers to channels in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 341).

Previously, this permission was controlled by the enum invite_to_stream_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators.

pub fn set_realm_can_add_subscribers_group(&mut self, val: GroupSetting)

Sets the Response realm_can_add_subscribers_group.

A group-setting value defining the set of users who have permission to add subscribers to channels in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 341).

Previously, this permission was controlled by the enum invite_to_stream_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators.

pub fn unset_realm_can_add_subscribers_group(&mut self) -> Option<GroupSetting>

Unsets the Response realm_can_add_subscribers_group.

A group-setting value defining the set of users who have permission to add subscribers to channels in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 341).

Previously, this permission was controlled by the enum invite_to_stream_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators.

pub fn with_realm_can_add_subscribers_group(self, val: GroupSetting) -> Self

Builder function that sets the Response realm_can_add_subscribers_group.

A group-setting value defining the set of users who have permission to add subscribers to channels in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 341).

Previously, this permission was controlled by the enum invite_to_stream_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators.

pub fn realm_can_delete_any_message_group(&self) -> Option<&GroupSetting>

Gets the Response realm_can_delete_any_message_group.

A group-setting value defining the set of users who have permission to delete any message in the organization.

Present if realm is present in fetch_event_types.

Note that a user must also be able to access the content of a message in order to delete it.

See channel permissions for information about content access for channel messages.

For direct messages, the user must have received or sent the direct message to have content access.

Changes: New in Zulip 10.0 (feature level 281).

Previously, this permission was limited to administrators only and was uneditable.

pub fn set_realm_can_delete_any_message_group(&mut self, val: GroupSetting)

Sets the Response realm_can_delete_any_message_group.

A group-setting value defining the set of users who have permission to delete any message in the organization.

Present if realm is present in fetch_event_types.

Note that a user must also be able to access the content of a message in order to delete it.

See channel permissions for information about content access for channel messages.

For direct messages, the user must have received or sent the direct message to have content access.

Changes: New in Zulip 10.0 (feature level 281).

Previously, this permission was limited to administrators only and was uneditable.

pub fn unset_realm_can_delete_any_message_group( &mut self, ) -> Option<GroupSetting>

Unsets the Response realm_can_delete_any_message_group.

A group-setting value defining the set of users who have permission to delete any message in the organization.

Present if realm is present in fetch_event_types.

Note that a user must also be able to access the content of a message in order to delete it.

See channel permissions for information about content access for channel messages.

For direct messages, the user must have received or sent the direct message to have content access.

Changes: New in Zulip 10.0 (feature level 281).

Previously, this permission was limited to administrators only and was uneditable.

pub fn with_realm_can_delete_any_message_group(self, val: GroupSetting) -> Self

Builder function that sets the Response realm_can_delete_any_message_group.

A group-setting value defining the set of users who have permission to delete any message in the organization.

Present if realm is present in fetch_event_types.

Note that a user must also be able to access the content of a message in order to delete it.

See channel permissions for information about content access for channel messages.

For direct messages, the user must have received or sent the direct message to have content access.

Changes: New in Zulip 10.0 (feature level 281).

Previously, this permission was limited to administrators only and was uneditable.

pub fn realm_can_delete_own_message_group(&self) -> Option<&GroupSetting>

Gets the Response realm_can_delete_own_message_group.

A group-setting value defining the set of users who have permission to delete messages that they have sent in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 291).

Previously, this permission was controlled by the enum delete_own_message_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 5=Everyone.

Before Zulip 5.0 (feature level 101), the allow_message_deleting boolean setting controlled this permission; true corresponded to Everyone, and false to Admins.

pub fn set_realm_can_delete_own_message_group(&mut self, val: GroupSetting)

Sets the Response realm_can_delete_own_message_group.

A group-setting value defining the set of users who have permission to delete messages that they have sent in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 291).

Previously, this permission was controlled by the enum delete_own_message_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 5=Everyone.

Before Zulip 5.0 (feature level 101), the allow_message_deleting boolean setting controlled this permission; true corresponded to Everyone, and false to Admins.

pub fn unset_realm_can_delete_own_message_group( &mut self, ) -> Option<GroupSetting>

Unsets the Response realm_can_delete_own_message_group.

A group-setting value defining the set of users who have permission to delete messages that they have sent in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 291).

Previously, this permission was controlled by the enum delete_own_message_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 5=Everyone.

Before Zulip 5.0 (feature level 101), the allow_message_deleting boolean setting controlled this permission; true corresponded to Everyone, and false to Admins.

pub fn with_realm_can_delete_own_message_group(self, val: GroupSetting) -> Self

Builder function that sets the Response realm_can_delete_own_message_group.

A group-setting value defining the set of users who have permission to delete messages that they have sent in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 291).

Previously, this permission was controlled by the enum delete_own_message_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 5=Everyone.

Before Zulip 5.0 (feature level 101), the allow_message_deleting boolean setting controlled this permission; true corresponded to Everyone, and false to Admins.

pub fn realm_can_set_delete_message_policy_group(&self) -> Option<&GroupSetting>

Gets the Response realm_can_set_delete_message_policy_group.

A group-setting value defining the set of users who have permission to change per-channel can_delete_any_message_group and can_delete_own_message_group permission settings.

Present if realm is present in fetch_event_types.

Note that the user must be a member of both this group and the can_administer_channel_group of the channel whose message delete settings they want to change.

Organization administrators can always change these settings of every channel.

Changes: New in Zulip 11.0 (feature level 407).

pub fn set_realm_can_set_delete_message_policy_group( &mut self, val: GroupSetting, )

Sets the Response realm_can_set_delete_message_policy_group.

A group-setting value defining the set of users who have permission to change per-channel can_delete_any_message_group and can_delete_own_message_group permission settings.

Present if realm is present in fetch_event_types.

Note that the user must be a member of both this group and the can_administer_channel_group of the channel whose message delete settings they want to change.

Organization administrators can always change these settings of every channel.

Changes: New in Zulip 11.0 (feature level 407).

pub fn unset_realm_can_set_delete_message_policy_group( &mut self, ) -> Option<GroupSetting>

Unsets the Response realm_can_set_delete_message_policy_group.

A group-setting value defining the set of users who have permission to change per-channel can_delete_any_message_group and can_delete_own_message_group permission settings.

Present if realm is present in fetch_event_types.

Note that the user must be a member of both this group and the can_administer_channel_group of the channel whose message delete settings they want to change.

Organization administrators can always change these settings of every channel.

Changes: New in Zulip 11.0 (feature level 407).

pub fn with_realm_can_set_delete_message_policy_group( self, val: GroupSetting, ) -> Self

Builder function that sets the Response realm_can_set_delete_message_policy_group.

A group-setting value defining the set of users who have permission to change per-channel can_delete_any_message_group and can_delete_own_message_group permission settings.

Present if realm is present in fetch_event_types.

Note that the user must be a member of both this group and the can_administer_channel_group of the channel whose message delete settings they want to change.

Organization administrators can always change these settings of every channel.

Changes: New in Zulip 11.0 (feature level 407).

pub fn realm_can_set_topics_policy_group(&self) -> Option<&GroupSetting>

Gets the Response realm_can_set_topics_policy_group.

A group-setting value defining the set of users who have permission to change per-channel topics_policy setting.

Present if realm is present in fetch_event_types.

Note that the user must be a member of both this group and the can_administer_channel_group of the channel whose topics_policy they want to change.

Organization administrators can always change the topics_policy setting of every channel.

Changes: New in Zulip 11.0 (feature level 392).

pub fn set_realm_can_set_topics_policy_group(&mut self, val: GroupSetting)

Sets the Response realm_can_set_topics_policy_group.

A group-setting value defining the set of users who have permission to change per-channel topics_policy setting.

Present if realm is present in fetch_event_types.

Note that the user must be a member of both this group and the can_administer_channel_group of the channel whose topics_policy they want to change.

Organization administrators can always change the topics_policy setting of every channel.

Changes: New in Zulip 11.0 (feature level 392).

pub fn unset_realm_can_set_topics_policy_group( &mut self, ) -> Option<GroupSetting>

Unsets the Response realm_can_set_topics_policy_group.

A group-setting value defining the set of users who have permission to change per-channel topics_policy setting.

Present if realm is present in fetch_event_types.

Note that the user must be a member of both this group and the can_administer_channel_group of the channel whose topics_policy they want to change.

Organization administrators can always change the topics_policy setting of every channel.

Changes: New in Zulip 11.0 (feature level 392).

pub fn with_realm_can_set_topics_policy_group(self, val: GroupSetting) -> Self

Builder function that sets the Response realm_can_set_topics_policy_group.

A group-setting value defining the set of users who have permission to change per-channel topics_policy setting.

Present if realm is present in fetch_event_types.

Note that the user must be a member of both this group and the can_administer_channel_group of the channel whose topics_policy they want to change.

Organization administrators can always change the topics_policy setting of every channel.

Changes: New in Zulip 11.0 (feature level 392).

pub fn realm_can_invite_users_group(&self) -> Option<&GroupSetting>

Gets the Response realm_can_invite_users_group.

Present if realm is present in fetch_event_types.

A group-setting value defining the set of users who have permission to send email invitations for inviting other users to the organization.

Changes: New in Zulip 10.0 (feature level 321).

Previously, this permission was controlled by the enum invite_to_realm_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 6=Nobody.

Before Zulip 4.0 (feature level 50), the invite_by_admins_only boolean setting controlled this permission; true corresponded to Admins, and false to Members.

pub fn set_realm_can_invite_users_group(&mut self, val: GroupSetting)

Sets the Response realm_can_invite_users_group.

Present if realm is present in fetch_event_types.

A group-setting value defining the set of users who have permission to send email invitations for inviting other users to the organization.

Changes: New in Zulip 10.0 (feature level 321).

Previously, this permission was controlled by the enum invite_to_realm_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 6=Nobody.

Before Zulip 4.0 (feature level 50), the invite_by_admins_only boolean setting controlled this permission; true corresponded to Admins, and false to Members.

pub fn unset_realm_can_invite_users_group(&mut self) -> Option<GroupSetting>

Unsets the Response realm_can_invite_users_group.

Present if realm is present in fetch_event_types.

A group-setting value defining the set of users who have permission to send email invitations for inviting other users to the organization.

Changes: New in Zulip 10.0 (feature level 321).

Previously, this permission was controlled by the enum invite_to_realm_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 6=Nobody.

Before Zulip 4.0 (feature level 50), the invite_by_admins_only boolean setting controlled this permission; true corresponded to Admins, and false to Members.

pub fn with_realm_can_invite_users_group(self, val: GroupSetting) -> Self

Builder function that sets the Response realm_can_invite_users_group.

Present if realm is present in fetch_event_types.

A group-setting value defining the set of users who have permission to send email invitations for inviting other users to the organization.

Changes: New in Zulip 10.0 (feature level 321).

Previously, this permission was controlled by the enum invite_to_realm_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 6=Nobody.

Before Zulip 4.0 (feature level 50), the invite_by_admins_only boolean setting controlled this permission; true corresponded to Admins, and false to Members.

pub fn realm_can_mention_many_users_group(&self) -> Option<&GroupSetting>

Gets the Response realm_can_mention_many_users_group.

A group-setting value defining the set of users who have permission to use wildcard mentions in large channels.

Present if realm is present in fetch_event_types.

All users will receive a warning/reminder when using mentions in large channels, even when permitted to do so.

Changes: New in Zulip 10.0 (feature level 352).

Previously, this permission was controlled by the enum wildcard_mention_policy.

pub fn set_realm_can_mention_many_users_group(&mut self, val: GroupSetting)

Sets the Response realm_can_mention_many_users_group.

A group-setting value defining the set of users who have permission to use wildcard mentions in large channels.

Present if realm is present in fetch_event_types.

All users will receive a warning/reminder when using mentions in large channels, even when permitted to do so.

Changes: New in Zulip 10.0 (feature level 352).

Previously, this permission was controlled by the enum wildcard_mention_policy.

pub fn unset_realm_can_mention_many_users_group( &mut self, ) -> Option<GroupSetting>

Unsets the Response realm_can_mention_many_users_group.

A group-setting value defining the set of users who have permission to use wildcard mentions in large channels.

Present if realm is present in fetch_event_types.

All users will receive a warning/reminder when using mentions in large channels, even when permitted to do so.

Changes: New in Zulip 10.0 (feature level 352).

Previously, this permission was controlled by the enum wildcard_mention_policy.

pub fn with_realm_can_mention_many_users_group(self, val: GroupSetting) -> Self

Builder function that sets the Response realm_can_mention_many_users_group.

A group-setting value defining the set of users who have permission to use wildcard mentions in large channels.

Present if realm is present in fetch_event_types.

All users will receive a warning/reminder when using mentions in large channels, even when permitted to do so.

Changes: New in Zulip 10.0 (feature level 352).

Previously, this permission was controlled by the enum wildcard_mention_policy.

pub fn realm_can_move_messages_between_channels_group( &self, ) -> Option<&GroupSetting>

Gets the Response realm_can_move_messages_between_channels_group.

A group-setting value defining the set of users who have permission to move messages from one channel to another in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 310).

Previously, this permission was controlled by the enum move_messages_between_streams_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 6=Nobody.

In Zulip 7.0 (feature level 159), Nobody was added as an option to move_messages_between_streams_policy enum.

pub fn set_realm_can_move_messages_between_channels_group( &mut self, val: GroupSetting, )

Sets the Response realm_can_move_messages_between_channels_group.

A group-setting value defining the set of users who have permission to move messages from one channel to another in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 310).

Previously, this permission was controlled by the enum move_messages_between_streams_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 6=Nobody.

In Zulip 7.0 (feature level 159), Nobody was added as an option to move_messages_between_streams_policy enum.

pub fn unset_realm_can_move_messages_between_channels_group( &mut self, ) -> Option<GroupSetting>

Unsets the Response realm_can_move_messages_between_channels_group.

A group-setting value defining the set of users who have permission to move messages from one channel to another in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 310).

Previously, this permission was controlled by the enum move_messages_between_streams_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 6=Nobody.

In Zulip 7.0 (feature level 159), Nobody was added as an option to move_messages_between_streams_policy enum.

pub fn with_realm_can_move_messages_between_channels_group( self, val: GroupSetting, ) -> Self

Builder function that sets the Response realm_can_move_messages_between_channels_group.

A group-setting value defining the set of users who have permission to move messages from one channel to another in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 310).

Previously, this permission was controlled by the enum move_messages_between_streams_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 6=Nobody.

In Zulip 7.0 (feature level 159), Nobody was added as an option to move_messages_between_streams_policy enum.

pub fn realm_can_move_messages_between_topics_group( &self, ) -> Option<&GroupSetting>

Gets the Response realm_can_move_messages_between_topics_group.

A group-setting value defining the set of users who have permission to move messages from one topic to another within a channel in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 316).

Previously, this permission was controlled by the enum edit_topic_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 5=Everyone, 6=Nobody.

In Zulip 7.0 (feature level 159), Nobody was added as an option to edit_topic_policy enum.

pub fn set_realm_can_move_messages_between_topics_group( &mut self, val: GroupSetting, )

Sets the Response realm_can_move_messages_between_topics_group.

A group-setting value defining the set of users who have permission to move messages from one topic to another within a channel in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 316).

Previously, this permission was controlled by the enum edit_topic_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 5=Everyone, 6=Nobody.

In Zulip 7.0 (feature level 159), Nobody was added as an option to edit_topic_policy enum.

pub fn unset_realm_can_move_messages_between_topics_group( &mut self, ) -> Option<GroupSetting>

Unsets the Response realm_can_move_messages_between_topics_group.

A group-setting value defining the set of users who have permission to move messages from one topic to another within a channel in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 316).

Previously, this permission was controlled by the enum edit_topic_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 5=Everyone, 6=Nobody.

In Zulip 7.0 (feature level 159), Nobody was added as an option to edit_topic_policy enum.

pub fn with_realm_can_move_messages_between_topics_group( self, val: GroupSetting, ) -> Self

Builder function that sets the Response realm_can_move_messages_between_topics_group.

A group-setting value defining the set of users who have permission to move messages from one topic to another within a channel in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 316).

Previously, this permission was controlled by the enum edit_topic_policy.

Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 5=Everyone, 6=Nobody.

In Zulip 7.0 (feature level 159), Nobody was added as an option to edit_topic_policy enum.

pub fn realm_can_create_groups(&self) -> Option<&GroupSetting>

Gets the Response realm_can_create_groups.

A group-setting value defining the set of users who have permission to create user groups in this organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 299).

Previously realm_user_group_edit_policy field used to control the permission to create user groups.

pub fn set_realm_can_create_groups(&mut self, val: GroupSetting)

Sets the Response realm_can_create_groups.

A group-setting value defining the set of users who have permission to create user groups in this organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 299).

Previously realm_user_group_edit_policy field used to control the permission to create user groups.

pub fn unset_realm_can_create_groups(&mut self) -> Option<GroupSetting>

Unsets the Response realm_can_create_groups.

A group-setting value defining the set of users who have permission to create user groups in this organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 299).

Previously realm_user_group_edit_policy field used to control the permission to create user groups.

pub fn with_realm_can_create_groups(self, val: GroupSetting) -> Self

Builder function that sets the Response realm_can_create_groups.

A group-setting value defining the set of users who have permission to create user groups in this organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 299).

Previously realm_user_group_edit_policy field used to control the permission to create user groups.

pub fn realm_can_create_bots_group(&self) -> Option<&GroupSetting>

Gets the Response realm_can_create_bots_group.

A group-setting value defining the set of users who have permission to create all types of bot users in the organization.

Present if realm is present in fetch_event_types.

See also can_create_write_only_bots_group.

Changes: New in Zulip 10.0 (feature level 344).

Previously, this permission was controlled by the enum bot_creation_policy.

Values were 1=Members, 2=Generic bots limited to administrators, 3=Administrators.

pub fn set_realm_can_create_bots_group(&mut self, val: GroupSetting)

Sets the Response realm_can_create_bots_group.

A group-setting value defining the set of users who have permission to create all types of bot users in the organization.

Present if realm is present in fetch_event_types.

See also can_create_write_only_bots_group.

Changes: New in Zulip 10.0 (feature level 344).

Previously, this permission was controlled by the enum bot_creation_policy.

Values were 1=Members, 2=Generic bots limited to administrators, 3=Administrators.

pub fn unset_realm_can_create_bots_group(&mut self) -> Option<GroupSetting>

Unsets the Response realm_can_create_bots_group.

A group-setting value defining the set of users who have permission to create all types of bot users in the organization.

Present if realm is present in fetch_event_types.

See also can_create_write_only_bots_group.

Changes: New in Zulip 10.0 (feature level 344).

Previously, this permission was controlled by the enum bot_creation_policy.

Values were 1=Members, 2=Generic bots limited to administrators, 3=Administrators.

pub fn with_realm_can_create_bots_group(self, val: GroupSetting) -> Self

Builder function that sets the Response realm_can_create_bots_group.

A group-setting value defining the set of users who have permission to create all types of bot users in the organization.

Present if realm is present in fetch_event_types.

See also can_create_write_only_bots_group.

Changes: New in Zulip 10.0 (feature level 344).

Previously, this permission was controlled by the enum bot_creation_policy.

Values were 1=Members, 2=Generic bots limited to administrators, 3=Administrators.

pub fn realm_can_create_write_only_bots_group(&self) -> Option<&GroupSetting>

Gets the Response realm_can_create_write_only_bots_group.

A group-setting value defining the set of users who have permission to create bot users that can only send messages in the organization, i.e. incoming webhooks, in addition to the users who are present in can_create_bots_group.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 344).

Previously, this permission was controlled by the enum bot_creation_policy.

Values were 1=Members, 2=Generic bots limited to administrators, 3=Administrators.

pub fn set_realm_can_create_write_only_bots_group(&mut self, val: GroupSetting)

Sets the Response realm_can_create_write_only_bots_group.

A group-setting value defining the set of users who have permission to create bot users that can only send messages in the organization, i.e. incoming webhooks, in addition to the users who are present in can_create_bots_group.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 344).

Previously, this permission was controlled by the enum bot_creation_policy.

Values were 1=Members, 2=Generic bots limited to administrators, 3=Administrators.

pub fn unset_realm_can_create_write_only_bots_group( &mut self, ) -> Option<GroupSetting>

Unsets the Response realm_can_create_write_only_bots_group.

A group-setting value defining the set of users who have permission to create bot users that can only send messages in the organization, i.e. incoming webhooks, in addition to the users who are present in can_create_bots_group.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 344).

Previously, this permission was controlled by the enum bot_creation_policy.

Values were 1=Members, 2=Generic bots limited to administrators, 3=Administrators.

pub fn with_realm_can_create_write_only_bots_group( self, val: GroupSetting, ) -> Self

Builder function that sets the Response realm_can_create_write_only_bots_group.

A group-setting value defining the set of users who have permission to create bot users that can only send messages in the organization, i.e. incoming webhooks, in addition to the users who are present in can_create_bots_group.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 344).

Previously, this permission was controlled by the enum bot_creation_policy.

Values were 1=Members, 2=Generic bots limited to administrators, 3=Administrators.

pub fn realm_can_manage_all_groups(&self) -> Option<&GroupSetting>

Gets the Response realm_can_manage_all_groups.

A group-setting value defining the set of users who have permission to administer all existing groups in this organization.

Present if realm is present in fetch_event_types.

Changes: Prior to Zulip 10.0 (feature level 305), only users who were a member of the group or had the moderator role or above could exercise the permission on a given group.

New in Zulip 10.0 (feature level 299).

Previously the user_group_edit_policy field controlled the permission to manage user groups.

Valid values were as follows:

• 1 = All members can create and edit user groups

• 2 = Only organization administrators can create and edit user groups

• 3 = Only full members can create and edit user groups.

• 4 = Only organization administrators and moderators can create and edit user groups.

pub fn set_realm_can_manage_all_groups(&mut self, val: GroupSetting)

Sets the Response realm_can_manage_all_groups.

A group-setting value defining the set of users who have permission to administer all existing groups in this organization.

Present if realm is present in fetch_event_types.

Changes: Prior to Zulip 10.0 (feature level 305), only users who were a member of the group or had the moderator role or above could exercise the permission on a given group.

New in Zulip 10.0 (feature level 299).

Previously the user_group_edit_policy field controlled the permission to manage user groups.

Valid values were as follows:

• 1 = All members can create and edit user groups

• 2 = Only organization administrators can create and edit user groups

• 3 = Only full members can create and edit user groups.

• 4 = Only organization administrators and moderators can create and edit user groups.

pub fn unset_realm_can_manage_all_groups(&mut self) -> Option<GroupSetting>

Unsets the Response realm_can_manage_all_groups.

A group-setting value defining the set of users who have permission to administer all existing groups in this organization.

Present if realm is present in fetch_event_types.

Changes: Prior to Zulip 10.0 (feature level 305), only users who were a member of the group or had the moderator role or above could exercise the permission on a given group.

New in Zulip 10.0 (feature level 299).

Previously the user_group_edit_policy field controlled the permission to manage user groups.

Valid values were as follows:

• 1 = All members can create and edit user groups

• 2 = Only organization administrators can create and edit user groups

• 3 = Only full members can create and edit user groups.

• 4 = Only organization administrators and moderators can create and edit user groups.

pub fn with_realm_can_manage_all_groups(self, val: GroupSetting) -> Self

Builder function that sets the Response realm_can_manage_all_groups.

A group-setting value defining the set of users who have permission to administer all existing groups in this organization.

Present if realm is present in fetch_event_types.

Changes: Prior to Zulip 10.0 (feature level 305), only users who were a member of the group or had the moderator role or above could exercise the permission on a given group.

New in Zulip 10.0 (feature level 299).

Previously the user_group_edit_policy field controlled the permission to manage user groups.

Valid values were as follows:

• 1 = All members can create and edit user groups

• 2 = Only organization administrators can create and edit user groups

• 3 = Only full members can create and edit user groups.

• 4 = Only organization administrators and moderators can create and edit user groups.

pub fn realm_can_manage_billing_group(&self) -> Option<&GroupSetting>

Gets the Response realm_can_manage_billing_group.

A group-setting value defining the set of users who have permission to manage plans and billing in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 363).

Previously, only owners and users with is_billing_admin property set to true were allowed to manage plans and billing.

pub fn set_realm_can_manage_billing_group(&mut self, val: GroupSetting)

Sets the Response realm_can_manage_billing_group.

A group-setting value defining the set of users who have permission to manage plans and billing in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 363).

Previously, only owners and users with is_billing_admin property set to true were allowed to manage plans and billing.

pub fn unset_realm_can_manage_billing_group(&mut self) -> Option<GroupSetting>

Unsets the Response realm_can_manage_billing_group.

A group-setting value defining the set of users who have permission to manage plans and billing in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 363).

Previously, only owners and users with is_billing_admin property set to true were allowed to manage plans and billing.

pub fn with_realm_can_manage_billing_group(self, val: GroupSetting) -> Self

Builder function that sets the Response realm_can_manage_billing_group.

A group-setting value defining the set of users who have permission to manage plans and billing in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 363).

Previously, only owners and users with is_billing_admin property set to true were allowed to manage plans and billing.

pub fn realm_can_create_public_channel_group(&self) -> Option<&GroupSetting>

Gets the Response realm_can_create_public_channel_group.

A group-setting value defining the set of users who have permission to create public channels in this organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 9.0 (feature level 264).

Previously realm_create_public_stream_policy field used to control the permission to create public channels.

pub fn set_realm_can_create_public_channel_group(&mut self, val: GroupSetting)

Sets the Response realm_can_create_public_channel_group.

A group-setting value defining the set of users who have permission to create public channels in this organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 9.0 (feature level 264).

Previously realm_create_public_stream_policy field used to control the permission to create public channels.

pub fn unset_realm_can_create_public_channel_group( &mut self, ) -> Option<GroupSetting>

Unsets the Response realm_can_create_public_channel_group.

A group-setting value defining the set of users who have permission to create public channels in this organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 9.0 (feature level 264).

Previously realm_create_public_stream_policy field used to control the permission to create public channels.

pub fn with_realm_can_create_public_channel_group( self, val: GroupSetting, ) -> Self

Builder function that sets the Response realm_can_create_public_channel_group.

A group-setting value defining the set of users who have permission to create public channels in this organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 9.0 (feature level 264).

Previously realm_create_public_stream_policy field used to control the permission to create public channels.

pub fn realm_can_create_private_channel_group(&self) -> Option<&GroupSetting>

Gets the Response realm_can_create_private_channel_group.

A group-setting value defining the set of users who have permission to create private channels in this organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 9.0 (feature level 266). Previously realm_create_private_stream_policy field used to control the permission to create private channels.

pub fn set_realm_can_create_private_channel_group(&mut self, val: GroupSetting)

Sets the Response realm_can_create_private_channel_group.

A group-setting value defining the set of users who have permission to create private channels in this organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 9.0 (feature level 266). Previously realm_create_private_stream_policy field used to control the permission to create private channels.

pub fn unset_realm_can_create_private_channel_group( &mut self, ) -> Option<GroupSetting>

Unsets the Response realm_can_create_private_channel_group.

A group-setting value defining the set of users who have permission to create private channels in this organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 9.0 (feature level 266). Previously realm_create_private_stream_policy field used to control the permission to create private channels.

pub fn with_realm_can_create_private_channel_group( self, val: GroupSetting, ) -> Self

Builder function that sets the Response realm_can_create_private_channel_group.

A group-setting value defining the set of users who have permission to create private channels in this organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 9.0 (feature level 266). Previously realm_create_private_stream_policy field used to control the permission to create private channels.

pub fn realm_can_create_web_public_channel_group(&self) -> Option<&GroupSetting>

Gets the Response realm_can_create_web_public_channel_group.

A group-setting value defining the set of users who have permission to create web-public channels in this organization.

Present if realm is present in fetch_event_types.

Has no effect and should not be displayed in settings UI unless the Zulip server has the WEB_PUBLIC_STREAMS_ENABLED

server-level setting enabled and the organization has enabled the enable_spectator_access realm setting.

Changes: New in Zulip 10.0 (feature level 280).

Previously realm_create_web_public_stream_policy field used to control the permission to create web-public channels.

pub fn set_realm_can_create_web_public_channel_group( &mut self, val: GroupSetting, )

Sets the Response realm_can_create_web_public_channel_group.

A group-setting value defining the set of users who have permission to create web-public channels in this organization.

Present if realm is present in fetch_event_types.

Has no effect and should not be displayed in settings UI unless the Zulip server has the WEB_PUBLIC_STREAMS_ENABLED

server-level setting enabled and the organization has enabled the enable_spectator_access realm setting.

Changes: New in Zulip 10.0 (feature level 280).

Previously realm_create_web_public_stream_policy field used to control the permission to create web-public channels.

pub fn unset_realm_can_create_web_public_channel_group( &mut self, ) -> Option<GroupSetting>

Unsets the Response realm_can_create_web_public_channel_group.

A group-setting value defining the set of users who have permission to create web-public channels in this organization.

Present if realm is present in fetch_event_types.

Has no effect and should not be displayed in settings UI unless the Zulip server has the WEB_PUBLIC_STREAMS_ENABLED

server-level setting enabled and the organization has enabled the enable_spectator_access realm setting.

Changes: New in Zulip 10.0 (feature level 280).

Previously realm_create_web_public_stream_policy field used to control the permission to create web-public channels.

pub fn with_realm_can_create_web_public_channel_group( self, val: GroupSetting, ) -> Self

Builder function that sets the Response realm_can_create_web_public_channel_group.

A group-setting value defining the set of users who have permission to create web-public channels in this organization.

Present if realm is present in fetch_event_types.

Has no effect and should not be displayed in settings UI unless the Zulip server has the WEB_PUBLIC_STREAMS_ENABLED

server-level setting enabled and the organization has enabled the enable_spectator_access realm setting.

Changes: New in Zulip 10.0 (feature level 280).

Previously realm_create_web_public_stream_policy field used to control the permission to create web-public channels.

pub fn realm_can_resolve_topics_group(&self) -> Option<&GroupSetting>

Gets the Response realm_can_resolve_topics_group.

A group-setting value defining the set of users who have permission to resolve topics in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 367).

Previously, permission to resolve topics was controlled by the more general can_move_messages_between_topics_group permission for moving messages.

pub fn set_realm_can_resolve_topics_group(&mut self, val: GroupSetting)

Sets the Response realm_can_resolve_topics_group.

A group-setting value defining the set of users who have permission to resolve topics in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 367).

Previously, permission to resolve topics was controlled by the more general can_move_messages_between_topics_group permission for moving messages.

pub fn unset_realm_can_resolve_topics_group(&mut self) -> Option<GroupSetting>

Unsets the Response realm_can_resolve_topics_group.

A group-setting value defining the set of users who have permission to resolve topics in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 367).

Previously, permission to resolve topics was controlled by the more general can_move_messages_between_topics_group permission for moving messages.

pub fn with_realm_can_resolve_topics_group(self, val: GroupSetting) -> Self

Builder function that sets the Response realm_can_resolve_topics_group.

A group-setting value defining the set of users who have permission to resolve topics in the organization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 367).

Previously, permission to resolve topics was controlled by the more general can_move_messages_between_topics_group permission for moving messages.

pub fn realm_direct_message_permission_group(&self) -> Option<&GroupSetting>

Gets the Response realm_direct_message_permission_group.

A group-setting value defining the set of users who have permission to fully use direct messages.

Present if realm is present in fetch_event_types.

Users outside this group can only send direct messages to conversations where all the recipients are in this group, are bots,

or are the sender, ensuring that every direct message conversation will be visible to at least one user in this group.

Changes: New in Zulip 9.0 (feature level 270).

Previously, access to send direct messages was controlled by the private_message_policy realm setting, which supported values of 1 (enabled) and 2 (disabled).

pub fn set_realm_direct_message_permission_group(&mut self, val: GroupSetting)

Sets the Response realm_direct_message_permission_group.

A group-setting value defining the set of users who have permission to fully use direct messages.

Present if realm is present in fetch_event_types.

Users outside this group can only send direct messages to conversations where all the recipients are in this group, are bots,

or are the sender, ensuring that every direct message conversation will be visible to at least one user in this group.

Changes: New in Zulip 9.0 (feature level 270).

Previously, access to send direct messages was controlled by the private_message_policy realm setting, which supported values of 1 (enabled) and 2 (disabled).

pub fn unset_realm_direct_message_permission_group( &mut self, ) -> Option<GroupSetting>

Unsets the Response realm_direct_message_permission_group.

A group-setting value defining the set of users who have permission to fully use direct messages.

Present if realm is present in fetch_event_types.

Users outside this group can only send direct messages to conversations where all the recipients are in this group, are bots,

or are the sender, ensuring that every direct message conversation will be visible to at least one user in this group.

Changes: New in Zulip 9.0 (feature level 270).

Previously, access to send direct messages was controlled by the private_message_policy realm setting, which supported values of 1 (enabled) and 2 (disabled).

pub fn with_realm_direct_message_permission_group( self, val: GroupSetting, ) -> Self

Builder function that sets the Response realm_direct_message_permission_group.

A group-setting value defining the set of users who have permission to fully use direct messages.

Present if realm is present in fetch_event_types.

Users outside this group can only send direct messages to conversations where all the recipients are in this group, are bots,

or are the sender, ensuring that every direct message conversation will be visible to at least one user in this group.

Changes: New in Zulip 9.0 (feature level 270).

Previously, access to send direct messages was controlled by the private_message_policy realm setting, which supported values of 1 (enabled) and 2 (disabled).

pub fn realm_create_multiuse_invite_group(&self) -> Option<&GroupSetting>

Gets the Response realm_create_multiuse_invite_group.

A group-setting value defining the set of users who are allowed to create

reusable invitation links to the organization.

Present if realm is present in fetch_event_types.

Changes: Prior to Zulip 10.0 (feature level 314), this value used to be of type integer and did not accept anonymous user groups. New in Zulip 8.0 (feature level 209).

pub fn set_realm_create_multiuse_invite_group(&mut self, val: GroupSetting)

Sets the Response realm_create_multiuse_invite_group.

A group-setting value defining the set of users who are allowed to create

reusable invitation links to the organization.

Present if realm is present in fetch_event_types.

Changes: Prior to Zulip 10.0 (feature level 314), this value used to be of type integer and did not accept anonymous user groups. New in Zulip 8.0 (feature level 209).

pub fn unset_realm_create_multiuse_invite_group( &mut self, ) -> Option<GroupSetting>

Unsets the Response realm_create_multiuse_invite_group.

A group-setting value defining the set of users who are allowed to create

reusable invitation links to the organization.

Present if realm is present in fetch_event_types.

Changes: Prior to Zulip 10.0 (feature level 314), this value used to be of type integer and did not accept anonymous user groups. New in Zulip 8.0 (feature level 209).

pub fn with_realm_create_multiuse_invite_group(self, val: GroupSetting) -> Self

Builder function that sets the Response realm_create_multiuse_invite_group.

A group-setting value defining the set of users who are allowed to create

reusable invitation links to the organization.

Present if realm is present in fetch_event_types.

Changes: Prior to Zulip 10.0 (feature level 314), this value used to be of type integer and did not accept anonymous user groups. New in Zulip 8.0 (feature level 209).

pub fn realm_authentication_methods( &self, ) -> Option<&HashMap<String, RealmAuthenticationMethod>>

Gets the Response realm_authentication_methods.

Dictionary of authentication method keys mapped to dictionaries that describe the properties of the named authentication method for the organization

• its enabled status and availability for use by the organization.

Present if realm is present in fetch_event_types.

Clients should use this to implement server-settings UI to change which methods are enabled for the organization.

For authentication UI itself, clients should use the pre-authentication metadata returned by GET /server_settings.

Changes: In Zulip 9.0 (feature level 241), the values in this dictionary were changed.

Previously, the values were a simple boolean indicating whether the backend is enabled or not.

pub fn set_realm_authentication_methods( &mut self, val: HashMap<String, RealmAuthenticationMethod>, )

Sets the Response realm_authentication_methods.

Dictionary of authentication method keys mapped to dictionaries that describe the properties of the named authentication method for the organization

• its enabled status and availability for use by the organization.

Present if realm is present in fetch_event_types.

Clients should use this to implement server-settings UI to change which methods are enabled for the organization.

For authentication UI itself, clients should use the pre-authentication metadata returned by GET /server_settings.

Changes: In Zulip 9.0 (feature level 241), the values in this dictionary were changed.

Previously, the values were a simple boolean indicating whether the backend is enabled or not.

pub fn unset_realm_authentication_methods( &mut self, ) -> Option<HashMap<String, RealmAuthenticationMethod>>

Unsets the Response realm_authentication_methods.

Dictionary of authentication method keys mapped to dictionaries that describe the properties of the named authentication method for the organization

• its enabled status and availability for use by the organization.

Present if realm is present in fetch_event_types.

Clients should use this to implement server-settings UI to change which methods are enabled for the organization.

For authentication UI itself, clients should use the pre-authentication metadata returned by GET /server_settings.

Changes: In Zulip 9.0 (feature level 241), the values in this dictionary were changed.

Previously, the values were a simple boolean indicating whether the backend is enabled or not.

pub fn with_realm_authentication_methods( self, val: HashMap<String, RealmAuthenticationMethod>, ) -> Self

Builder function that sets the Response realm_authentication_methods.

Dictionary of authentication method keys mapped to dictionaries that describe the properties of the named authentication method for the organization

• its enabled status and availability for use by the organization.

Present if realm is present in fetch_event_types.

Clients should use this to implement server-settings UI to change which methods are enabled for the organization.

For authentication UI itself, clients should use the pre-authentication metadata returned by GET /server_settings.

Changes: In Zulip 9.0 (feature level 241), the values in this dictionary were changed.

Previously, the values were a simple boolean indicating whether the backend is enabled or not.

pub fn realm_available_video_chat_providers( &self, ) -> Option<&HashMap<String, RealmAvailableVideoChatProvider>>

Gets the Response realm_available_video_chat_providers.

Dictionary where each entry describes a supported video call provider

that is configured on this server and could be selected by an organization administrator.

Present if realm is present in fetch_event_types.

Useful for administrative settings UI that allows changing the realm setting video_chat_provider.

pub fn set_realm_available_video_chat_providers( &mut self, val: HashMap<String, RealmAvailableVideoChatProvider>, )

Sets the Response realm_available_video_chat_providers.

Dictionary where each entry describes a supported video call provider

that is configured on this server and could be selected by an organization administrator.

Present if realm is present in fetch_event_types.

Useful for administrative settings UI that allows changing the realm setting video_chat_provider.

pub fn unset_realm_available_video_chat_providers( &mut self, ) -> Option<HashMap<String, RealmAvailableVideoChatProvider>>

Unsets the Response realm_available_video_chat_providers.

Dictionary where each entry describes a supported video call provider

that is configured on this server and could be selected by an organization administrator.

Present if realm is present in fetch_event_types.

Useful for administrative settings UI that allows changing the realm setting video_chat_provider.

pub fn with_realm_available_video_chat_providers( self, val: HashMap<String, RealmAvailableVideoChatProvider>, ) -> Self

Builder function that sets the Response realm_available_video_chat_providers.

Dictionary where each entry describes a supported video call provider

that is configured on this server and could be selected by an organization administrator.

Present if realm is present in fetch_event_types.

Useful for administrative settings UI that allows changing the realm setting video_chat_provider.

pub fn realm_can_access_all_users_group(&self) -> Option<&GroupSetting>

Gets the Response realm_can_access_all_users_group.

A group-setting value defining the set of users who are allowed to access all users in the organization.

Present if realm is present in fetch_event_types.

Changes: Prior to Zulip 10.0 (feature level 314), this value used to be of type integer and did not accept anonymous user groups.

New in Zulip 8.0 (feature level 225).

pub fn set_realm_can_access_all_users_group(&mut self, val: GroupSetting)

Sets the Response realm_can_access_all_users_group.

A group-setting value defining the set of users who are allowed to access all users in the organization.

Present if realm is present in fetch_event_types.

Changes: Prior to Zulip 10.0 (feature level 314), this value used to be of type integer and did not accept anonymous user groups.

New in Zulip 8.0 (feature level 225).

pub fn unset_realm_can_access_all_users_group(&mut self) -> Option<GroupSetting>

Unsets the Response realm_can_access_all_users_group.

A group-setting value defining the set of users who are allowed to access all users in the organization.

Present if realm is present in fetch_event_types.

Changes: Prior to Zulip 10.0 (feature level 314), this value used to be of type integer and did not accept anonymous user groups.

New in Zulip 8.0 (feature level 225).

pub fn with_realm_can_access_all_users_group(self, val: GroupSetting) -> Self

Builder function that sets the Response realm_can_access_all_users_group.

A group-setting value defining the set of users who are allowed to access all users in the organization.

Present if realm is present in fetch_event_types.

Changes: Prior to Zulip 10.0 (feature level 314), this value used to be of type integer and did not accept anonymous user groups.

New in Zulip 8.0 (feature level 225).

pub fn realm_can_summarize_topics_group(&self) -> Option<&GroupSetting>

Gets the Response realm_can_summarize_topics_group.

A group-setting value defining the set of users who are allowed to use AI summarization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 350).

pub fn set_realm_can_summarize_topics_group(&mut self, val: GroupSetting)

Sets the Response realm_can_summarize_topics_group.

A group-setting value defining the set of users who are allowed to use AI summarization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 350).

pub fn unset_realm_can_summarize_topics_group(&mut self) -> Option<GroupSetting>

Unsets the Response realm_can_summarize_topics_group.

A group-setting value defining the set of users who are allowed to use AI summarization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 350).

pub fn with_realm_can_summarize_topics_group(self, val: GroupSetting) -> Self

Builder function that sets the Response realm_can_summarize_topics_group.

A group-setting value defining the set of users who are allowed to use AI summarization.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 350).

pub fn realm_default_external_accounts( &self, ) -> Option<&HashMap<String, RealmDefaultExternalAccount>>

Gets the Response realm_default_external_accounts.

Dictionary where each entry describes a default external account type that can be configured with Zulip’s custom profile fields feature.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 2.1.0.

pub fn set_realm_default_external_accounts( &mut self, val: HashMap<String, RealmDefaultExternalAccount>, )

Sets the Response realm_default_external_accounts.

Dictionary where each entry describes a default external account type that can be configured with Zulip’s custom profile fields feature.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 2.1.0.

pub fn unset_realm_default_external_accounts( &mut self, ) -> Option<HashMap<String, RealmDefaultExternalAccount>>

Unsets the Response realm_default_external_accounts.

Dictionary where each entry describes a default external account type that can be configured with Zulip’s custom profile fields feature.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 2.1.0.

pub fn with_realm_default_external_accounts( self, val: HashMap<String, RealmDefaultExternalAccount>, ) -> Self

Builder function that sets the Response realm_default_external_accounts.

Dictionary where each entry describes a default external account type that can be configured with Zulip’s custom profile fields feature.

Present if realm is present in fetch_event_types.

Changes: New in Zulip 2.1.0.

pub fn giphy_rating_options( &self, ) -> Option<&HashMap<String, GiphyRatingOption>>

Gets the Response giphy_rating_options.

Dictionary where each entry describes a valid rating that is configured on this server and could be selected by an organization administrator.

Present if realm is present in fetch_event_types.

Useful for administrative settings UI that allows changing the allowed rating of GIFs.

pub fn set_giphy_rating_options( &mut self, val: HashMap<String, GiphyRatingOption>, )

Sets the Response giphy_rating_options.

Dictionary where each entry describes a valid rating that is configured on this server and could be selected by an organization administrator.

Present if realm is present in fetch_event_types.

Useful for administrative settings UI that allows changing the allowed rating of GIFs.

pub fn unset_giphy_rating_options( &mut self, ) -> Option<HashMap<String, GiphyRatingOption>>

Unsets the Response giphy_rating_options.

Dictionary where each entry describes a valid rating that is configured on this server and could be selected by an organization administrator.

Present if realm is present in fetch_event_types.

Useful for administrative settings UI that allows changing the allowed rating of GIFs.

pub fn with_giphy_rating_options( self, val: HashMap<String, GiphyRatingOption>, ) -> Self

Builder function that sets the Response giphy_rating_options.

Dictionary where each entry describes a valid rating that is configured on this server and could be selected by an organization administrator.

Present if realm is present in fetch_event_types.

Useful for administrative settings UI that allows changing the allowed rating of GIFs.

pub fn realm_billing(&self) -> Option<&RealmBilling>

Gets the Response realm_billing.

A dictionary containing billing information of the organization.

Present if realm_billing is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 363).

pub fn set_realm_billing(&mut self, val: RealmBilling)

Sets the Response realm_billing.

A dictionary containing billing information of the organization.

Present if realm_billing is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 363).

pub fn unset_realm_billing(&mut self) -> Option<RealmBilling>

Unsets the Response realm_billing.

A dictionary containing billing information of the organization.

Present if realm_billing is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 363).

pub fn with_realm_billing(self, val: RealmBilling) -> Self

Builder function that sets the Response realm_billing.

A dictionary containing billing information of the organization.

Present if realm_billing is present in fetch_event_types.

Changes: New in Zulip 10.0 (feature level 363).

pub fn realm_user_settings_defaults(&self) -> Option<&RealmUserSettingsDefault>

Gets the Response realm_user_settings_defaults.

A dictionary containing the default values of settings for new users.

Present if realm_user_settings_defaults is present in fetch_event_types.

Changes: New in Zulip 5.0 (feature level 95).

pub fn set_realm_user_settings_defaults( &mut self, val: RealmUserSettingsDefault, )

Sets the Response realm_user_settings_defaults.

A dictionary containing the default values of settings for new users.

Present if realm_user_settings_defaults is present in fetch_event_types.

Changes: New in Zulip 5.0 (feature level 95).

pub fn unset_realm_user_settings_defaults( &mut self, ) -> Option<RealmUserSettingsDefault>

Unsets the Response realm_user_settings_defaults.

A dictionary containing the default values of settings for new users.

Present if realm_user_settings_defaults is present in fetch_event_types.

Changes: New in Zulip 5.0 (feature level 95).

pub fn with_realm_user_settings_defaults( self, val: RealmUserSettingsDefault, ) -> Self

Builder function that sets the Response realm_user_settings_defaults.

A dictionary containing the default values of settings for new users.

Present if realm_user_settings_defaults is present in fetch_event_types.

Changes: New in Zulip 5.0 (feature level 95).

pub fn server_supported_permission_settings( &self, ) -> Option<&ServerSupportedPermissionSetting>

Gets the Response server_supported_permission_settings.

Present if realm is present in fetch_event_types.

Metadata detailing the valid values for permission settings that

use group-setting values. Clients

should use these data as explained in the

main documentation

to determine what values to present as possible values for these

settings in UI components.

Changes: Before Zulip 10.0 (feature level 326), this part of

the response had a documented-as-unstable format not suitable

for general client use, and should be ignored.

New in Zulip 8.0 (feature level 221).

pub fn set_server_supported_permission_settings( &mut self, val: ServerSupportedPermissionSetting, )

Sets the Response server_supported_permission_settings.

Present if realm is present in fetch_event_types.

Metadata detailing the valid values for permission settings that

use group-setting values. Clients

should use these data as explained in the

main documentation

to determine what values to present as possible values for these

settings in UI components.

Changes: Before Zulip 10.0 (feature level 326), this part of

the response had a documented-as-unstable format not suitable

for general client use, and should be ignored.

New in Zulip 8.0 (feature level 221).

pub fn unset_server_supported_permission_settings( &mut self, ) -> Option<ServerSupportedPermissionSetting>

Unsets the Response server_supported_permission_settings.

Present if realm is present in fetch_event_types.

Metadata detailing the valid values for permission settings that

use group-setting values. Clients

should use these data as explained in the

main documentation

to determine what values to present as possible values for these

settings in UI components.

Changes: Before Zulip 10.0 (feature level 326), this part of

the response had a documented-as-unstable format not suitable

for general client use, and should be ignored.

New in Zulip 8.0 (feature level 221).

pub fn with_server_supported_permission_settings( self, val: ServerSupportedPermissionSetting, ) -> Self

Builder function that sets the Response server_supported_permission_settings.

Present if realm is present in fetch_event_types.

Metadata detailing the valid values for permission settings that

use group-setting values. Clients

should use these data as explained in the

main documentation

to determine what values to present as possible values for these

settings in UI components.

Changes: Before Zulip 10.0 (feature level 326), this part of

the response had a documented-as-unstable format not suitable

for general client use, and should be ignored.

New in Zulip 8.0 (feature level 221).

Trait Implementations

impl Clone for Response

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Response

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Response

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Response

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Response

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Response

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Response for Response

fn msg(&self) -> &str

Gets the Response msg field.

fn set_msg<'a, C: Into<Cow<'a, str>>>(&mut self, msg: C)

Sets the Response msg field.

fn with_msg<'a, C: Into<Cow<'a, str>>>(self, msg: C) -> Self

Builder function that sets the Response msg field.

fn result(&self) -> ApiResult

Gets the Response result field.

fn set_result(&mut self, result: ApiResult)

Sets the Response result field.

fn with_result(self, result: ApiResult) -> Self

Builder function that sets the Response result field.

fn code(&self) -> Option<ErrorCode>

Gets the Response code field.

fn set_code(&mut self, code: ErrorCode)

Sets the Response code field.

fn unset_code(&mut self) -> Option<ErrorCode>

Unsets the Response code field.

fn with_code(self, code: ErrorCode) -> Self

Builder function that sets the Response code field.

fn ignored_parameters_unsupported(&self) -> Option<&[String]>

Gets the Response ignored unsupported parameters list.

fn set_ignored_parameters_unsupported<'a, C: Into<Cow<'a, [String]>>>( &mut self, val: C, )

Sets the Response ignored unsupported parameters list.

fn unset_ignored_parameters_unsupported(&mut self) -> Option<Vec<String>>

Unsets the Response ignored unsupported parameters list.

fn with_ignored_parameters_unsupported<'a, C: Into<Cow<'a, [String]>>>( self, val: C, ) -> Self

Builder function that sets the Response ignored unsupported parameters list.

impl Serialize for Response

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Response