definition

Documentation

Index

• Variables
• func IsSpecVersionSupported(ver *semver.Version) bool
• func MustReadFlowFromGeneric(data map[string]interface{}) flows.Flow
• 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.AssetSource) flows.FlowAssets
• func NewLocalization() flows.Localization
• func NewNode(uuid flows.NodeUUID, actions []flows.Action, router flows.Router, ...) flows.Node
• func ReadFlow(data json.RawMessage) (flows.Flow, error)
• func ReadFlowFromGeneric(data map[string]interface{}) (flows.Flow, error)
• func ReadLocalization(data json.RawMessage) (flows.Localization, error)

Variables

var CurrentSpecVersion = semver.MustParse("13.0")

CurrentSpecVersion is the flow spec version supported by this library

Functions

func IsSpecVersionSupported

func IsSpecVersionSupported(ver *semver.Version) bool

IsSpecVersionSupported determines if we can read the given flow version

func MustReadFlowFromGeneric

func MustReadFlowFromGeneric(data map[string]interface{}) flows.Flow

MustReadFlowFromGeneric tries to read a flow from the given generic map, panics if it can't

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) (flows.Flow, error)

NewFlow creates a new flow

func NewFlowAssets

func NewFlowAssets(source assets.AssetSource) flows.FlowAssets

NewFlowAssets creates a new flow assets

func NewLocalization

func NewLocalization() flows.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 ReadFlow

func ReadFlow(data json.RawMessage) (flows.Flow, error)

ReadFlow reads a single flow definition from the passed in byte array

func ReadFlowFromGeneric

func ReadFlowFromGeneric(data map[string]interface{}) (flows.Flow, error)

ReadFlowFromGeneric tries to read a flow in the current spec from the given generic map

func ReadLocalization

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

ReadLocalization reads entire localization flow segment