inputs

Documentation

Index

• Constants
• func Read(sa flows.SessionAssets, data []byte, missing assets.MissingCallback) (flows.Input, error)
• type Msg
  • func NewMsg(sa flows.SessionAssets, evt *events.MsgReceived) *Msg
  • func (i *Msg) Channel() *flows.Channel
  • func (i *Msg) Context(env envs.Environment) map[string]types.XValue
  • func (i *Msg) CreatedOn() time.Time
  • func (i *Msg) MarshalJSON() ([]byte, error)
  • func (i *Msg) Type() string
  • func (i *Msg) UUID() flows.InputUUID

Constants

const TypeMsg string = "msg"

TypeMsg is a constant for incoming messages

Functions

func Read

func Read(sa flows.SessionAssets, data []byte, missing assets.MissingCallback) (flows.Input, error)

Read reads an input from the given typed envelope

Types

type Msg

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

Msg is a message which can be used as input

func NewMsg

func NewMsg(sa flows.SessionAssets, evt *events.MsgReceived) *Msg

NewMsg creates a new user input based on a message event

func (*Msg) Channel

func (i *Msg) Channel() *flows.Channel

func (*Msg) Context

func (i *Msg) Context(env envs.Environment) map[string]types.XValue

Context returns the properties available in expressions

__default__:text -> the text and attachments
uuid:text -> the UUID of the input
created_on:datetime -> the creation date of the input
channel:channel -> the channel that the input was received on
urn:text -> the contact URN that the input was received on
text:text -> the text part of the input
attachments:[]text -> any attachments on the input
external_id:text -> the external ID of the input

@context input

func (*Msg) CreatedOn

func (i *Msg) CreatedOn() time.Time

func (*Msg) MarshalJSON

func (i *Msg) MarshalJSON() ([]byte, error)

MarshalJSON marshals this msg input into JSON

func (*Msg) Type

func (i *Msg) Type() string

Type returns the type of this input

func (*Msg) UUID

func (i *Msg) UUID() flows.InputUUID