A single step within a recipe stage, the unit of work an account works through while completing a recipe. Implementations include TaskRecipeStep, which creates a Task for the account admin, and MultiNextRecipeStep, which fans out to several next steps without creating a task of its own. RecipeManager drives a step by calling onEnter, and follows a step's next steps (getAllNextSteps) or a completed task's chosen outcome to progress the recipe.


Properties

PropertyReturnsDescription
allNextStepsList<RecipeStep>The steps that follow this one once it is entered.
descriptionStringDetailed explanation of this step, including its next steps or outcomes where applicable.
iconStringFont Awesome icon identifier for this step.
idStringUnique identifier for this step, used as the task name when the step creates a task and as the lookup key within its recipe. Must be unique across the whole recipe, not just its stage.
titleStringUser-friendly title for this step, shown to the account admin.

Methods

getId()

Returns: String

Unique identifier for this step, used as the task name when the step creates a task and as the lookup key within its recipe. Must be unique across the whole recipe, not just its stage.

getTitle()

Returns: String

User-friendly title for this step, shown to the account admin.

getIcon()

Returns: String

Font Awesome icon identifier for this step.

getDescription()

Returns: String

Detailed explanation of this step, including its next steps or outcomes where applicable.

getAllNextSteps()

Returns: List<RecipeStep>

The steps that follow this one once it is entered.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.