notifications

Documentation

Index

• type Composer
• type ContentSet
• type FileSystemComposer
  • func NewFileSystemComposer(templatesDir string) *FileSystemComposer
  • func (r *FileSystemComposer) Render(notification string, data map[string]interface{}, carrier string) (*ContentSet, error)
• type NopComposer
  • func NewNopComposer() *NopComposer
  • func (n *NopComposer) Render(notification string, data map[string]interface{}, carrier string) (*ContentSet, error)

Types

type Composer

type Composer interface {
	Render(notification string, data map[string]interface{}, carrier string) (*ContentSet, error)
}

Composer defines the interface to create a ContentSet

type ContentSet

type ContentSet struct {
	HTMLs map[string]string
	Texts map[string]string
}

ContentSet contains the set of rendered pieces to be used for a given Carrier (to create a Dispatch for each target user)

type FileSystemComposer

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

FileSystemComposer is notification template renderer

func NewFileSystemComposer

func NewFileSystemComposer(templatesDir string) *FileSystemComposer

NewFileSystemComposer creates a new FileSystemComposer

func (*FileSystemComposer) Render

func (r *FileSystemComposer) Render(notification string, data map[string]interface{}, carrier string) (*ContentSet, error)

Render renders a notifications using the provided data

type NopComposer

type NopComposer struct {
}

func NewNopComposer

func NewNopComposer() *NopComposer

func (*NopComposer) Render

func (n *NopComposer) Render(notification string, data map[string]interface{},
	carrier string) (*ContentSet, error)