inputs

package

v0.23.0 Latest Latest Go to latest Published: Oct 25, 2018 License: AGPL-3.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const TypeMsg string = "msg"

TypeMsg is a constant for incoming messages

This section is empty.

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

ReadInput reads an input from the given typed envelope

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

ReadMsgInput reads a message input from the given JSON

func RegisterType(name string, f readFunc)

RegisterType registers a new type of input

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

MsgInput is a message which can be used as input

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

NewMsgInput creates a new user input based on a message

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

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

func (i *MsgInput) Describe() string

Describe returns a representation of this type for error messages

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

MarshalJSON marshals this msg input into JSON

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

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

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 (i *MsgInput) ToXJSON(env utils.Environment) types.XText

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

func (i *MsgInput) Type() string

Type returns the type of this input

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