waits

Documentation

Index

• Constants
• func ReadWait(data json.RawMessage) (flows.Wait, error)
• type DialWait
  • func NewDialWait(phone string) *DialWait
  • func (w *DialWait) AllowedFlowTypes() []flows.FlowType
  • func (w *DialWait) Begin(run flows.Run, log flows.EventCallback) bool
  • func (w *DialWait) End(resume flows.Resume) error
  • func (w *DialWait) MarshalJSON() ([]byte, error)
  • func (w *DialWait) Timeout() flows.Timeout
  • func (w *DialWait) Type() string
• type MsgWait
  • func NewMsgWait(timeout *Timeout, hint flows.Hint) *MsgWait
  • func (w *MsgWait) AllowedFlowTypes() []flows.FlowType
  • func (w *MsgWait) Begin(run flows.Run, log flows.EventCallback) bool
  • func (w *MsgWait) End(resume flows.Resume) error
  • func (w *MsgWait) Hint() flows.Hint
  • func (w *MsgWait) MarshalJSON() ([]byte, error)
  • func (w *MsgWait) Timeout() flows.Timeout
  • func (w *MsgWait) Type() string
• type Timeout
  • func NewTimeout(seconds int, categoryUUID flows.CategoryUUID) *Timeout
  • func (t *Timeout) CategoryUUID() flows.CategoryUUID
  • func (t *Timeout) Seconds() int

Constants

const TypeDial string = "dial"

TypeDial is the type of our dial wait

const TypeMsg string = "msg"

TypeMsg is the type of our message wait

Functions

func ReadWait

func ReadWait(data json.RawMessage) (flows.Wait, error)

ReadWait reads a wait from the given JSON

Types

type DialWait

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

DialWait is a wait which waits for a phone number to be dialed

func NewDialWait

func NewDialWait(phone string) *DialWait

NewDialWait creates a new Dial wait

func (*DialWait) AllowedFlowTypes

func (w *DialWait) AllowedFlowTypes() []flows.FlowType

AllowedFlowTypes returns the flow types which this wait is allowed to occur in

func (*DialWait) Begin

func (w *DialWait) Begin(run flows.Run, log flows.EventCallback) bool

Begin beings waiting at this wait

func (*DialWait) End

func (w *DialWait) End(resume flows.Resume) error

End ends this wait or returns an error

func (*DialWait) MarshalJSON

func (w *DialWait) MarshalJSON() ([]byte, error)

MarshalJSON marshals this wait into JSON

func (*DialWait) Timeout

func (w *DialWait) Timeout() flows.Timeout

Timeout returns the timeout of this wait or nil if no timeout is set

func (*DialWait) Type

func (w *DialWait) Type() string

Type returns the type of this wait

type MsgWait

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

MsgWait is a wait which waits for an incoming message (i.e. a msg_received event)

func NewMsgWait

func NewMsgWait(timeout *Timeout, hint flows.Hint) *MsgWait

NewMsgWait creates a new message wait

func (*MsgWait) AllowedFlowTypes

func (w *MsgWait) AllowedFlowTypes() []flows.FlowType

AllowedFlowTypes returns the flow types which this wait is allowed to occur in

func (*MsgWait) Begin

func (w *MsgWait) Begin(run flows.Run, log flows.EventCallback) bool

Begin beings waiting at this wait

func (*MsgWait) End

func (w *MsgWait) End(resume flows.Resume) error

End ends this wait or returns an error

func (*MsgWait) Hint

func (w *MsgWait) Hint() flows.Hint

Hint returns the hint (optional)

func (*MsgWait) MarshalJSON

func (w *MsgWait) MarshalJSON() ([]byte, error)

MarshalJSON marshals this wait into JSON

func (*MsgWait) Timeout

func (w *MsgWait) Timeout() flows.Timeout

Timeout returns the timeout of this wait or nil if no timeout is set

func (*MsgWait) Type

func (w *MsgWait) Type() string

Type returns the type of this wait

type Timeout

type Timeout struct {
	Seconds_      int                `json:"seconds"       validate:"required"`
	CategoryUUID_ flows.CategoryUUID `json:"category_uuid" validate:"required,uuid4"`
}

func NewTimeout

func NewTimeout(seconds int, categoryUUID flows.CategoryUUID) *Timeout

func (*Timeout) CategoryUUID

func (t *Timeout) CategoryUUID() flows.CategoryUUID

func (*Timeout) Seconds

func (t *Timeout) Seconds() int