actions

Documentation

Index

• func DoActionCommand(ctx context.Context, req *backend.CallResourceRequest, handler ActionHandler, ...) error
• type ActionCommand
• type ActionHandler
• type ActionResponse

Functions

func DoActionCommand

func DoActionCommand(ctx context.Context, req *backend.CallResourceRequest, handler ActionHandler, sender backend.CallResourceResponseSender) error

Types

type ActionCommand

type ActionCommand struct {
	ID      string      `json:"id,omitempty"`      // Identify the command (optional)
	Path    string      `json:"path,omitempty"`    // Path for the value
	Value   interface{} `json:"value,omitempty"`   // Write values
	Comment string      `json:"comment,omitempty"` // Write all values or
	From    string      `json:"from,omitempty"`    // optional say where the command was listed from
}

ActionCommand write the values

type ActionHandler

type ActionHandler interface {
	ExecuteAction(ctx context.Context, cmd ActionCommand) ActionResponse
}

type ActionResponse

type ActionResponse struct {
	Code  int         `json:"code,omitempty"` // Match HTTP response code
	Error string      `json:"error,omitempty"`
	State interface{} `json:"state,omitempty"`
}