Smart Flows

SmartFlows

Smart Flows module

• SmartFlows
  • .initialized : boolean
  • .session : SmartFlowSession
  • .status : SmartFlowsStatus
  • .addFlow(flow) ⇒ void
  • .addFlowByCode(shortCode) ⇒ Promise<(SmartFlow|void)>
  • .getActiveGlobalFlow() ⇒ SmartFlow | undefined
  • .getFlowById(flowId) ⇒ SmartFlow | undefined
  • .getFlowByShortCode(shortCode) ⇒ SmartFlow | undefined
  • .getFlows() ⇒ Array<SmartFlow>
  • .getPreviewFlow() ⇒ SmartFlow | undefined
  • .goToModalPage(componentId, pageNumber) ⇒ boolean
  • .goToModalProduct(componentId, productId) ⇒ boolean
  • .handleLinkBasedFlow() ⇒ Promise<void>
  • .init(flows) ⇒ SmartFlowsModule
  • .processFlows() ⇒ void
  • .removeFlow(flowId) ⇒ void
  • .runComponent(component, flow) ⇒ void
  • .runFlow(flow) ⇒ void
  • .setFlows(flows) ⇒ void
  • .sync() ⇒ void

SmartFlows.initialized : boolean

Smart Flows module initialization flag

SmartFlows.session : SmartFlowSession

Smart Flow Session module for session persistence and state management

SmartFlows.status : SmartFlowsStatus

Smart Flows module status. Helps determine when flows are ready to be processed.

'initializing' | 'redirecting' | 'ready'

SmartFlows.addFlow(flow) ⇒ void

Add a new Smart Flow

SmartFlows.addFlowByCode(shortCode) ⇒ Promise<(SmartFlow|void)>

Add a new Smart Flow via shortCode

SmartFlows.getActiveGlobalFlow() ⇒ SmartFlow | undefined

Get the currently active global flow

SmartFlows.getFlowById(flowId) ⇒ SmartFlow | undefined

Find a Smart Flow by ID

SmartFlows.getFlowByShortCode(shortCode) ⇒ SmartFlow | undefined

Find a Smart Flow by short code

SmartFlows.getFlows() ⇒ Array<SmartFlow>

Get a list of available flows

NOTE: Useful for filtering or lookups by ID / shortCode

SmartFlows.getPreviewFlow() ⇒ SmartFlow | undefined

Get the flow currently being previewed

SmartFlows.goToModalPage(componentId, pageNumber) ⇒ boolean

Navigate to a specific page in a modal for a given component ID

Returns: boolean - True if successful, false otherwise

SmartFlows.goToModalProduct(componentId, productId) ⇒ boolean

Navigate to a specific product page in a modal for a given component ID

Returns: boolean - True if successful, false otherwise

SmartFlows.handleLinkBasedFlow() ⇒ Promise<void>

Handle link-based Smart Flow initialization

SmartFlows.init(flows) ⇒ SmartFlowsModule

Smart Flow module initialization

SmartFlows.processFlows() ⇒ void

Process all available Smart Flows

SmartFlows.removeFlow(flowId) ⇒ void

Removes a flow + cleans up associated component observers

SmartFlows.runComponent(component, flow) ⇒ void

Executes a specific Smart Flow component

SmartFlows.runFlow(flow) ⇒ void

Run a given Smart Flow, traversing its tree and rendering the first components

SmartFlows.setFlows(flows) ⇒ void

Apply the Smart Flows to make available

SmartFlows.sync() ⇒ void

Sync the active UI component state