pub struct ChannelFolder { /* private fields */ }Expand description
Represents the channel folder’s attributes.
Implementations§
Source§impl ChannelFolder
impl ChannelFolder
Sourcepub const fn new() -> Self
pub const fn new() -> Self
Creates a new ChannelFolder.
Source§impl ChannelFolder
impl ChannelFolder
Sourcepub const fn id(&self) -> Option<u64>
pub const fn id(&self) -> Option<u64>
Gets the ChannelFolder id.
The unique ID of the channel folder.
Sourcepub fn set_id(&mut self, val: u64)
pub fn set_id(&mut self, val: u64)
Sets the ChannelFolder id.
The unique ID of the channel folder.
Sourcepub fn unset_id(&mut self) -> Option<u64>
pub fn unset_id(&mut self) -> Option<u64>
Unsets the ChannelFolder id.
The unique ID of the channel folder.
Sourcepub fn with_id(self, val: u64) -> Self
pub fn with_id(self, val: u64) -> Self
Builder function that sets the ChannelFolder id.
The unique ID of the channel folder.
Sourcepub const fn order(&self) -> Option<u64>
pub const fn order(&self) -> Option<u64>
Gets the ChannelFolder order.
This value determines in which order the channel folder should be displayed in the UI.
The value is 0 indexed, and a channel folder with a lower value should be displayed before channel folders with higher values.
Changes: New in Zulip 11.0 (feature level 414).
Sourcepub fn set_order(&mut self, val: u64)
pub fn set_order(&mut self, val: u64)
Sets the ChannelFolder order.
This value determines in which order the channel folder should be displayed in the UI.
The value is 0 indexed, and a channel folder with a lower value should be displayed before channel folders with higher values.
Changes: New in Zulip 11.0 (feature level 414).
Sourcepub fn unset_order(&mut self) -> Option<u64>
pub fn unset_order(&mut self) -> Option<u64>
Unsets the ChannelFolder order.
This value determines in which order the channel folder should be displayed in the UI.
The value is 0 indexed, and a channel folder with a lower value should be displayed before channel folders with higher values.
Changes: New in Zulip 11.0 (feature level 414).
Sourcepub fn with_order(self, val: u64) -> Self
pub fn with_order(self, val: u64) -> Self
Builder function that sets the ChannelFolder order.
This value determines in which order the channel folder should be displayed in the UI.
The value is 0 indexed, and a channel folder with a lower value should be displayed before channel folders with higher values.
Changes: New in Zulip 11.0 (feature level 414).
Sourcepub const fn date_created(&self) -> Option<u64>
pub const fn date_created(&self) -> Option<u64>
Gets the ChannelFolder date_created.
The UNIX timestamp for when the channel folder was created, in UTC seconds.
Sourcepub fn set_date_created(&mut self, val: u64)
pub fn set_date_created(&mut self, val: u64)
Sets the ChannelFolder date_created.
The UNIX timestamp for when the channel folder was created, in UTC seconds.
Sourcepub fn unset_date_created(&mut self) -> Option<u64>
pub fn unset_date_created(&mut self) -> Option<u64>
Unsets the ChannelFolder date_created.
The UNIX timestamp for when the channel folder was created, in UTC seconds.
Sourcepub fn with_date_created(self, val: u64) -> Self
pub fn with_date_created(self, val: u64) -> Self
Builder function that sets the ChannelFolder date_created.
The UNIX timestamp for when the channel folder was created, in UTC seconds.
Sourcepub const fn creator_id(&self) -> Option<u64>
pub const fn creator_id(&self) -> Option<u64>
Gets the ChannelFolder creator_id.
The ID of the user who created the channel folder.
Sourcepub fn set_creator_id(&mut self, val: u64)
pub fn set_creator_id(&mut self, val: u64)
Sets the ChannelFolder creator_id.
The ID of the user who created the channel folder.
Sourcepub fn unset_creator_id(&mut self) -> Option<u64>
pub fn unset_creator_id(&mut self) -> Option<u64>
Unsets the ChannelFolder creator_id.
The ID of the user who created the channel folder.
Sourcepub fn with_creator_id(self, val: u64) -> Self
pub fn with_creator_id(self, val: u64) -> Self
Builder function that sets the ChannelFolder creator_id.
The ID of the user who created the channel folder.
Sourcepub const fn is_archived(&self) -> Option<bool>
pub const fn is_archived(&self) -> Option<bool>
Gets the ChannelFolder is_archived.
Whether the channel folder is archived or not.
Sourcepub fn set_is_archived(&mut self, val: bool)
pub fn set_is_archived(&mut self, val: bool)
Sets the ChannelFolder is_archived.
Whether the channel folder is archived or not.
Sourcepub fn unset_is_archived(&mut self) -> Option<bool>
pub fn unset_is_archived(&mut self) -> Option<bool>
Unsets the ChannelFolder is_archived.
Whether the channel folder is archived or not.
Sourcepub fn with_is_archived(self, val: bool) -> Self
pub fn with_is_archived(self, val: bool) -> Self
Builder function that sets the ChannelFolder is_archived.
Whether the channel folder is archived or not.
Source§impl ChannelFolder
impl ChannelFolder
Sourcepub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
Gets the ChannelFolder name.
The name of the channel folder.
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 ChannelFolder name.
The name of the channel folder.
Sourcepub fn unset_name(&mut self) -> Option<String>
pub fn unset_name(&mut self) -> Option<String>
Unsets the ChannelFolder name.
The name of the channel folder.
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 ChannelFolder name.
The name of the channel folder.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
Gets the ChannelFolder description.
The description of the channel folder. Can be an empty string.
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 ChannelFolder description.
The description of the channel folder. Can be an empty string.
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 ChannelFolder description.
The description of the channel folder. Can be an empty string.
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 ChannelFolder description.
The description of the channel folder. Can be an empty string.
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 ChannelFolder rendered_description.
The description of the channel folder rendered as HTML, intended to be used for UI that displays the channel folder description.
Clients 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 ChannelFolder rendered_description.
The description of the channel folder rendered as HTML, intended to be used for UI that displays the channel folder description.
Clients 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 ChannelFolder rendered_description.
The description of the channel folder rendered as HTML, intended to be used for UI that displays the channel folder description.
Clients 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 ChannelFolder rendered_description.
The description of the channel folder rendered as HTML, intended to be used for UI that displays the channel folder description.
Clients 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.