inputs

Documentation

Index

• Constants
• func ReadInput(sessionAssets flows.SessionAssets, data json.RawMessage, ...) (flows.Input, error)
• type MsgInput
  • func NewMsg(assets flows.SessionAssets, msg *flows.MsgIn, createdOn time.Time) (*MsgInput, error)
  • func (i *MsgInput) Channel() *flows.Channel
  • func (i *MsgInput) Context(env envs.Environment) map[string]types.XValue
  • func (i *MsgInput) CreatedOn() time.Time
  • func (i *MsgInput) MarshalJSON() ([]byte, error)
  • func (i *MsgInput) Type() string
  • func (i *MsgInput) UUID() flows.InputUUID

Constants

const TypeMsg string = "msg"

TypeMsg is a constant for incoming messages

Functions

func ReadInput

func ReadInput(sessionAssets flows.SessionAssets, data json.RawMessage, missing assets.MissingCallback) (flows.Input, error)

ReadInput reads an input from the given typed envelope

Types

type MsgInput

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

MsgInput is a message which can be used as input

func NewMsg

func NewMsg(assets flows.SessionAssets, msg *flows.MsgIn, createdOn time.Time) (*MsgInput, error)

NewMsg creates a new user input based on a message

func (*MsgInput) Channel

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

func (*MsgInput) Context

func (i *MsgInput) 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 (*MsgInput) CreatedOn

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

func (*MsgInput) MarshalJSON

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

MarshalJSON marshals this msg input into JSON

func (*MsgInput) Type

func (i *MsgInput) Type() string

Type returns the type of this input

func (*MsgInput) UUID

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