flow

Documentation

Index

• func DialogGoto(toName Name) func(*Flow, map[string]interface{}) (Name, State, map[string]string, error)
• func Goto(toName Name) func(*Flow) (Name, State, error)
• type Button
• type Color
• type Flow
  • func NewFlow(name Name, api *pluginapi.Client, pluginURL, botUserID string) *Flow
  • func (f *Flow) Finish() error
  • func (f *Flow) ForUser(userID string) *Flow
  • func (f *Flow) GetCurrentStep() (Name, error)
  • func (f *Flow) GetState() State
  • func (f *Flow) Go(toName Name) error
  • func (f *Flow) InitHTTP(r *mux.Router) *Flow
  • func (f *Flow) OnDone(done func(string, State) error) *Flow
  • func (f *Flow) Start(appState State) error
  • func (f *Flow) WithDebugLog() *Flow
  • func (f *Flow) WithSteps(orderedSteps ...Step) *Flow
• type Name
• type State
  • func (s State) GetBool(key string) bool
  • func (s State) GetInt(key string) int
  • func (s State) GetString(key string) string
  • func (s State) MergeWith(update State) State
• type Step
  • func NewStep(name Name) Step
  • func (s Step) Next(name Name) Step
  • func (s Step) OnRender(f func(*Flow)) Step
  • func (s Step) Terminal() Step
  • func (s Step) WithButton(buttons ...Button) Step
  • func (s Step) WithColor(color Color) Step
  • func (s Step) WithField(title, value string) Step
  • func (s Step) WithImage(imageURL string) Step
  • func (s Step) WithPretext(text string) Step
  • func (s Step) WithText(text string) Step
  • func (s Step) WithTitle(text string) Step

Functions

func DialogGoto

func DialogGoto(toName Name) func(*Flow, map[string]interface{}) (Name, State, map[string]string, error)

func Goto

func Goto(toName Name) func(*Flow) (Name, State, error)

Types

type Button

type Button struct {
	Name     string
	Disabled bool
	Color    Color

	// OnClick is called when the button is clicked. It returns the next step's
	// name and the state updates to apply.
	//
	// If Dialog is also specified, OnClick is executed first.
	OnClick func(f *Flow) (Name, State, error)

	// Dialog is the interactive dialog to display if the button is clicked
	// (OnClick is executed first). OnDialogSubmit must be provided.
	Dialog *model.Dialog

	// Function that is called when the dialog box is submitted. It can return a
	// general error, or field-specific errors. On success it returns the name
	// of the next step, and the state updates to apply.
	OnDialogSubmit func(f *Flow, submitted map[string]interface{}) (Name, State, map[string]string, error)
}

type Color

type Color string

const (
	ColorDefault Color = "default"
	ColorPrimary Color = "primary"
	ColorSuccess Color = "success"
	ColorGood    Color = "good"
	ColorWarning Color = "warning"
	ColorDanger  Color = "danger"
)

type Flow

type Flow struct {
	UserID string
	// contains filtered or unexported fields
}

func NewFlow

func NewFlow(name Name, api *pluginapi.Client, pluginURL, botUserID string) *Flow

NewFlow creates a new flow using direct messages with the user.

name must be a unique identifier for the flow within the plugin.

func (*Flow) Finish

func (f *Flow) Finish() error

func (*Flow) ForUser

func (f *Flow) ForUser(userID string) *Flow

ForUser creates a new flow using direct messages with the user.

func (*Flow) GetCurrentStep

func (f *Flow) GetCurrentStep() (Name, error)

func (*Flow) GetState

func (f *Flow) GetState() State

func (*Flow) Go

func (f *Flow) Go(toName Name) error

func (*Flow) InitHTTP

func (f *Flow) InitHTTP(r *mux.Router) *Flow

func (*Flow) OnDone

func (f *Flow) OnDone(done func(string, State) error) *Flow

func (*Flow) Start

func (f *Flow) Start(appState State) error

func (*Flow) WithDebugLog

func (f *Flow) WithDebugLog() *Flow

func (*Flow) WithSteps

func (f *Flow) WithSteps(orderedSteps ...Step) *Flow

type Name

type Name string

type State

type State map[string]interface{}

State is the "app"'s state

func (State) GetBool

func (s State) GetBool(key string) bool

GetBool return the value to a given key as a bool. If the key is not found or isn't a bool, false is returned.

func (State) GetInt

func (s State) GetInt(key string) int

GetInt return the value to a given key as a int. If the key is not found or isn't an int, zero is returned.

func (State) GetString

func (s State) GetString(key string) string

GetString return the value to a given key as a string. If the key is not found or isn't a string, an empty string is returned.

func (State) MergeWith

func (s State) MergeWith(update State) State

type Step

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

func NewStep

func NewStep(name Name) Step

func (Step) Next

func (s Step) Next(name Name) Step

func (Step) OnRender

func (s Step) OnRender(f func(*Flow)) Step

func (Step) Terminal

func (s Step) Terminal() Step

func (Step) WithButton

func (s Step) WithButton(buttons ...Button) Step

func (Step) WithColor

func (s Step) WithColor(color Color) Step

func (Step) WithField

func (s Step) WithField(title, value string) Step

func (Step) WithImage

func (s Step) WithImage(imageURL string) Step

func (Step) WithPretext

func (s Step) WithPretext(text string) Step

func (Step) WithText

func (s Step) WithText(text string) Step

func (Step) WithTitle

func (s Step) WithTitle(text string) Step