Skip to main content

GuidedStep

One step of a guided flow.

type GuidedStep {
  attributeKey: String
  choices: [GuidedChoice!]
  defaultImageUrl: String
  display: GuidedStepDisplay!
  drillDown: Boolean!
  key: String!
  label: String!
  parentCategoryId: ID
  search: Boolean!
  source: GuidedStepSource!
  valueImages: [GuidedValueImage!]
  valueOrder: [String!]
}

Fields​

GuidedStep.attributeKey ● String scalar​

The variant attribute the options come from.

GuidedStep.choices ● [GuidedChoice!] list object​

The fixed choices, when the options are choices.

GuidedStep.defaultImageUrl ● String scalar​

The picture shown for every option that has none of its own.

GuidedStep.display ● GuidedStepDisplay! non-null enum​

How the options are shown.

GuidedStep.drillDown ● Boolean! non-null scalar​

CATEGORY: after a pick, ask again among the picked category's children, level by level.

GuidedStep.key ● String! non-null scalar​

The key of the step.

GuidedStep.label ● String! non-null scalar​

The question to show.

GuidedStep.parentCategoryId ● ID scalar​

CATEGORY: whose children the step offers; null means the top-level categories.

True when the step offers a search box.

GuidedStep.source ● GuidedStepSource! non-null enum​

Where the options come from.

GuidedStep.valueImages ● [GuidedValueImage!] list object​

Images for the values.

GuidedStep.valueOrder ● [String!] list scalar​

The order the values are shown in.

Member Of​

GuidedFlow object