template

Documentation

Index

• func CheckTemplateName(name string) error
• type FileNotFoundError
  • func (t FileNotFoundError) Error() string
• type RegistrationRequest
• type Template
  • func New(m map[string]interface{}, hs map[string]handler.Handler) (*Template, string, error)
  • func (t *Template) RenderBody(arguments map[string]interface{}) (string, error)
  • func (t *Template) RenderSubject(arguments map[string]interface{}) (string, error)

Functions

func CheckTemplateName

func CheckTemplateName(name string) error

CheckTemplateName validates the name of the template.

Types

type FileNotFoundError

type FileNotFoundError struct {
	TemplateFileName string
	Err              error
}

FileNotFoundError is the error returned when a template file is missing.

func (FileNotFoundError) Error

func (t FileNotFoundError) Error() string

Error returns the string error msg for FileNotFoundError.

type RegistrationRequest

type RegistrationRequest struct {
	Name            string `json:"name"                  mapstructure:"name"`
	Handler         string `json:"handler"               mapstructure:"handler"`
	BodyTmplPath    string `json:"body_template_path"    mapstructure:"body_template_path"`
	SubjectTmplPath string `json:"subject_template_path" mapstructure:"subject_template_path"`
	Persistent      bool   `json:"persistent"            mapstructure:"persistent"`
}

RegistrationRequest represents a Template registration request.

type Template

type Template struct {
	Name       string
	Handler    handler.Handler
	Persistent bool
	// contains filtered or unexported fields
}

Template represents a notification template.

func New

func New(m map[string]interface{}, hs map[string]handler.Handler) (*Template, string, error)

New creates a new Template from a RegistrationRequest.

func (*Template) RenderBody

func (t *Template) RenderBody(arguments map[string]interface{}) (string, error)

RenderBody renders the body template.

func (*Template) RenderSubject

func (t *Template) RenderSubject(arguments map[string]interface{}) (string, error)

RenderSubject renders the subject template.