Documentation
¶
Overview ¶
Package notifytemplate provides a way to access notification templates.
Index ¶
- Constants
- Variables
- func GetEmbeddedTemplate(templateName string) (string, error)
- func GetTemplate(ctx context.Context, rep repo.Repository, templateName string) (tmpl string, found bool, err error)
- func ParseTemplate(tmpl string, opt Options) (*template.Template, error)
- func ResetTemplate(ctx context.Context, rep repo.RepositoryWriter, templateName string) error
- func ResolveTemplate(ctx context.Context, rep repo.Repository, ...) (string, error)
- func SetTemplate(ctx context.Context, rep repo.RepositoryWriter, ...) error
- func SupportedTemplates() []string
- type Info
- type Options
- type TemplateManifest
Constants ¶
const ManifestType = "notificationTemplate"
ManifestType is the manifest type of notification templates.
const (
TestNotification = "test-notification"
)
Template names.
Variables ¶
var DefaultOptions = Options{}
DefaultOptions is the default set of options.
Functions ¶
func GetEmbeddedTemplate ¶
GetEmbeddedTemplate returns embedded template by name.
func GetTemplate ¶
func GetTemplate(ctx context.Context, rep repo.Repository, templateName string) (tmpl string, found bool, err error)
GetTemplate returns a named template from the repository.
func ParseTemplate ¶
ParseTemplate parses a named template.
func ResetTemplate ¶
ResetTemplate removes a template override from the repository.
func ResolveTemplate ¶
func ResolveTemplate(ctx context.Context, rep repo.Repository, profileName, baseTemplateName, extension string) (string, error)
ResolveTemplate resolves a named template from the repository by looking for most-specific defined override and falling back to generic embedded template.
func SetTemplate ¶
func SetTemplate(ctx context.Context, rep repo.RepositoryWriter, templateName, templateText string) error
SetTemplate saves a template in the repository.
func SupportedTemplates ¶
func SupportedTemplates() []string
SupportedTemplates returns a list of supported template names.
Types ¶
type Info ¶
type Info struct {
Name string `json:"name"`
LastModified *time.Time `json:"lastModified,omitempty"`
IsBuiltIn bool `json:"isBuiltIn,omitempty"`
}
Info returns information about single notification template.
func ListTemplates ¶
ListTemplates returns a list of templates.
type TemplateManifest ¶
type TemplateManifest struct {
Template string `json:"template"`
}
TemplateManifest is the manifest of a notification template.
Source Files