Sets Message in State from UI Processing — FM_set_ui

Any errors that need to be passed back to the user can be set with this function.

Usage

FM_set_ui_msg(state, msgs, append = FALSE)

Arguments

state: formods State object.
msgs: Character vector of messages.
append: When TRUE, msgs will be appended to any current messages. When FALSE (default) msgs will replace any existing messaages.

Value

state with ui message set.

Examples

# We need a module state object to use this function:
id="UD"
sess_res = UD_test_mksession(session=list(), id=id)
#> → UD: including file
#> → UD:   source: file.path(system.file(package="onbrand"), "templates", "report.docx")
#> → UD:   dest:   file.path("config","report.docx")
#> → UD: including file
#> → UD:   source: file.path(system.file(package="onbrand"), "templates", "report.pptx")
#> → UD:   dest:   file.path("config","report.pptx")
#> → UD: including file
#> → UD:   source: file.path(system.file(package="onbrand"), "templates", "report.yaml")
#> → UD:   dest:   file.path("config","report.yaml")
#> → UD: State initialized
#> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20
state = sess_res$state
state = FM_set_ui_msg(state, "Something happend.")