pub struct CustomProfileField { /* private fields */ }Expand description
Represents the details of a custom profile field configured for this organization.
Implementations§
Source§impl CustomProfileField
impl CustomProfileField
Sourcepub const fn id(&self) -> u64
pub const fn id(&self) -> u64
Gets the CustomProfileField id.
The ID of the custom profile field. This will be referenced in the custom
profile fields section of user objects.
Sourcepub fn set_id(&mut self, val: u64)
pub fn set_id(&mut self, val: u64)
Sets the CustomProfileField id.
The ID of the custom profile field. This will be referenced in the custom
profile fields section of user objects.
Sourcepub fn with_id(self, val: u64) -> Self
pub fn with_id(self, val: u64) -> Self
Builder function that sets the CustomProfileField id.
The ID of the custom profile field. This will be referenced in the custom
profile fields section of user objects.
Sourcepub const fn field_type(&self) -> CustomProfileFieldTypeId
pub const fn field_type(&self) -> CustomProfileFieldTypeId
Gets the CustomProfileField field_type.
An integer indicating the type of the custom profile field, which determines
how it is configured and displayed to users.
Sourcepub fn set_field_type(&mut self, val: CustomProfileFieldTypeId)
pub fn set_field_type(&mut self, val: CustomProfileFieldTypeId)
Sets the CustomProfileField field_type.
An integer indicating the type of the custom profile field, which determines
how it is configured and displayed to users.
Sourcepub fn with_field_type(self, val: CustomProfileFieldTypeId) -> Self
pub fn with_field_type(self, val: CustomProfileFieldTypeId) -> Self
Builder function that sets the CustomProfileField field_type.
An integer indicating the type of the custom profile field, which determines
how it is configured and displayed to users.
Sourcepub const fn order(&self) -> u64
pub const fn order(&self) -> u64
Gets the CustomProfileField order.
Custom profile fields are displayed in both settings UI and UI showing
users’ profiles in increasing order.
Sourcepub fn set_order(&mut self, val: u64)
pub fn set_order(&mut self, val: u64)
Sets the CustomProfileField order.
Custom profile fields are displayed in both settings UI and UI showing
users’ profiles in increasing order.
Sourcepub fn with_order(self, val: u64) -> Self
pub fn with_order(self, val: u64) -> Self
Builder function that sets the CustomProfileField order.
Custom profile fields are displayed in both settings UI and UI showing
users’ profiles in increasing order.
Sourcepub const fn required(&self) -> bool
pub const fn required(&self) -> bool
Gets the CustomProfileField required.
Whether an organization administrator has configured this profile field
as required.
Because the required property is mutable, clients cannot assume that a
required custom profile field has a value. The Zulip web application
displays a prominent banner to any user who has not set a value for a
required field.
Changes: New in Zulip 9.0 (feature level 244).
Sourcepub fn set_required(&mut self, val: bool)
pub fn set_required(&mut self, val: bool)
Sets the CustomProfileField required.
Whether an organization administrator has configured this profile field
as required.
Because the required property is mutable, clients cannot assume that a
required custom profile field has a value. The Zulip web application
displays a prominent banner to any user who has not set a value for a
required field.
Changes: New in Zulip 9.0 (feature level 244).
Sourcepub fn with_required(self, val: bool) -> Self
pub fn with_required(self, val: bool) -> Self
Builder function that sets the CustomProfileField required.
Whether an organization administrator has configured this profile field
as required.
Because the required property is mutable, clients cannot assume that a
required custom profile field has a value. The Zulip web application
displays a prominent banner to any user who has not set a value for a
required field.
Changes: New in Zulip 9.0 (feature level 244).
Sourcepub const fn editable_by_user(&self) -> bool
pub const fn editable_by_user(&self) -> bool
Gets the CustomProfileField editable_by_user.
Whether regular users can edit this profile field on their own account.
Note that organization administrators can edit custom profile fields
for any user regardless of this setting.
Changes: New in Zulip 10.0 (feature level 296).
Sourcepub fn set_editable_by_user(&mut self, val: bool)
pub fn set_editable_by_user(&mut self, val: bool)
Sets the CustomProfileField editable_by_user.
Whether regular users can edit this profile field on their own account.
Note that organization administrators can edit custom profile fields
for any user regardless of this setting.
Changes: New in Zulip 10.0 (feature level 296).
Sourcepub fn with_editable_by_user(self, val: bool) -> Self
pub fn with_editable_by_user(self, val: bool) -> Self
Builder function that sets the CustomProfileField editable_by_user.
Whether regular users can edit this profile field on their own account.
Note that organization administrators can edit custom profile fields
for any user regardless of this setting.
Changes: New in Zulip 10.0 (feature level 296).
Source§impl CustomProfileField
impl CustomProfileField
Sourcepub fn name(&self) -> &str
pub fn name(&self) -> &str
Gets the CustomProfileField name.
The name of the custom profile field.
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 CustomProfileField name.
The name of the custom profile field.
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 CustomProfileField name.
The name of the custom profile field.
Sourcepub fn hint(&self) -> &str
pub fn hint(&self) -> &str
Gets the CustomProfileField hint.
The help text to be displayed for the custom profile field in
user-facing settings UI for configuring custom profile fields.
Source§impl CustomProfileField
impl CustomProfileField
Sourcepub const fn display_in_profile_summary(&self) -> Option<bool>
pub const fn display_in_profile_summary(&self) -> Option<bool>
Gets the CustomProfileField display_in_profile_summary.
Whether the custom profile field, display or not on the user card.
Currently it’s value not allowed to be true of Long text and Person picker profile field types.
This field is only included when its value is true.
Changes: New in Zulip 6.0 (feature level 146).
Sourcepub fn set_display_in_profile_summary(&mut self, val: bool)
pub fn set_display_in_profile_summary(&mut self, val: bool)
Sets the CustomProfileField display_in_profile_summary.
Whether the custom profile field, display or not on the user card.
Currently it’s value not allowed to be true of Long text and Person picker profile field types.
This field is only included when its value is true.
Changes: New in Zulip 6.0 (feature level 146).
Sourcepub fn unset_display_in_profile_summary(&mut self) -> Option<bool>
pub fn unset_display_in_profile_summary(&mut self) -> Option<bool>
Unsets the CustomProfileField display_in_profile_summary.
Whether the custom profile field, display or not on the user card.
Currently it’s value not allowed to be true of Long text and Person picker profile field types.
This field is only included when its value is true.
Changes: New in Zulip 6.0 (feature level 146).
Sourcepub fn with_display_in_profile_summary(self, val: bool) -> Self
pub fn with_display_in_profile_summary(self, val: bool) -> Self
Builder function that sets the CustomProfileField display_in_profile_summary.
Whether the custom profile field, display or not on the user card.
Currently it’s value not allowed to be true of Long text and Person picker profile field types.
This field is only included when its value is true.
Changes: New in Zulip 6.0 (feature level 146).
Source§impl CustomProfileField
impl CustomProfileField
Sourcepub fn field_data(&self) -> Option<&str>
pub fn field_data(&self) -> Option<&str>
Gets the CustomProfileField field_data.
Field types 3 (List of options) and 7 (External account) support storing
additional configuration for the field type in the field_data attribute.
For field type 3 (List of options), this attribute is a JSON dictionary
defining the choices and the order they will be displayed in the dropdown
UI for individual users to select an option.
The interface for field type 7 is not yet stabilized.
Sourcepub fn set_field_data<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)
pub fn set_field_data<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)
Sets the CustomProfileField field_data.
Field types 3 (List of options) and 7 (External account) support storing
additional configuration for the field type in the field_data attribute.
For field type 3 (List of options), this attribute is a JSON dictionary
defining the choices and the order they will be displayed in the dropdown
UI for individual users to select an option.
The interface for field type 7 is not yet stabilized.
Sourcepub fn unset_field_data(&mut self) -> Option<String>
pub fn unset_field_data(&mut self) -> Option<String>
Unsets the CustomProfileField field_data.
Field types 3 (List of options) and 7 (External account) support storing
additional configuration for the field type in the field_data attribute.
For field type 3 (List of options), this attribute is a JSON dictionary
defining the choices and the order they will be displayed in the dropdown
UI for individual users to select an option.
The interface for field type 7 is not yet stabilized.
Sourcepub fn with_field_data<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self
pub fn with_field_data<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self
Builder function that sets the CustomProfileField field_data.
Field types 3 (List of options) and 7 (External account) support storing
additional configuration for the field type in the field_data attribute.
For field type 3 (List of options), this attribute is a JSON dictionary
defining the choices and the order they will be displayed in the dropdown
UI for individual users to select an option.
The interface for field type 7 is not yet stabilized.