runs

Documentation

Index

• Variables
• func NewRun(session flows.Session, flow flows.Flow, contact *flows.Contact, ...) flows.FlowRun
• func ReadRun(session flows.Session, data json.RawMessage) (flows.FlowRun, error)
• func ReadRunSummary(session flows.Session, data json.RawMessage) (flows.RunSummary, error)
• type Path
  • func (p Path) Describe() string
  • func (p Path) Index(index int) types.XValue
  • func (p Path) Length() int
  • func (p Path) Reduce(env utils.Environment) types.XPrimitive
  • func (p Path) ToXJSON(env utils.Environment) types.XText

Variables

var RunContextTopLevels = []string{
	"run",
	"child",
	"parent",
	"contact",
	"input",
	"results",
	"trigger",
	"legacy_extra",
}

RunContextTopLevels are the allowed top-level variables for expression evaluations

Functions

func NewRun

func NewRun(session flows.Session, flow flows.Flow, contact *flows.Contact, parent flows.FlowRun) flows.FlowRun

NewRun initializes a new context and flow run for the passed in flow and contact

func ReadRun

func ReadRun(session flows.Session, data json.RawMessage) (flows.FlowRun, error)

ReadRun decodes a run from the passed in JSON. Parent run UUID is returned separately as the run in question might be loaded yet from the session.

func ReadRunSummary

func ReadRunSummary(session flows.Session, data json.RawMessage) (flows.RunSummary, error)

ReadRunSummary reads a run summary from the given JSON

Types

type Path

type Path []flows.Step

func (Path) Describe

func (p Path) Describe() string

Describe returns a representation of this type for error messages

func (Path) Index

func (p Path) Index(index int) types.XValue

func (Path) Length

func (p Path) Length() int

func (Path) Reduce

func (p Path) Reduce(env utils.Environment) types.XPrimitive

func (Path) ToXJSON

func (p Path) ToXJSON(env utils.Environment) types.XText