triggers

package
v0.19.0 Latest Latest
Warning

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

 Go to latest Published: Sep 28, 2018 License: AGPL-3.0 Imports: 8 Imported by: 13

Documentation

Index

Constants

View Source 
const TypeCampaign string = "campaign"

TypeCampaign is the type for sessions triggered by campaign events

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 *assets.FlowReference, params types.XValue, triggeredOn time.Time) flows.Trigger

NewManualTrigger creates a new manual trigger

func ReadCampaignTrigger added in v0.12.2 

func ReadCampaignTrigger(session flows.Session, data json.RawMessage) (flows.Trigger, error)

ReadCampaignTrigger reads a campaign trigger

func ReadFlowActionTrigger 

func ReadFlowActionTrigger(session flows.Session, data json.RawMessage) (flows.Trigger, error)

ReadFlowActionTrigger reads a flow action trigger

func ReadManualTrigger 

func ReadManualTrigger(session flows.Session, data json.RawMessage) (flows.Trigger, error)

ReadManualTrigger reads a manual trigger

func ReadTrigger 

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

ReadTrigger reads a trigger from the given typed envelope

func RegisterType added in v0.11.0 

func RegisterType(name string, f readFunc)

RegisterType registers a new type of trigger

Types

type Campaign added in v0.12.2 

type Campaign struct {
	UUID string `json:"uuid" validate:"required,uuid4"`
	Name string `json:"name" validate:"required"`
}

Campaign describes the campaign that triggered the session

type CampaignEvent added in v0.12.2 

type CampaignEvent struct {
	UUID     string   `json:"uuid" validate:"required,uuid4"`
	Campaign Campaign `json:"campaign" validate:"required,dive"`
}

CampaignEvent describes the specific event in the campaign that triggered the session

type CampaignTrigger added in v0.12.2 

type CampaignTrigger struct {
	Event *CampaignEvent
	// contains filtered or unexported fields
}

CampaignTrigger is used when a session was triggered by a campaign event 

{
  "type": "campaign",
  "flow": {"uuid": "50c3706e-fedb-42c0-8eab-dda3335714b7", "name": "Registration"},
  "contact": {
    "uuid": "9f7ede93-4b16-4692-80ad-b7dc54a1cd81",
    "name": "Bob"
  },
  "event": {
      "uuid": "34d16dbd-476d-4b77-bac3-9f3d597848cc",
      "campaign": {"uuid": "58e9b092-fe42-4173-876c-ff45a14a24fe", "name": "New Mothers"}
  },
  "triggered_on": "2000-01-01T00:00:00.000000000-00:00"
}

@trigger campaign

func NewCampaignTrigger added in v0.14.4 

func NewCampaignTrigger(env utils.Environment, flow *assets.FlowReference, contact *flows.Contact, event *CampaignEvent, triggeredOn time.Time) *CampaignTrigger

NewCampaignTrigger creates a new campaign trigger with the passed in values

func (*CampaignTrigger) Contact added in v0.12.2 

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

func (*CampaignTrigger) Describe added in v0.12.2 

func (t *CampaignTrigger) Describe() string

Describe returns a representation of this type for error messages

func (*CampaignTrigger) Environment added in v0.12.2 

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

func (*CampaignTrigger) Flow added in v0.12.2 

func (t *CampaignTrigger) Flow() *assets.FlowReference

func (*CampaignTrigger) MarshalJSON added in v0.12.2 

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

MarshalJSON marshals this trigger into JSON

func (*CampaignTrigger) Params added in v0.12.2 

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

func (*CampaignTrigger) Reduce added in v0.12.2 

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

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

func (*CampaignTrigger) Resolve added in v0.12.2 

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

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

func (*CampaignTrigger) ToXJSON added in v0.12.2 

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

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

func (*CampaignTrigger) TriggeredOn added in v0.12.2 

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

func (*CampaignTrigger) Type added in v0.12.2 

func (t *CampaignTrigger) Type() string

Type returns the type of this trigger

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": "b7cf0d83-f1c9-411c-96fd-c511a4cfa86d", "name": "Collect Age"},
  "triggered_on": "2000-01-01T00:00:00.000000000-00:00",
  "run": {
    "uuid": "b7cf0d83-f1c9-411c-96fd-c511a4cfa86d",
    "flow": {"uuid": "50c3706e-fedb-42c0-8eab-dda3335714b7", "name": "Registration"},
    "contact": {
      "uuid": "c59b0033-e748-4240-9d4c-e85eb6800151",
      "name": "Bob",
      "fields": {"gender": {"text": "Male"}}
    },
    "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"
      }
    }
  }
}

@trigger flow_action

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() *assets.FlowReference

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

Run returns the summary of the run that triggered this session

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": "50c3706e-fedb-42c0-8eab-dda3335714b7", "name": "Registration"},
  "contact": {
    "uuid": "9f7ede93-4b16-4692-80ad-b7dc54a1cd81",
    "name": "Bob"
  },
  "triggered_on": "2000-01-01T00:00:00.000000000-00:00"
}

@trigger manual

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() *assets.FlowReference

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.