definition

Documentation

Index

• Variables
• func IsVersionSupported(v *semver.Version) bool
• func NewExit(uuid flows.ExitUUID, destination flows.NodeUUID) flows.Exit
• func NewFlow(uuid assets.FlowUUID, name string, language envs.Language, ...) (flows.Flow, error)
• func NewFlowAssets(source assets.Source, migrationConfig *migrations.Config) flows.FlowAssets
• func NewLocalization() flows.Localization
• func NewNode(uuid flows.NodeUUID, actions []flows.Action, router flows.Router, ...) flows.Node
• func ReadAsset(a assets.Flow, mc *migrations.Config) (flows.Flow, error)
• func ReadFlow(data json.RawMessage, mc *migrations.Config) (flows.Flow, error)
• func ReadLocalization(data json.RawMessage) (flows.Localization, error)

Variables

var CurrentSpecVersion = semver.MustParse("13.1.0")

CurrentSpecVersion is the flow spec version supported by this library

Functions

func IsVersionSupported

func IsVersionSupported(v *semver.Version) bool

IsVersionSupported checks the given version is supported

func NewExit

func NewExit(uuid flows.ExitUUID, destination flows.NodeUUID) flows.Exit

NewExit creates a new exit

func NewFlow

func NewFlow(uuid assets.FlowUUID, name string, language envs.Language, flowType flows.FlowType, revision int, expireAfterMinutes int, localization flows.Localization, nodes []flows.Node, ui json.RawMessage, a assets.Flow) (flows.Flow, error)

NewFlow creates a new flow

func NewFlowAssets

func NewFlowAssets(source assets.Source, migrationConfig *migrations.Config) flows.FlowAssets

NewFlowAssets creates a new flow assets

func NewLocalization

func NewLocalization() flows.Localization

NewLocalization creates a new empty localization

func NewNode

func NewNode(uuid flows.NodeUUID, actions []flows.Action, router flows.Router, exits []flows.Exit) flows.Node

NewNode creates a new flow node

func ReadAsset

func ReadAsset(a assets.Flow, mc *migrations.Config) (flows.Flow, error)

ReadAsset reads a flow definition from the passed in flow asset, migrating it to the spec version of the engine if necessary

func ReadFlow

func ReadFlow(data json.RawMessage, mc *migrations.Config) (flows.Flow, error)

ReadFlow reads a flow definition from the passed in byte array, migrating it to the spec version of the engine if necessary

func ReadLocalization

func ReadLocalization(data json.RawMessage) (flows.Localization, error)

ReadLocalization reads entire localization flow segment