triggers

package
v0.10.9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 25, 2018 License: AGPL-3.0 Imports: 7 Imported by: 13

Documentation

Index

Constants

View Source 
const TypeFlowAction string = "flow_action"

TypeFlowAction is a constant for sessions triggered by flow actions in other sessions

View Source 
const TypeManual string = "manual"

TypeManual is the type for manually triggered sessions

Variables

This section is empty.

Functions

func NewManualTrigger 

func NewManualTrigger(env utils.Environment, contact *flows.Contact, flow flows.Flow, params types.XValue, triggeredOn time.Time) flows.Trigger

NewManualTrigger creates a new manual trigger

func ReadFlowActionTrigger 

func ReadFlowActionTrigger(session flows.Session, envelope *utils.TypedEnvelope) (flows.Trigger, error)

func ReadManualTrigger 

func ReadManualTrigger(session flows.Session, envelope *utils.TypedEnvelope) (flows.Trigger, error)

func ReadTrigger 

func ReadTrigger(session flows.Session, envelope *utils.TypedEnvelope) (flows.Trigger, error)

Types

type FlowActionTrigger 

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

FlowActionTrigger is used when another session triggered this run using a trigger_flow action.

``` 

{
  "type": "flow_action",
  "flow": {"uuid": "ea7d8b6b-a4b2-42c1-b9cf-c0370a95a721", "name": "Registration"},
  "triggered_on": "2000-01-01T00:00:00.000000000-00:00",
  "run": {
    "uuid": "b7cf0d83-f1c9-411c-96fd-c511a4cfa86d",
    "flow": {"uuid": "93c554a1-b90d-4892-b029-a2a87dec9b87", "name": "Other Flow"},
    "contact": {
      "uuid": "c59b0033-e748-4240-9d4c-e85eb6800151",
      "name": "Bob",
      "fields": {"state": {"value": "Azuay", "created_on": "2000-01-01T00:00:00.000000000-00:00"}}
    },
    "status": "active",
    "results": {
      "age": {
        "result_name": "Age",
        "value": "33",
        "node": "cd2be8c4-59bc-453c-8777-dec9a80043b8",
        "created_on": "2000-01-01T00:00:00.000000000-00:00"
      }
    }
  }
}

```

func (*FlowActionTrigger) Contact added in v0.5.0 

func (t *FlowActionTrigger) Contact() *flows.Contact

func (*FlowActionTrigger) Describe added in v0.10.1 

func (t *FlowActionTrigger) Describe() string

Describe returns a representation of this type for error messages

func (*FlowActionTrigger) Environment added in v0.5.0 

func (t *FlowActionTrigger) Environment() utils.Environment

func (*FlowActionTrigger) Flow 

func (t *FlowActionTrigger) Flow() flows.Flow

func (*FlowActionTrigger) MarshalJSON 

func (t *FlowActionTrigger) MarshalJSON() ([]byte, error)

MarshalJSON marshals this trigger into JSON

func (*FlowActionTrigger) Params added in v0.5.0 

func (t *FlowActionTrigger) Params() types.XValue

func (*FlowActionTrigger) Reduce added in v0.8.0 

func (t *FlowActionTrigger) Reduce(env utils.Environment) types.XPrimitive

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

func (*FlowActionTrigger) Resolve added in v0.5.0 

func (t *FlowActionTrigger) Resolve(env utils.Environment, key string) types.XValue

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

func (*FlowActionTrigger) Run 

func (t *FlowActionTrigger) Run() flows.RunSummary

func (*FlowActionTrigger) ToXJSON added in v0.8.0 

func (t *FlowActionTrigger) ToXJSON(env utils.Environment) types.XText

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

func (*FlowActionTrigger) TriggeredOn 

func (t *FlowActionTrigger) TriggeredOn() time.Time

func (*FlowActionTrigger) Type 

func (t *FlowActionTrigger) Type() string

Type returns the type of this trigger

type ManualTrigger 

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

ManualTrigger is used when a session was triggered manually by a user

``` 

{
  "type": "manual",
  "flow": {"uuid": "ea7d8b6b-a4b2-42c1-b9cf-c0370a95a721", "name": "Registration"},
  "contact": {
    "uuid": "9f7ede93-4b16-4692-80ad-b7dc54a1cd81",
    "name": "Bob"
  },
  "triggered_on": "2000-01-01T00:00:00.000000000-00:00"
}

```

func (*ManualTrigger) Contact added in v0.5.0 

func (t *ManualTrigger) Contact() *flows.Contact

func (*ManualTrigger) Describe added in v0.10.1 

func (t *ManualTrigger) Describe() string

Describe returns a representation of this type for error messages

func (*ManualTrigger) Environment added in v0.5.0 

func (t *ManualTrigger) Environment() utils.Environment

func (*ManualTrigger) Flow 

func (t *ManualTrigger) Flow() flows.Flow

func (*ManualTrigger) MarshalJSON 

func (t *ManualTrigger) MarshalJSON() ([]byte, error)

MarshalJSON marshals this trigger into JSON

func (*ManualTrigger) Params added in v0.5.0 

func (t *ManualTrigger) Params() types.XValue

func (*ManualTrigger) Reduce added in v0.8.0 

func (t *ManualTrigger) Reduce(env utils.Environment) types.XPrimitive

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

func (*ManualTrigger) Resolve added in v0.5.0 

func (t *ManualTrigger) Resolve(env utils.Environment, key string) types.XValue

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

func (*ManualTrigger) ToXJSON added in v0.8.0 

func (t *ManualTrigger) ToXJSON(env utils.Environment) types.XText

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

func (*ManualTrigger) TriggeredOn 

func (t *ManualTrigger) TriggeredOn() time.Time

func (*ManualTrigger) Type 

func (t *ManualTrigger) Type() string

Type returns the type of this trigger

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.