pub struct BasicChannel { /* private fields */ }Expand description
Represents basic details about the channel.
Implementations§
Source§impl BasicChannel
impl BasicChannel
Sourcepub const fn new() -> Self
pub const fn new() -> Self
Creates a new BasicChannel.
Source§impl BasicChannel
impl BasicChannel
Sourcepub const fn stream_id(&self) -> Option<u64>
pub const fn stream_id(&self) -> Option<u64>
Gets the BasicChannel stream_id.
The unique ID of the channel.
Sourcepub fn set_stream_id(&mut self, val: u64)
pub fn set_stream_id(&mut self, val: u64)
Sets the BasicChannel stream_id.
The unique ID of the channel.
Sourcepub fn unset_stream_id(&mut self) -> Option<u64>
pub fn unset_stream_id(&mut self) -> Option<u64>
Unsets the BasicChannel stream_id.
The unique ID of the channel.
Sourcepub fn with_stream_id(self, val: u64) -> Self
pub fn with_stream_id(self, val: u64) -> Self
Builder function that sets the BasicChannel stream_id.
The unique ID of the channel.
Sourcepub const fn is_archived(&self) -> Option<bool>
pub const fn is_archived(&self) -> Option<bool>
Gets the BasicChannel is_archived.
A boolean indicating whether the channel is archived.
Changes: New in Zulip 10.0 (feature level 315). Previously, this endpoint never returned archived channels.
Sourcepub fn set_is_archived(&mut self, val: bool)
pub fn set_is_archived(&mut self, val: bool)
Sets the BasicChannel is_archived.
A boolean indicating whether the channel is archived.
Changes: New in Zulip 10.0 (feature level 315). Previously, this endpoint never returned archived channels.
Sourcepub fn unset_is_archived(&mut self) -> Option<bool>
pub fn unset_is_archived(&mut self) -> Option<bool>
Unsets the BasicChannel is_archived.
A boolean indicating whether the channel is archived.
Changes: New in Zulip 10.0 (feature level 315). Previously, this endpoint never returned archived channels.
Sourcepub fn with_is_archived(self, val: bool) -> Self
pub fn with_is_archived(self, val: bool) -> Self
Builder function that sets the BasicChannel is_archived.
A boolean indicating whether the channel is archived.
Changes: New in Zulip 10.0 (feature level 315). Previously, this endpoint never returned archived channels.
Sourcepub const fn date_created(&self) -> Option<u64>
pub const fn date_created(&self) -> Option<u64>
Gets the BasicChannel date_created.
The UNIX timestamp for when the channel was created, in UTC seconds.
Changes: New in Zulip 4.0 (feature level 30).
Sourcepub fn set_date_created(&mut self, val: u64)
pub fn set_date_created(&mut self, val: u64)
Sets the BasicChannel date_created.
The UNIX timestamp for when the channel was created, in UTC seconds.
Changes: New in Zulip 4.0 (feature level 30).
Sourcepub fn unset_date_created(&mut self) -> Option<u64>
pub fn unset_date_created(&mut self) -> Option<u64>
Unsets the BasicChannel date_created.
The UNIX timestamp for when the channel was created, in UTC seconds.
Changes: New in Zulip 4.0 (feature level 30).
Sourcepub fn with_date_created(self, val: u64) -> Self
pub fn with_date_created(self, val: u64) -> Self
Builder function that sets the BasicChannel date_created.
The UNIX timestamp for when the channel was created, in UTC seconds.
Changes: New in Zulip 4.0 (feature level 30).
Sourcepub const fn creator_id(&self) -> Option<u64>
pub const fn creator_id(&self) -> Option<u64>
Gets the BasicChannel creator_id.
The ID of the user who created this channel.
A null value means the channel has no recorded creator, which is often because the channel is very old,
was created during realm creation or because it was created via a data import tool or management command.
Changes: New in Zulip 9.0 (feature level 254).
Sourcepub fn set_creator_id(&mut self, val: u64)
pub fn set_creator_id(&mut self, val: u64)
Sets the BasicChannel creator_id.
The ID of the user who created this channel.
A null value means the channel has no recorded creator, which is often because the channel is very old,
was created during realm creation or because it was created via a data import tool or management command.
Changes: New in Zulip 9.0 (feature level 254).
Sourcepub fn unset_creator_id(&mut self) -> Option<u64>
pub fn unset_creator_id(&mut self) -> Option<u64>
Unsets the BasicChannel creator_id.
The ID of the user who created this channel.
A null value means the channel has no recorded creator, which is often because the channel is very old,
was created during realm creation or because it was created via a data import tool or management command.
Changes: New in Zulip 9.0 (feature level 254).
Sourcepub fn with_creator_id(self, val: u64) -> Self
pub fn with_creator_id(self, val: u64) -> Self
Builder function that sets the BasicChannel creator_id.
The ID of the user who created this channel.
A null value means the channel has no recorded creator, which is often because the channel is very old,
was created during realm creation or because it was created via a data import tool or management command.
Changes: New in Zulip 9.0 (feature level 254).
Sourcepub const fn invite_only(&self) -> Option<bool>
pub const fn invite_only(&self) -> Option<bool>
Gets the BasicChannel invite_only.
Specifies whether the channel is private or not.
Only people who have been invited can access a private channel.
Sourcepub fn set_invite_only(&mut self, val: bool)
pub fn set_invite_only(&mut self, val: bool)
Sets the BasicChannel invite_only.
Specifies whether the channel is private or not.
Only people who have been invited can access a private channel.
Sourcepub fn unset_invite_only(&mut self) -> Option<bool>
pub fn unset_invite_only(&mut self) -> Option<bool>
Unsets the BasicChannel invite_only.
Specifies whether the channel is private or not.
Only people who have been invited can access a private channel.
Sourcepub fn with_invite_only(self, val: bool) -> Self
pub fn with_invite_only(self, val: bool) -> Self
Builder function that sets the BasicChannel invite_only.
Specifies whether the channel is private or not.
Only people who have been invited can access a private channel.
Sourcepub const fn is_web_public(&self) -> Option<bool>
pub const fn is_web_public(&self) -> Option<bool>
Gets the BasicChannel is_web_public.
Whether the channel has been configured to allow unauthenticated access to its message history from the web.
Changes: New in Zulip 2.1.0.
Sourcepub fn set_is_web_public(&mut self, val: bool)
pub fn set_is_web_public(&mut self, val: bool)
Sets the BasicChannel is_web_public.
Whether the channel has been configured to allow unauthenticated access to its message history from the web.
Changes: New in Zulip 2.1.0.
Sourcepub fn unset_is_web_public(&mut self) -> Option<bool>
pub fn unset_is_web_public(&mut self) -> Option<bool>
Unsets the BasicChannel is_web_public.
Whether the channel has been configured to allow unauthenticated access to its message history from the web.
Changes: New in Zulip 2.1.0.
Sourcepub fn with_is_web_public(self, val: bool) -> Self
pub fn with_is_web_public(self, val: bool) -> Self
Builder function that sets the BasicChannel is_web_public.
Whether the channel has been configured to allow unauthenticated access to its message history from the web.
Changes: New in Zulip 2.1.0.
Sourcepub const fn stream_post_policy(&self) -> Option<StreamPostPolicy>
pub const fn stream_post_policy(&self) -> Option<StreamPostPolicy>
Gets the BasicChannel stream_post_policy.
A deprecated representation of a superset of the users who have permission to post messages to the channel available for backwards-compatibility.
Sourcepub fn set_stream_post_policy(&mut self, val: StreamPostPolicy)
pub fn set_stream_post_policy(&mut self, val: StreamPostPolicy)
Sets the BasicChannel stream_post_policy.
A deprecated representation of a superset of the users who have permission to post messages to the channel available for backwards-compatibility.
Sourcepub fn unset_stream_post_policy(&mut self) -> Option<StreamPostPolicy>
pub fn unset_stream_post_policy(&mut self) -> Option<StreamPostPolicy>
Unsets the BasicChannel stream_post_policy.
A deprecated representation of a superset of the users who have permission to post messages to the channel available for backwards-compatibility.
Sourcepub fn with_stream_post_policy(self, val: StreamPostPolicy) -> Self
pub fn with_stream_post_policy(self, val: StreamPostPolicy) -> Self
Builder function that sets the BasicChannel stream_post_policy.
A deprecated representation of a superset of the users who have permission to post messages to the channel available for backwards-compatibility.
Sourcepub const fn message_retention_days(&self) -> Option<i64>
pub const fn message_retention_days(&self) -> Option<i64>
Gets the BasicChannel message_retention_days.
Number of days that messages sent to this channel will be stored before being automatically deleted by the message retention policy.
There are two special values:
-
null, the default, means the channel will inherit the organization level setting. -
-1encodes retaining messages in this channel forever.
Changes: New in Zulip 3.0 (feature level 17).
Sourcepub fn set_message_retention_days(&mut self, val: i64)
pub fn set_message_retention_days(&mut self, val: i64)
Sets the BasicChannel message_retention_days.
Number of days that messages sent to this channel will be stored before being automatically deleted by the message retention policy.
There are two special values:
-
null, the default, means the channel will inherit the organization level setting. -
-1encodes retaining messages in this channel forever.
Changes: New in Zulip 3.0 (feature level 17).
Sourcepub fn unset_message_retention_days(&mut self) -> Option<i64>
pub fn unset_message_retention_days(&mut self) -> Option<i64>
Unsets the BasicChannel message_retention_days.
Number of days that messages sent to this channel will be stored before being automatically deleted by the message retention policy.
There are two special values:
-
null, the default, means the channel will inherit the organization level setting. -
-1encodes retaining messages in this channel forever.
Changes: New in Zulip 3.0 (feature level 17).
Sourcepub fn with_message_retention_days(self, val: i64) -> Self
pub fn with_message_retention_days(self, val: i64) -> Self
Builder function that sets the BasicChannel message_retention_days.
Number of days that messages sent to this channel will be stored before being automatically deleted by the message retention policy.
There are two special values:
-
null, the default, means the channel will inherit the organization level setting. -
-1encodes retaining messages in this channel forever.
Changes: New in Zulip 3.0 (feature level 17).
Sourcepub const fn history_public_to_subscribers(&self) -> Option<bool>
pub const fn history_public_to_subscribers(&self) -> Option<bool>
Gets the BasicChannel history_public_to_subscribers.
Whether the history of the channel is public to its subscribers.
Currently always true for public channels (i.e. \"invite_only\": false implies \"history_public_to_subscribers\": true), but clients should not make that assumption,
as we may change that behavior in the future.
Sourcepub fn set_history_public_to_subscribers(&mut self, val: bool)
pub fn set_history_public_to_subscribers(&mut self, val: bool)
Sets the BasicChannel history_public_to_subscribers.
Whether the history of the channel is public to its subscribers.
Currently always true for public channels (i.e. \"invite_only\": false implies \"history_public_to_subscribers\": true), but clients should not make that assumption,
as we may change that behavior in the future.
Sourcepub fn unset_history_public_to_subscribers(&mut self) -> Option<bool>
pub fn unset_history_public_to_subscribers(&mut self) -> Option<bool>
Unsets the BasicChannel history_public_to_subscribers.
Whether the history of the channel is public to its subscribers.
Currently always true for public channels (i.e. \"invite_only\": false implies \"history_public_to_subscribers\": true), but clients should not make that assumption,
as we may change that behavior in the future.
Sourcepub fn with_history_public_to_subscribers(self, val: bool) -> Self
pub fn with_history_public_to_subscribers(self, val: bool) -> Self
Builder function that sets the BasicChannel history_public_to_subscribers.
Whether the history of the channel is public to its subscribers.
Currently always true for public channels (i.e. \"invite_only\": false implies \"history_public_to_subscribers\": true), but clients should not make that assumption,
as we may change that behavior in the future.
Sourcepub const fn topics_policy(&self) -> Option<TopicsPolicy>
pub const fn topics_policy(&self) -> Option<TopicsPolicy>
Gets the BasicChannel topics_policy.
Whether named topics and the empty topic
(i.e., “general chat” topic) are enabled in this channel.
Sourcepub fn set_topics_policy(&mut self, val: TopicsPolicy)
pub fn set_topics_policy(&mut self, val: TopicsPolicy)
Sets the BasicChannel topics_policy.
Whether named topics and the empty topic
(i.e., “general chat” topic) are enabled in this channel.
Sourcepub fn unset_topics_policy(&mut self) -> Option<TopicsPolicy>
pub fn unset_topics_policy(&mut self) -> Option<TopicsPolicy>
Unsets the BasicChannel topics_policy.
Whether named topics and the empty topic
(i.e., “general chat” topic) are enabled in this channel.
Sourcepub fn with_topics_policy(self, val: TopicsPolicy) -> Self
pub fn with_topics_policy(self, val: TopicsPolicy) -> Self
Builder function that sets the BasicChannel topics_policy.
Whether named topics and the empty topic
(i.e., “general chat” topic) are enabled in this channel.
Sourcepub const fn first_message_id(&self) -> Option<u64>
pub const fn first_message_id(&self) -> Option<u64>
Gets the BasicChannel first_message_id.
The ID of the first message in the channel.
Intended to help clients determine whether they need to display UI like the "show all topics" widget that would suggest the channel has older history that can be accessed.
Is null for channels with no message history.
Changes: New in Zulip 2.1.0.
Sourcepub fn set_first_message_id(&mut self, val: u64)
pub fn set_first_message_id(&mut self, val: u64)
Sets the BasicChannel first_message_id.
The ID of the first message in the channel.
Intended to help clients determine whether they need to display UI like the "show all topics" widget that would suggest the channel has older history that can be accessed.
Is null for channels with no message history.
Changes: New in Zulip 2.1.0.
Sourcepub fn unset_first_message_id(&mut self) -> Option<u64>
pub fn unset_first_message_id(&mut self) -> Option<u64>
Unsets the BasicChannel first_message_id.
The ID of the first message in the channel.
Intended to help clients determine whether they need to display UI like the "show all topics" widget that would suggest the channel has older history that can be accessed.
Is null for channels with no message history.
Changes: New in Zulip 2.1.0.
Sourcepub fn with_first_message_id(self, val: u64) -> Self
pub fn with_first_message_id(self, val: u64) -> Self
Builder function that sets the BasicChannel first_message_id.
The ID of the first message in the channel.
Intended to help clients determine whether they need to display UI like the "show all topics" widget that would suggest the channel has older history that can be accessed.
Is null for channels with no message history.
Changes: New in Zulip 2.1.0.
Sourcepub const fn folder_id(&self) -> Option<u64>
pub const fn folder_id(&self) -> Option<u64>
Gets the BasicChannel folder_id.
The ID of the folder to which the channel belongs.
Is null if channel does not belong to any folder.
Changes: New in Zulip 11.0 (feature level 389).
Sourcepub fn set_folder_id(&mut self, val: u64)
pub fn set_folder_id(&mut self, val: u64)
Sets the BasicChannel folder_id.
The ID of the folder to which the channel belongs.
Is null if channel does not belong to any folder.
Changes: New in Zulip 11.0 (feature level 389).
Sourcepub fn unset_folder_id(&mut self) -> Option<u64>
pub fn unset_folder_id(&mut self) -> Option<u64>
Unsets the BasicChannel folder_id.
The ID of the folder to which the channel belongs.
Is null if channel does not belong to any folder.
Changes: New in Zulip 11.0 (feature level 389).
Sourcepub fn with_folder_id(self, val: u64) -> Self
pub fn with_folder_id(self, val: u64) -> Self
Builder function that sets the BasicChannel folder_id.
The ID of the folder to which the channel belongs.
Is null if channel does not belong to any folder.
Changes: New in Zulip 11.0 (feature level 389).
Sourcepub const fn is_recently_active(&self) -> Option<bool>
pub const fn is_recently_active(&self) -> Option<bool>
Gets the BasicChannel is_recently_active.
Whether the channel has recent message activity.
Clients should use this to implement hide inactive channels if demote_inactive_streams is enabled.
Changes: New in Zulip 10.0 (feature level 323). Previously, clients implemented the demote_inactive_streams from local message history, resulting in a choppy loading experience.
Sourcepub fn set_is_recently_active(&mut self, val: bool)
pub fn set_is_recently_active(&mut self, val: bool)
Sets the BasicChannel is_recently_active.
Whether the channel has recent message activity.
Clients should use this to implement hide inactive channels if demote_inactive_streams is enabled.
Changes: New in Zulip 10.0 (feature level 323). Previously, clients implemented the demote_inactive_streams from local message history, resulting in a choppy loading experience.
Sourcepub fn unset_is_recently_active(&mut self) -> Option<bool>
pub fn unset_is_recently_active(&mut self) -> Option<bool>
Unsets the BasicChannel is_recently_active.
Whether the channel has recent message activity.
Clients should use this to implement hide inactive channels if demote_inactive_streams is enabled.
Changes: New in Zulip 10.0 (feature level 323). Previously, clients implemented the demote_inactive_streams from local message history, resulting in a choppy loading experience.
Sourcepub fn with_is_recently_active(self, val: bool) -> Self
pub fn with_is_recently_active(self, val: bool) -> Self
Builder function that sets the BasicChannel is_recently_active.
Whether the channel has recent message activity.
Clients should use this to implement hide inactive channels if demote_inactive_streams is enabled.
Changes: New in Zulip 10.0 (feature level 323). Previously, clients implemented the demote_inactive_streams from local message history, resulting in a choppy loading experience.
Sourcepub const fn is_announcement_only(&self) -> Option<bool>
pub const fn is_announcement_only(&self) -> Option<bool>
Gets the BasicChannel is_announcement_only.
Whether the given channel is announcement only or not.
Changes: Deprecated in Zulip 3.0 (feature level 1). Clients should use stream_post_policy instead.
Sourcepub fn set_is_announcement_only(&mut self, val: bool)
pub fn set_is_announcement_only(&mut self, val: bool)
Sets the BasicChannel is_announcement_only.
Whether the given channel is announcement only or not.
Changes: Deprecated in Zulip 3.0 (feature level 1). Clients should use stream_post_policy instead.
Sourcepub fn unset_is_announcement_only(&mut self) -> Option<bool>
pub fn unset_is_announcement_only(&mut self) -> Option<bool>
Unsets the BasicChannel is_announcement_only.
Whether the given channel is announcement only or not.
Changes: Deprecated in Zulip 3.0 (feature level 1). Clients should use stream_post_policy instead.
Sourcepub fn with_is_announcement_only(self, val: bool) -> Self
pub fn with_is_announcement_only(self, val: bool) -> Self
Builder function that sets the BasicChannel is_announcement_only.
Whether the given channel is announcement only or not.
Changes: Deprecated in Zulip 3.0 (feature level 1). Clients should use stream_post_policy instead.
Sourcepub const fn subscriber_count(&self) -> Option<f64>
pub const fn subscriber_count(&self) -> Option<f64>
Gets the BasicChannel subscriber_count.
The total number of non-deactivated users (including bots) who are subscribed to the channel.
Clients are responsible for updating this value using peer_add and peer_remove events.
The server’s internals cannot guarantee this value is correctly synced with peer_add and peer_remove events for the channel.
As a result, if a (rare) race occurs between a change in the channel’s subscribers and fetching this value, it is possible for a client that is correctly following the events
protocol to end up with a permanently off-by-one error in the channel’s subscriber count.
Clients are recommended to fetch full subscriber data for a channel in contexts where it is important to avoid this risk.
The official web application, for example, uses this field primarily while waiting to fetch a given channel’s full subscriber list from the server.
Changes: New in Zulip 11.0 (feature level 394).
Sourcepub fn set_subscriber_count(&mut self, val: f64)
pub fn set_subscriber_count(&mut self, val: f64)
Sets the BasicChannel subscriber_count.
The total number of non-deactivated users (including bots) who are subscribed to the channel.
Clients are responsible for updating this value using peer_add and peer_remove events.
The server’s internals cannot guarantee this value is correctly synced with peer_add and peer_remove events for the channel.
As a result, if a (rare) race occurs between a change in the channel’s subscribers and fetching this value, it is possible for a client that is correctly following the events
protocol to end up with a permanently off-by-one error in the channel’s subscriber count.
Clients are recommended to fetch full subscriber data for a channel in contexts where it is important to avoid this risk.
The official web application, for example, uses this field primarily while waiting to fetch a given channel’s full subscriber list from the server.
Changes: New in Zulip 11.0 (feature level 394).
Sourcepub fn unset_subscriber_count(&mut self) -> Option<f64>
pub fn unset_subscriber_count(&mut self) -> Option<f64>
Unsets the BasicChannel subscriber_count.
The total number of non-deactivated users (including bots) who are subscribed to the channel.
Clients are responsible for updating this value using peer_add and peer_remove events.
The server’s internals cannot guarantee this value is correctly synced with peer_add and peer_remove events for the channel.
As a result, if a (rare) race occurs between a change in the channel’s subscribers and fetching this value, it is possible for a client that is correctly following the events
protocol to end up with a permanently off-by-one error in the channel’s subscriber count.
Clients are recommended to fetch full subscriber data for a channel in contexts where it is important to avoid this risk.
The official web application, for example, uses this field primarily while waiting to fetch a given channel’s full subscriber list from the server.
Changes: New in Zulip 11.0 (feature level 394).
Sourcepub fn with_subscriber_count(self, val: f64) -> Self
pub fn with_subscriber_count(self, val: f64) -> Self
Builder function that sets the BasicChannel subscriber_count.
The total number of non-deactivated users (including bots) who are subscribed to the channel.
Clients are responsible for updating this value using peer_add and peer_remove events.
The server’s internals cannot guarantee this value is correctly synced with peer_add and peer_remove events for the channel.
As a result, if a (rare) race occurs between a change in the channel’s subscribers and fetching this value, it is possible for a client that is correctly following the events
protocol to end up with a permanently off-by-one error in the channel’s subscriber count.
Clients are recommended to fetch full subscriber data for a channel in contexts where it is important to avoid this risk.
The official web application, for example, uses this field primarily while waiting to fetch a given channel’s full subscriber list from the server.
Changes: New in Zulip 11.0 (feature level 394).
Source§impl BasicChannel
impl BasicChannel
Sourcepub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
Gets the BasicChannel name.
The name of the channel.
Sourcepub fn set_name<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)
pub fn set_name<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)
Sets the BasicChannel name.
The name of the channel.
Sourcepub fn unset_name(&mut self) -> Option<String>
pub fn unset_name(&mut self) -> Option<String>
Unsets the BasicChannel name.
The name of the channel.
Sourcepub fn with_name<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self
pub fn with_name<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self
Builder function that sets the BasicChannel name.
The name of the channel.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
Gets the BasicChannel description.
The short description of the channel in Zulip-flavored Markdown format, intended to be used to prepopulate UI for editing a channel’s description.
See Markdown message formatting for details on Zulip’s HTML format.
Sourcepub fn set_description<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)
pub fn set_description<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)
Sets the BasicChannel description.
The short description of the channel in Zulip-flavored Markdown format, intended to be used to prepopulate UI for editing a channel’s description.
See Markdown message formatting for details on Zulip’s HTML format.
Sourcepub fn unset_description(&mut self) -> Option<String>
pub fn unset_description(&mut self) -> Option<String>
Unsets the BasicChannel description.
The short description of the channel in Zulip-flavored Markdown format, intended to be used to prepopulate UI for editing a channel’s description.
See Markdown message formatting for details on Zulip’s HTML format.
Sourcepub fn with_description<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self
pub fn with_description<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self
Builder function that sets the BasicChannel description.
The short description of the channel in Zulip-flavored Markdown format, intended to be used to prepopulate UI for editing a channel’s description.
See Markdown message formatting for details on Zulip’s HTML format.
Sourcepub fn rendered_description(&self) -> Option<&str>
pub fn rendered_description(&self) -> Option<&str>
Gets the BasicChannel rendered_description.
The short description of the channel rendered as HTML, intended to be used when displaying the channel description in a UI.
One should use the standard Zulip rendered_markdown CSS when displaying this content so that emoji, LaTeX, and other syntax work correctly.
And any client-side security logic for user-generated message content should be applied when displaying this HTML as though it were the body of a Zulip message.
Sourcepub fn set_rendered_description<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)
pub fn set_rendered_description<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)
Sets the BasicChannel rendered_description.
The short description of the channel rendered as HTML, intended to be used when displaying the channel description in a UI.
One should use the standard Zulip rendered_markdown CSS when displaying this content so that emoji, LaTeX, and other syntax work correctly.
And any client-side security logic for user-generated message content should be applied when displaying this HTML as though it were the body of a Zulip message.
Sourcepub fn unset_rendered_description(&mut self) -> Option<String>
pub fn unset_rendered_description(&mut self) -> Option<String>
Unsets the BasicChannel rendered_description.
The short description of the channel rendered as HTML, intended to be used when displaying the channel description in a UI.
One should use the standard Zulip rendered_markdown CSS when displaying this content so that emoji, LaTeX, and other syntax work correctly.
And any client-side security logic for user-generated message content should be applied when displaying this HTML as though it were the body of a Zulip message.
Sourcepub fn with_rendered_description<'a, C: Into<Cow<'a, str>>>(
self,
val: C,
) -> Self
pub fn with_rendered_description<'a, C: Into<Cow<'a, str>>>( self, val: C, ) -> Self
Builder function that sets the BasicChannel rendered_description.
The short description of the channel rendered as HTML, intended to be used when displaying the channel description in a UI.
One should use the standard Zulip rendered_markdown CSS when displaying this content so that emoji, LaTeX, and other syntax work correctly.
And any client-side security logic for user-generated message content should be applied when displaying this HTML as though it were the body of a Zulip message.
Source§impl BasicChannel
impl BasicChannel
Sourcepub fn can_add_subscribers_group(&self) -> Option<&CanAddSubscribersGroup>
pub fn can_add_subscribers_group(&self) -> Option<&CanAddSubscribersGroup>
Gets the BasicChannel can_add_subscribers_group.
A group-setting value defining the set of users
who have permission to add subscribers to this channel.
Sourcepub fn set_can_add_subscribers_group<'a, C: Into<Cow<'a, CanAddSubscribersGroup>>>(
&mut self,
val: C,
)
pub fn set_can_add_subscribers_group<'a, C: Into<Cow<'a, CanAddSubscribersGroup>>>( &mut self, val: C, )
Sets the BasicChannel can_add_subscribers_group.
A group-setting value defining the set of users
who have permission to add subscribers to this channel.
Sourcepub fn unset_can_add_subscribers_group(
&mut self,
) -> Option<CanAddSubscribersGroup>
pub fn unset_can_add_subscribers_group( &mut self, ) -> Option<CanAddSubscribersGroup>
Unsets the BasicChannel can_add_subscribers_group.
A group-setting value defining the set of users
who have permission to add subscribers to this channel.
Sourcepub fn with_can_add_subscribers_group<'a, C: Into<Cow<'a, CanAddSubscribersGroup>>>(
self,
val: C,
) -> Self
pub fn with_can_add_subscribers_group<'a, C: Into<Cow<'a, CanAddSubscribersGroup>>>( self, val: C, ) -> Self
Builder function that sets the BasicChannel can_add_subscribers_group.
A group-setting value defining the set of users
who have permission to add subscribers to this channel.
Sourcepub fn can_remove_subscribers_group(&self) -> Option<&CanRemoveSubscribersGroup>
pub fn can_remove_subscribers_group(&self) -> Option<&CanRemoveSubscribersGroup>
Gets the BasicChannel can_remove_subscribers_group.
A group-setting value defining the set of users
who have permission to remove subscribers from this channel.
Sourcepub fn set_can_remove_subscribers_group<'a, C: Into<Cow<'a, CanRemoveSubscribersGroup>>>(
&mut self,
val: C,
)
pub fn set_can_remove_subscribers_group<'a, C: Into<Cow<'a, CanRemoveSubscribersGroup>>>( &mut self, val: C, )
Sets the BasicChannel can_remove_subscribers_group.
A group-setting value defining the set of users
who have permission to remove subscribers from this channel.
Sourcepub fn unset_can_remove_subscribers_group(
&mut self,
) -> Option<CanRemoveSubscribersGroup>
pub fn unset_can_remove_subscribers_group( &mut self, ) -> Option<CanRemoveSubscribersGroup>
Unsets the BasicChannel can_remove_subscribers_group.
A group-setting value defining the set of users
who have permission to remove subscribers from this channel.
Sourcepub fn with_can_remove_subscribers_group<'a, C: Into<Cow<'a, CanRemoveSubscribersGroup>>>(
self,
val: C,
) -> Self
pub fn with_can_remove_subscribers_group<'a, C: Into<Cow<'a, CanRemoveSubscribersGroup>>>( self, val: C, ) -> Self
Builder function that sets the BasicChannel can_remove_subscribers_group.
A group-setting value defining the set of users
who have permission to remove subscribers from this channel.
Sourcepub fn can_administer_channel_group(&self) -> Option<&CanAdministerChannelGroup>
pub fn can_administer_channel_group(&self) -> Option<&CanAdministerChannelGroup>
Gets the BasicChannel can_administer_channel_group.
A group-setting value defining the set of users
who have permission to administer this channel.
Sourcepub fn set_can_administer_channel_group<'a, C: Into<Cow<'a, CanAdministerChannelGroup>>>(
&mut self,
val: C,
)
pub fn set_can_administer_channel_group<'a, C: Into<Cow<'a, CanAdministerChannelGroup>>>( &mut self, val: C, )
Sets the BasicChannel can_administer_channel_group.
A group-setting value defining the set of users
who have permission to administer this channel.
Sourcepub fn unset_can_administer_channel_group(
&mut self,
) -> Option<CanAdministerChannelGroup>
pub fn unset_can_administer_channel_group( &mut self, ) -> Option<CanAdministerChannelGroup>
Unsets the BasicChannel can_administer_channel_group.
A group-setting value defining the set of users
who have permission to administer this channel.
Sourcepub fn with_can_administer_channel_group<'a, C: Into<Cow<'a, CanAdministerChannelGroup>>>(
self,
val: C,
) -> Self
pub fn with_can_administer_channel_group<'a, C: Into<Cow<'a, CanAdministerChannelGroup>>>( self, val: C, ) -> Self
Builder function that sets the BasicChannel can_administer_channel_group.
A group-setting value defining the set of users
who have permission to administer this channel.
Sourcepub fn can_delete_any_message_group(&self) -> Option<&CanDeleteAnyMessageGroup>
pub fn can_delete_any_message_group(&self) -> Option<&CanDeleteAnyMessageGroup>
Gets the BasicChannel can_delete_any_message_group.
A group-setting value defining the set of users
who have permission to delete any message in the channel.
Sourcepub fn set_can_delete_any_message_group<'a, C: Into<Cow<'a, CanDeleteAnyMessageGroup>>>(
&mut self,
val: C,
)
pub fn set_can_delete_any_message_group<'a, C: Into<Cow<'a, CanDeleteAnyMessageGroup>>>( &mut self, val: C, )
Sets the BasicChannel can_delete_any_message_group.
A group-setting value defining the set of users
who have permission to delete any message in the channel.
Sourcepub fn unset_can_delete_any_message_group(
&mut self,
) -> Option<CanDeleteAnyMessageGroup>
pub fn unset_can_delete_any_message_group( &mut self, ) -> Option<CanDeleteAnyMessageGroup>
Unsets the BasicChannel can_delete_any_message_group.
A group-setting value defining the set of users
who have permission to delete any message in the channel.
Sourcepub fn with_can_delete_any_message_group<'a, C: Into<Cow<'a, CanDeleteAnyMessageGroup>>>(
self,
val: C,
) -> Self
pub fn with_can_delete_any_message_group<'a, C: Into<Cow<'a, CanDeleteAnyMessageGroup>>>( self, val: C, ) -> Self
Builder function that sets the BasicChannel can_delete_any_message_group.
A group-setting value defining the set of users
who have permission to delete any message in the channel.
Sourcepub fn can_delete_own_message_group(&self) -> Option<&CanDeleteOwnMessageGroup>
pub fn can_delete_own_message_group(&self) -> Option<&CanDeleteOwnMessageGroup>
Gets the BasicChannel can_delete_own_message_group.
A group-setting value defining the set of users
who have permission to delete the messages that they have sent in the channel.
Sourcepub fn set_can_delete_own_message_group<'a, C: Into<Cow<'a, CanDeleteOwnMessageGroup>>>(
&mut self,
val: C,
)
pub fn set_can_delete_own_message_group<'a, C: Into<Cow<'a, CanDeleteOwnMessageGroup>>>( &mut self, val: C, )
Sets the BasicChannel can_delete_own_message_group.
A group-setting value defining the set of users
who have permission to delete the messages that they have sent in the channel.
Sourcepub fn unset_can_delete_own_message_group(
&mut self,
) -> Option<CanDeleteOwnMessageGroup>
pub fn unset_can_delete_own_message_group( &mut self, ) -> Option<CanDeleteOwnMessageGroup>
Unsets the BasicChannel can_delete_own_message_group.
A group-setting value defining the set of users
who have permission to delete the messages that they have sent in the channel.
Sourcepub fn with_can_delete_own_message_group<'a, C: Into<Cow<'a, CanDeleteOwnMessageGroup>>>(
self,
val: C,
) -> Self
pub fn with_can_delete_own_message_group<'a, C: Into<Cow<'a, CanDeleteOwnMessageGroup>>>( self, val: C, ) -> Self
Builder function that sets the BasicChannel can_delete_own_message_group.
A group-setting value defining the set of users
who have permission to delete the messages that they have sent in the channel.
Sourcepub fn can_move_messages_out_of_channel_group(
&self,
) -> Option<&CanMoveMessagesOutOfChannelGroup>
pub fn can_move_messages_out_of_channel_group( &self, ) -> Option<&CanMoveMessagesOutOfChannelGroup>
Gets the BasicChannel can_move_messages_out_of_channel_group.
A group-setting value defining the set of users
who have permission to move messages out of this channel.
Sourcepub fn set_can_move_messages_out_of_channel_group<'a, C: Into<Cow<'a, CanMoveMessagesOutOfChannelGroup>>>(
&mut self,
val: C,
)
pub fn set_can_move_messages_out_of_channel_group<'a, C: Into<Cow<'a, CanMoveMessagesOutOfChannelGroup>>>( &mut self, val: C, )
Sets the BasicChannel can_move_messages_out_of_channel_group.
A group-setting value defining the set of users
who have permission to move messages out of this channel.
Sourcepub fn unset_can_move_messages_out_of_channel_group(
&mut self,
) -> Option<CanMoveMessagesOutOfChannelGroup>
pub fn unset_can_move_messages_out_of_channel_group( &mut self, ) -> Option<CanMoveMessagesOutOfChannelGroup>
Unsets the BasicChannel can_move_messages_out_of_channel_group.
A group-setting value defining the set of users
who have permission to move messages out of this channel.
Sourcepub fn with_can_move_messages_out_of_channel_group<'a, C: Into<Cow<'a, CanMoveMessagesOutOfChannelGroup>>>(
self,
val: C,
) -> Self
pub fn with_can_move_messages_out_of_channel_group<'a, C: Into<Cow<'a, CanMoveMessagesOutOfChannelGroup>>>( self, val: C, ) -> Self
Builder function that sets the BasicChannel can_move_messages_out_of_channel_group.
A group-setting value defining the set of users
who have permission to move messages out of this channel.
Sourcepub fn can_move_messages_within_channel_group(
&self,
) -> Option<&CanMoveMessagesWithinChannelGroup>
pub fn can_move_messages_within_channel_group( &self, ) -> Option<&CanMoveMessagesWithinChannelGroup>
Gets the BasicChannel can_move_messages_within_channel_group.
A group-setting value defining the set of users
who have permission to move messages within this channel.
Sourcepub fn set_can_move_messages_within_channel_group<'a, C: Into<Cow<'a, CanMoveMessagesWithinChannelGroup>>>(
&mut self,
val: C,
)
pub fn set_can_move_messages_within_channel_group<'a, C: Into<Cow<'a, CanMoveMessagesWithinChannelGroup>>>( &mut self, val: C, )
Sets the BasicChannel can_move_messages_within_channel_group.
A group-setting value defining the set of users
who have permission to move messages within this channel.
Sourcepub fn unset_can_move_messages_within_channel_group(
&mut self,
) -> Option<CanMoveMessagesWithinChannelGroup>
pub fn unset_can_move_messages_within_channel_group( &mut self, ) -> Option<CanMoveMessagesWithinChannelGroup>
Unsets the BasicChannel can_move_messages_within_channel_group.
A group-setting value defining the set of users
who have permission to move messages within this channel.
Sourcepub fn with_can_move_messages_within_channel_group<'a, C: Into<Cow<'a, CanMoveMessagesWithinChannelGroup>>>(
self,
val: C,
) -> Self
pub fn with_can_move_messages_within_channel_group<'a, C: Into<Cow<'a, CanMoveMessagesWithinChannelGroup>>>( self, val: C, ) -> Self
Builder function that sets the BasicChannel can_move_messages_within_channel_group.
A group-setting value defining the set of users
who have permission to move messages within this channel.
Sourcepub fn can_send_message_group(&self) -> Option<&CanSendMessageGroup>
pub fn can_send_message_group(&self) -> Option<&CanSendMessageGroup>
Gets the BasicChannel can_send_message_group.
A group-setting value defining the set of users
who have permission to post in this channel.
Sourcepub fn set_can_send_message_group<'a, C: Into<Cow<'a, CanSendMessageGroup>>>(
&mut self,
val: C,
)
pub fn set_can_send_message_group<'a, C: Into<Cow<'a, CanSendMessageGroup>>>( &mut self, val: C, )
Sets the BasicChannel can_send_message_group.
A group-setting value defining the set of users
who have permission to post in this channel.
Sourcepub fn unset_can_send_message_group(&mut self) -> Option<CanSendMessageGroup>
pub fn unset_can_send_message_group(&mut self) -> Option<CanSendMessageGroup>
Unsets the BasicChannel can_send_message_group.
A group-setting value defining the set of users
who have permission to post in this channel.
Sourcepub fn with_can_send_message_group<'a, C: Into<Cow<'a, CanSendMessageGroup>>>(
self,
val: C,
) -> Self
pub fn with_can_send_message_group<'a, C: Into<Cow<'a, CanSendMessageGroup>>>( self, val: C, ) -> Self
Builder function that sets the BasicChannel can_send_message_group.
A group-setting value defining the set of users
who have permission to post in this channel.
Sourcepub fn can_subscribe_group(&self) -> Option<&CanSubscribeGroup>
pub fn can_subscribe_group(&self) -> Option<&CanSubscribeGroup>
Gets the BasicChannel can_subscribe_group.
A group-setting value defining the set of users
who have permission to subscribe themselves to this channel.
Sourcepub fn set_can_subscribe_group<'a, C: Into<Cow<'a, CanSubscribeGroup>>>(
&mut self,
val: C,
)
pub fn set_can_subscribe_group<'a, C: Into<Cow<'a, CanSubscribeGroup>>>( &mut self, val: C, )
Sets the BasicChannel can_subscribe_group.
A group-setting value defining the set of users
who have permission to subscribe themselves to this channel.
Sourcepub fn unset_can_subscribe_group(&mut self) -> Option<CanSubscribeGroup>
pub fn unset_can_subscribe_group(&mut self) -> Option<CanSubscribeGroup>
Unsets the BasicChannel can_subscribe_group.
A group-setting value defining the set of users
who have permission to subscribe themselves to this channel.
Sourcepub fn with_can_subscribe_group<'a, C: Into<Cow<'a, CanSubscribeGroup>>>(
self,
val: C,
) -> Self
pub fn with_can_subscribe_group<'a, C: Into<Cow<'a, CanSubscribeGroup>>>( self, val: C, ) -> Self
Builder function that sets the BasicChannel can_subscribe_group.
A group-setting value defining the set of users
who have permission to subscribe themselves to this channel.
Sourcepub fn can_resolve_topics_group(&self) -> Option<&CanResolveTopicsGroup>
pub fn can_resolve_topics_group(&self) -> Option<&CanResolveTopicsGroup>
Gets the BasicChannel can_resolve_topics_group.
A group-setting value defining the set of users
who have permission to resolve topics in the channel.
Sourcepub fn set_can_resolve_topics_group<'a, C: Into<Cow<'a, CanResolveTopicsGroup>>>(
&mut self,
val: C,
)
pub fn set_can_resolve_topics_group<'a, C: Into<Cow<'a, CanResolveTopicsGroup>>>( &mut self, val: C, )
Sets the BasicChannel can_resolve_topics_group.
A group-setting value defining the set of users
who have permission to resolve topics in the channel.
Sourcepub fn unset_can_resolve_topics_group(
&mut self,
) -> Option<CanResolveTopicsGroup>
pub fn unset_can_resolve_topics_group( &mut self, ) -> Option<CanResolveTopicsGroup>
Unsets the BasicChannel can_resolve_topics_group.
A group-setting value defining the set of users
who have permission to resolve topics in the channel.
Sourcepub fn with_can_resolve_topics_group<'a, C: Into<Cow<'a, CanResolveTopicsGroup>>>(
self,
val: C,
) -> Self
pub fn with_can_resolve_topics_group<'a, C: Into<Cow<'a, CanResolveTopicsGroup>>>( self, val: C, ) -> Self
Builder function that sets the BasicChannel can_resolve_topics_group.
A group-setting value defining the set of users
who have permission to resolve topics in the channel.