listen_collection

Documentation

Index

• Constants
• type Component
  • func (g *Component) GetInfo() module.ComponentInfo
  • func (g *Component) Handle(ctx context.Context, handler module.Handler, port string, msg interface{}) error
  • func (g *Component) Instance() module.Component
  • func (g *Component) Ports() []module.Port
• type Context
• type Error
• type Response
• type Settings
• type Start
• type StartControl
• type Stop
• type StopControl

Constants

const (
	ComponentName = "firestore_listen_collection"
	ResponsePort  = "response"
	StartPort     = "start"
	StopPort      = "stop"
	ErrorPort     = "error"
)

Types

type Component

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

func (*Component) GetInfo

func (g *Component) GetInfo() module.ComponentInfo

func (*Component) Handle

func (g *Component) Handle(ctx context.Context, handler module.Handler, port string, msg interface{}) error

func (*Component) Instance

func (g *Component) Instance() module.Component

func (*Component) Ports

func (g *Component) Ports() []module.Port

type Context

type Context any

type Error

type Error struct {
	Context Context `json:"context"`
	Error   string  `json:"error"`
}

type Response

type Response struct {
	Context  Context                `json:"context" title:"Context"`
	RefID    string                 `json:"refID"`
	Document map[string]interface{} `json:"document" title:"Document" description:"Document that changed"`
	Action   string                 `json:"action" title:"Action" enum:"added,modified,removed"`
}

type Settings

type Settings struct {
	EnableErrorPort bool `` /* 137-byte string literal not displayed */
	EnableStopPort  bool `json:"enableStopPort" required:"true" title:"Enable stop port" description:"Stop port allows you to stop listener"`
}

type Start

type Start struct {
	Context    Context          `json:"context,omitempty" title:"Context" configurable:"true"`
	Config     etc.ClientConfig `json:"config" title:"Config"  required:"true" description:"Client Config"`
	Collection string           `json:"collection" title:"Collection" required:"true"`
	Wheres     []utils.Where    `json:"wheres,omitempty" title:"Where" description:"Where to filter. Leave empty if you want to listen the entire collection."`
}

type StartControl

type StartControl struct {
	Status string `json:"status" title:"Status" readonly:"true"`
}

type Stop

type Stop struct {
}

type StopControl

type StopControl struct {
	Stop   bool   `json:"stop" format:"button" title:"Stop" required:"true" description:"Stop listening"`
	Status string `json:"status" title:"Status" readonly:"true"`
}