@spec finish_processing_override(
  MscmpSystForms.Types.socket_or_assigns(),
  MscmpSystForms.Types.processing_override_name()
) :: MscmpSystForms.Types.socket_or_assigns()

Removes a processing override from the active overrides list.

Once an active operation previously added to the process overrides list has completed its processing, this function is used to remove it from the list so that any user interface components that are watching for the operation to be active can resume their normal behavior.

Parameters

• socket_or_assigns - the socket or assigns for the current view.

• override - the name of the processing override to remove from the active process overrides list.

@spec get_component_info(
  %{form_id: MscmpSystForms.Types.form_id()}
  | %{binding_id: MscmpSystForms.Types.binding_id()}
) :: MscmpSystForms.Types.ComponentInfo.t() | nil

Retrieves the textual information (label, label_link, and info) field values from the Form Configuration for the identified component.

This is a convenience function which accepts either a form_id value or a binding_id value and returns the textual information for the component if found by the passed identifier.

Parameters

• component_id - this value is either the form_id or binding_id that is associated with the component for which textual information is being retrieved.

See Msform.AuthPasswordReset.Actions.process_reset_attempt/1.

See Msform.AuthPasswordReset.Actions.process_reset_finished/1.

@spec start_processing_override(
  MscmpSystForms.Types.socket_or_assigns(),
  MscmpSystForms.Types.processing_override_name()
) :: MscmpSystForms.Types.socket_or_assigns()

Adds a processing override to the active overrides list.

Some user interface components are configured to change their presentation and interactivity when certain, possibly long running, processes are underway. This function adds the value of the override parameter to the active processes list allowing components interest in that processing state to respond accordingly.

Parameters

• socket_or_assigns - the socket or assigns for the current view.

• override - the name of the processing override to activate. This value will be an atom and will be form implementation specific.

@spec update_button_state(
  MscmpSystForms.Types.socket_or_assigns(),
  MscmpSystForms.Types.form_id(),
  MscmpSystForms.Types.msvalidated_button_states()
) :: MscmpSystForms.Types.socket_or_assigns()

Sets the state of MscmpSystForms.WebComponents.msvalidated_button/1 components.

Validated buttons exist in one of three states defined by MscmpSystForms.Types.msvalidated_button_states/0. This function will set the state of the validated button identified by the form_id parameters to the state identified by the button_state parameters.

Parameters

• socket_or_assigns - the socket or assigns for the current view.

• form_id - the identifier of the component to update. See MscmpSystForms.get_form_config/0 for more about form configuration attributes.

• button_state - the state to which the validated button component should be set. Any value defined by the MscmpSystForms.Types.msvalidated_button_states/0 type is valid for this purpose.

@spec update_display_data(
  MscmpSystForms.Types.socket_or_assigns(),
  Ecto.Changeset.t() | Phoenix.HTML.Form.t(),
  Keyword.t()
) :: MscmpSystForms.Types.socket_or_assigns()

Updates the display form data with new values.

The display data of the form, which represents the form's backing data after the application of effective user permissions to purge values that the user is not entitled to see, is set using this function. The data is stored in the view's assigns as a t:Phoenix.HTML.Form.t/0' value which is then passed to the view for rendering. ## Parameters *socket_or_assigns- the socket or assigns for the current view. *display_data- this option contains either the new display data to set and with which to update the form or indicates the kind of data validation to perform on the assigns stored data (msrd_original_data&msrd_current_data; seeMscmpSystForms.init_assigns/8for more). One method for setting the display data is to pass this option to the function using actual data. This data can take the form of either at:Ecto.Changeset.t/0value or at:Phoenix.HTML.Form.t/0value. If a Changeset is passed, the function will automatically process it into at:Phoenix.HTML.Form.t/0struct, applying the permissions currently set in themsrd_user_permsStandard Assigns Attribute to filter the data. If the value to be passed in this option is at:Phoenix.HTML.Form.t/0value, the struct should have been generated usingMscmpSystForms.to_form/3so that the user data visibility permissions will have been allied. The second method is to passdisplay_dataas a value referencing a display data validation type (t:MscmpSystForms.Types.data_validation_types/0). When this method is used, the values of themsrd_current_dataandmsrd_original_dataare validated using the standard validation functions (c:MscmpSystForms.validate_save/2andc:MscmpSystForms.validate_post/2) and then processed into at:Phoenix.HTML.Form.t/0value to save as the newmsrd_display_datavalue. Either of the validation types will result in the application of user data visibility permissions per themsrd_user_permsStandard Assigns Attribute. *opts- this function defines some optionally required parameters which are dependent on thedisplay_dataparameter. When thedisplay_datavalue is passed as at:MscmpSystForms.Types.data_validation_types/0allowed value the following are required: *original_data- a struct of values representing the starting data initialized on initial form loading and absent any changes the user may have made and not yet committed to the database. This value should be available in the standard assigns forMscmpSystFormsbased forms. *current_data- a map of values representing the current data backing the form. This data is complete (unfiltered by user data related permissions) and includes any edits made by the user and not yet committed to the database. This value is available in the standard assigns forMscmpSystForms` based forms

See Msform.AuthPasswordReset.Actions.validate_form_data/2.