engine

Documentation

Index

• func NewEmptySprint() flows.Sprint
• func NewSessionAssets(source assets.AssetSource) (flows.SessionAssets, error)
• func NewSprint(modifiers []flows.Modifier, events []flows.Event) flows.Sprint
• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) Build() flows.Engine
  • func (b *Builder) WithAirtimeService(svc flows.AirtimeService) *Builder
  • func (b *Builder) WithDefaultUserAgent(userAgent string) *Builder
  • func (b *Builder) WithDisableWebhooks(disable bool) *Builder
  • func (b *Builder) WithMaxStepsPerSprint(max int) *Builder
  • func (b *Builder) WithMaxWebhookResponseBytes(max int) *Builder

Functions

func NewEmptySprint

func NewEmptySprint() flows.Sprint

NewEmptySprint creates a new sprint

func NewSessionAssets

func NewSessionAssets(source assets.AssetSource) (flows.SessionAssets, error)

NewSessionAssets creates a new session assets instance with the provided base URLs

func NewSprint

func NewSprint(modifiers []flows.Modifier, events []flows.Event) flows.Sprint

NewSprint creates a new sprint with the passed in modifiers and events

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

Builder is a builder for engine configs

func NewBuilder

func NewBuilder() *Builder

NewBuilder creates a new environment builder

func (*Builder) Build

func (b *Builder) Build() flows.Engine

Build returns the final engine

func (*Builder) WithAirtimeService

func (b *Builder) WithAirtimeService(svc flows.AirtimeService) *Builder

WithAirtimeService sets the airtime transfer service

func (*Builder) WithDefaultUserAgent

func (b *Builder) WithDefaultUserAgent(userAgent string) *Builder

WithDefaultUserAgent sets the default user-agent string used for webhook calls

func (*Builder) WithDisableWebhooks

func (b *Builder) WithDisableWebhooks(disable bool) *Builder

WithDisableWebhooks sets whether webhooks are enabled

func (*Builder) WithMaxStepsPerSprint

func (b *Builder) WithMaxStepsPerSprint(max int) *Builder

WithMaxStepsPerSprint sets the maximum number of steps allowed in a single sprint

func (*Builder) WithMaxWebhookResponseBytes

func (b *Builder) WithMaxWebhookResponseBytes(max int) *Builder

WithMaxWebhookResponseBytes sets the maximum webhook request bytes