Interface Methods

Methods corresponding to an intent-based API for signaling state transitions of a block. These methods have side effects i.e. journey transitions are a function of block transitions, expressed through the following pseudo code:

journey.transition(blockState, intent)

Hierarchy

  • Methods

Properties

Properties

complete: (() => void)

Type declaration

    • (): void
    • Signals that the experience this Block powers has finished. A noop if the Block isn't active. Results in a journey transition.

      Modifies

      Sets completed to true Sets active to false

      Returns void

exit: (() => void)

Type declaration

    • (): void
    • Signals an end of the entire journey.

      Modifies

      Sets exited to true Sets active to false

      Returns void

start: (() => void)

Type declaration

    • (): void
    • Signals that the experience this Block powers has begun. A noop if the Block isn't active.

      Modifies

      Sets started to true Sets active to true

      Returns void

stop: (() => void)

Type declaration

    • (): void
    • Signals that the experience this Block powers has been ended prematurely and/or not finished. Ends progress for this branch in the jouurney.

      Modifies

      Sets stopped to true Sets active to false

      Returns void

Generated using TypeDoc