engine

Documentation

Index

• func NewEmptySprint() flows.Sprint
• func NewSessionAssets(source assets.Source) (flows.SessionAssets, error)
• func NewSprint(modifiers []flows.Modifier, events []flows.Event) flows.Sprint
• type AirtimeService
• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) Build() flows.Engine
  • func (b *Builder) WithAirtimeService(svc AirtimeService) *Builder
  • func (b *Builder) WithMaxStepsPerSprint(max int) *Builder
  • func (b *Builder) WithWebhookService(svc WebhookService) *Builder
• type WebhookService

Functions

func NewEmptySprint

func NewEmptySprint() flows.Sprint

NewEmptySprint creates a new sprint

func NewSessionAssets

func NewSessionAssets(source assets.Source) (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 AirtimeService

type AirtimeService func(flows.Session) flows.AirtimeProvider

AirtimeService resolves a session to an airtime provider

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 AirtimeService) *Builder

WithAirtimeService sets the airtime transfer service

func (*Builder) WithMaxStepsPerSprint

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

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

func (*Builder) WithWebhookService

func (b *Builder) WithWebhookService(svc WebhookService) *Builder

WithWebhookService sets the webhook service

type WebhookService

type WebhookService func(flows.Session) flows.WebhookProvider

WebhookService resolves a session to a webhook provider