The functions and the variables described below allow suffix commands to access the value of the transient from which they were invoked; which is the value of its infix arguments. These variables are set when the user invokes a suffix command that exits the transient, but before actually calling the command.
When returning to the command-loop after calling the suffix command,
the arguments are reset to nil
(which causes the function to return
nil
too).
Like for Emacs’s prefix arguments, it is advisable, but not mandatory,
to access the infix arguments inside the command’s interactive
form.
The preferred way of doing that is to call the transient-args
function, which for infix arguments serves about the same purpose as
prefix-arg
serves for prefix arguments.
This function returns the value of the transient prefix command PREFIX.
If the current command was invoked from the transient prefix command PREFIX, then it returns the active infix arguments. If the current command was not invoked from PREFIX, then it returns the set, saved or default value for PREFIX.
This function returns the value of the current prefix.
This is mostly intended for internal use, but may also be of use
in transient-set-value
and transient-save-value
methods. Unlike
transient-args
, this does not include the values of suffixes whose
unsavable
slot is non-nil
.
This function returns the value of ARG as it appears in ARGS.
For a switch a boolean is returned. For an option the value is
returned as a string, using the empty string for the empty value,
or nil
if the option does not appear in ARGS.
This function returns the suffixes of the transient prefix command PREFIX. This is a list of objects. This function should only be used if you need the objects (as opposed to just their values) and if the current command is not being invoked from PREFIX.