engine

Documentation

Index

• Constants
• func NewSessionAssets(env envs.Environment, source assets.Source, migrationConfig *migrations.Config) (flows.SessionAssets, error)
• func NewSprint(modifiers []flows.Modifier, events []flows.Event, segments []flows.Segment) flows.Sprint
• type AirtimeServiceFactory
• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) Build() flows.Engine
  • func (b *Builder) WithAirtimeServiceFactory(f AirtimeServiceFactory) *Builder
  • func (b *Builder) WithClassificationServiceFactory(f ClassificationServiceFactory) *Builder
  • func (b *Builder) WithEmailServiceFactory(f EmailServiceFactory) *Builder
  • func (b *Builder) WithMaxFieldChars(max int) *Builder
  • func (b *Builder) WithMaxResultChars(max int) *Builder
  • func (b *Builder) WithMaxResumesPerSession(max int) *Builder
  • func (b *Builder) WithMaxStepsPerSprint(max int) *Builder
  • func (b *Builder) WithMaxTemplateChars(max int) *Builder
  • func (b *Builder) WithWebhookServiceFactory(f WebhookServiceFactory) *Builder
• type ClassificationServiceFactory
• type EmailServiceFactory
• type Error
  • func (e *Error) Code() int
  • func (e *Error) Error() string
• type WebhookServiceFactory

Constants

const (
	ErrorResumeNonWaitingSession int = 101
	ErrorResumeNoWaitingRun      int = 102
	ErrorResumeRejectedByWait    int = 103
)

Functions

func NewSessionAssets

func NewSessionAssets(env envs.Environment, source assets.Source, migrationConfig *migrations.Config) (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, segments []flows.Segment) flows.Sprint

NewSprint creates a new sprint - engine doesn't use this but we do it when handling surveyor responses

Types

type AirtimeServiceFactory

type AirtimeServiceFactory func(flows.SessionAssets) (flows.AirtimeService, error)

AirtimeServiceFactory resolves a session to an airtime service

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 engine builder

func (*Builder) Build

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

Build returns the final engine

func (*Builder) WithAirtimeServiceFactory

func (b *Builder) WithAirtimeServiceFactory(f AirtimeServiceFactory) *Builder

WithAirtimeServiceFactory sets the airtime service factory

func (*Builder) WithClassificationServiceFactory

func (b *Builder) WithClassificationServiceFactory(f ClassificationServiceFactory) *Builder

WithClassificationServiceFactory sets the NLU service factory

func (*Builder) WithEmailServiceFactory

func (b *Builder) WithEmailServiceFactory(f EmailServiceFactory) *Builder

WithEmailServiceFactory sets the email service factory

func (*Builder) WithMaxFieldChars

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

WithMaxFieldChars sets the maximum number of characters allowed in a contact field value

func (*Builder) WithMaxResultChars

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

WithMaxResultChars sets the maximum number of characters allowed in a result value

func (*Builder) WithMaxResumesPerSession

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

WithMaxResumesPerSession sets the maximum number of resumes allowed in a single session

func (*Builder) WithMaxStepsPerSprint

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

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

func (*Builder) WithMaxTemplateChars

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

WithMaxTemplateChars sets the maximum number of characters allowed from an evaluated template

func (*Builder) WithWebhookServiceFactory

func (b *Builder) WithWebhookServiceFactory(f WebhookServiceFactory) *Builder

WithWebhookServiceFactory sets the webhook service factory

type ClassificationServiceFactory

type ClassificationServiceFactory func(*flows.Classifier) (flows.ClassificationService, error)

ClassificationServiceFactory resolves a session and classifier to an NLU service

type EmailServiceFactory

type EmailServiceFactory func(flows.SessionAssets) (flows.EmailService, error)

EmailServiceFactory resolves a session to a email service

type Error

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

func (*Error) Code

func (e *Error) Code() int

func (*Error) Error

func (e *Error) Error() string

type WebhookServiceFactory

type WebhookServiceFactory func(flows.SessionAssets) (flows.WebhookService, error)

WebhookServiceFactory resolves a session to a webhook service