template

Documentation

Index

• type CommandMatchers
• type Paginate
• type ParseMessage
• type Select
• type Template
  • func FindTemplate(tpls []Template, cmd string) (Template, bool)
  • func (su *Template) UnmarshalYAML(node *yaml.Node) error
• type Trigger
• type TutorialMessage
• type WrapMessage

Types

type CommandMatchers

type CommandMatchers struct {
	Prefix string `yaml:"prefix"`
	Regexp string `yaml:"regex"`
}

CommandMatchers represents different command matching strategies.

type Paginate

type Paginate struct {
	Page        int `yaml:"page"`
	CurrentPage int `yaml:"-"`
}

Paginate holds data required to do the pagination.

type ParseMessage

type ParseMessage struct {
	Selects []Select          `yaml:"selects"`
	Actions map[string]string `yaml:"actions"`
	Preview string            `yaml:"preview"`
}

ParseMessage holds template for message that will be parsed by defined parser.

type Select

type Select struct {
	Name   string `yaml:"name"`
	KeyTpl string `yaml:"keyTpl"`
}

Select holds template select primitive definition.

type Template

type Template struct {
	Type                 string          `yaml:"type"`
	Trigger              Trigger         `yaml:"trigger"`
	SkipCommandExecution bool            `yaml:"-"`
	ParseMessage         ParseMessage    `yaml:"-"`
	WrapMessage          WrapMessage     `yaml:"-"`
	TutorialMessage      TutorialMessage `yaml:"-"`
}

Template represents a template for message parsing.

func FindTemplate

func FindTemplate(tpls []Template, cmd string) (Template, bool)

FindTemplate finds a template with a matching command prefix.

func (*Template) UnmarshalYAML

func (su *Template) UnmarshalYAML(node *yaml.Node) error

UnmarshalYAML is a custom unmarshaler for Template allowing to unmarshal into a proper struct base on defined template type.

type Trigger

type Trigger struct {
	Command CommandMatchers `yaml:"command"`
}

Trigger represents the trigger configuration for a template.

type TutorialMessage

type TutorialMessage struct {
	Buttons  api.Buttons `yaml:"buttons"`
	Header   string      `yaml:"header"`
	Paginate Paginate    `yaml:"paginate"`
}

TutorialMessage holds template interactive tutorial message.

type WrapMessage

type WrapMessage struct {
	Buttons api.Buttons `yaml:"buttons"`
}

WrapMessage holds template for wrapping command output with additional context.