actions

Documentation

Overview

Package actions provides a scheduler action for generating mail digests

Index

• type MailDigestAction
  • func (m *MailDigestAction) GetDescription(lang ...string) actions.ActionDescription
  • func (m *MailDigestAction) GetName() string
  • func (m *MailDigestAction) GetParametersForm() *forms.Form
  • func (m *MailDigestAction) Init(job *jobs.Job, cl client.Client, action *jobs.Action) error
  • func (m *MailDigestAction) Run(ctx context.Context, channels *actions.RunnableChannels, ...) (jobs.ActionMessage, error)

Types

type MailDigestAction

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

func (*MailDigestAction) GetDescription

func (m *MailDigestAction) GetDescription(lang ...string) actions.ActionDescription

GetDescription returns the action description

func (*MailDigestAction) GetName

func (m *MailDigestAction) GetName() string

GetName returns the Unique Identifier of the MailDigestAction.

func (*MailDigestAction) GetParametersForm

func (m *MailDigestAction) GetParametersForm() *forms.Form

GetParametersForm returns an UX Form

func (*MailDigestAction) Init

func (m *MailDigestAction) Init(job *jobs.Job, cl client.Client, action *jobs.Action) error

Init passes parameters to a newly created instance.

func (*MailDigestAction) Run

func (m *MailDigestAction) Run(ctx context.Context, channels *actions.RunnableChannels, input jobs.ActionMessage) (jobs.ActionMessage, error)

Run processes the actual action code