inputs

Documentation

Index

• Constants
• func ReadInput(session flows.Session, envelope *utils.TypedEnvelope) (flows.Input, error)
• func ReadMsgInput(session flows.Session, data json.RawMessage) (flows.Input, error)
• func RegisterType(name string, f readFunc)
• type MsgInput
  • func NewMsgInput(uuid flows.InputUUID, channel flows.Channel, createdOn time.Time, urn urns.URN, ...) *MsgInput
  • func (i *MsgInput) Channel() flows.Channel
  • func (i *MsgInput) CreatedOn() time.Time
  • func (i *MsgInput) Describe() string
  • func (i *MsgInput) MarshalJSON() ([]byte, error)
  • func (i *MsgInput) Reduce(env utils.Environment) types.XPrimitive
  • func (i *MsgInput) Resolve(env utils.Environment, key string) types.XValue
  • func (i *MsgInput) ToXJSON(env utils.Environment) types.XText
  • 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(session flows.Session, envelope *utils.TypedEnvelope) (flows.Input, error)

ReadInput reads an input from the given typed envelope

func ReadMsgInput

func ReadMsgInput(session flows.Session, data json.RawMessage) (flows.Input, error)

ReadMsgInput reads a message input from the given JSON

func RegisterType

func RegisterType(name string, f readFunc)

RegisterType registers a new type of input

Types

type MsgInput

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

MsgInput is a message which can be used as input

func NewMsgInput

func NewMsgInput(uuid flows.InputUUID, channel flows.Channel, createdOn time.Time, urn urns.URN, text string, attachments []flows.Attachment) *MsgInput

NewMsgInput creates a new user input based on a message

func (*MsgInput) Channel

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

func (*MsgInput) CreatedOn

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

func (*MsgInput) Describe

func (i *MsgInput) Describe() string

Describe returns a representation of this type for error messages

func (*MsgInput) MarshalJSON

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

MarshalJSON marshals this msg input into JSON

func (*MsgInput) Reduce

func (i *MsgInput) Reduce(env utils.Environment) types.XPrimitive

Reduce is called when this object needs to be reduced to a primitive

func (*MsgInput) Resolve

func (i *MsgInput) Resolve(env utils.Environment, key string) types.XValue

Resolve resolves the given key when this input is referenced in an expression

func (*MsgInput) ToXJSON

func (i *MsgInput) ToXJSON(env utils.Environment) types.XText

ToXJSON is called when this type is passed to @(json(...))

func (*MsgInput) Type

func (i *MsgInput) Type() string

Type returns the type of this event

func (*MsgInput) UUID

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