notify

Documentation

Index

• Variables
• type BaseNotifier
  • func NewDummyNotifier() BaseNotifier
  • func NewShoutrrr(urls []string, opts ...ShoutrrrOption) BaseNotifier
• type FormatedNotifier
  • func NewFormatedNotifier(notifier BaseNotifier, formats NotificationFormats) FormatedNotifier
• type NotificationFormat
• type NotificationFormats
• type NotificationTemplate
• type NotificationTemplates
• type Shoutrrr
  • func (n *Shoutrrr) Notify(ctx context.Context, title string, message string, priority int) error
• type ShoutrrrOption
  • func IncludeTitleInMessage(value ...bool) ShoutrrrOption
  • func NoPriority(value ...bool) ShoutrrrOption
• type ShoutrrrOptions

Variables

var DefaultNotificationFormats = NotificationFormats{
	ConfigReloaded: NotificationFormat{
		Enabled:  ptr.Ref(true),
		Title:    "config reloaded",
		Message:  "",
		Priority: 10,
	},
	LoginFailed: NotificationFormat{
		Enabled:  ptr.Ref(true),
		Title:    "login failed",
		Message:  "{{ .Error }}",
		Priority: 10,
	},
	Panicked: NotificationFormat{
		Enabled:  ptr.Ref(true),
		Title:    "panicked",
		Message:  "{{ .Capture }}",
		Priority: 10,
	},
	Idle: NotificationFormat{
		Enabled: ptr.Ref(false),
		Title:   "watching {{ .ChannelID }}",
	},
	PreparingFiles: NotificationFormat{
		Enabled: ptr.Ref(false),
		Title:   "preparing files for {{ .MetaData.ProfileData.Name }}",
	},
	Downloading: NotificationFormat{
		Enabled:  ptr.Ref(true),
		Title:    "{{ .MetaData.ProfileData.Name }} is streaming",
		Message:  "{{ .MetaData.ChannelData.Title }}",
		Priority: 7,
	},
	PostProcessing: NotificationFormat{
		Enabled:  ptr.Ref(false),
		Title:    "post-processing {{ .MetaData.ProfileData.Name }}",
		Message:  "{{ .MetaData.ChannelData.Title }}",
		Priority: 7,
	},
	Finished: NotificationFormat{
		Enabled:  ptr.Ref(true),
		Title:    "{{ .MetaData.ProfileData.Name }} stream ended",
		Message:  "{{ .MetaData.ChannelData.Title }}",
		Priority: 7,
	},
	Error: NotificationFormat{
		Enabled:  ptr.Ref(true),
		Title:    "stream download of {{ .ChannelID }} failed",
		Message:  "{{ .Error }}",
		Priority: 10,
	},
	Canceled: NotificationFormat{
		Enabled:  ptr.Ref(true),
		Title:    "stream download of {{ .ChannelID }} canceled",
		Priority: 10,
	},
}

Types

type BaseNotifier

type BaseNotifier interface {
	Notify(
		ctx context.Context,
		title string,
		message string,
		priority int,
	) error
}

func NewDummyNotifier

func NewDummyNotifier() BaseNotifier

func NewShoutrrr

func NewShoutrrr(urls []string, opts ...ShoutrrrOption) BaseNotifier

type FormatedNotifier

type FormatedNotifier interface {
	BaseNotifier
	NotifyConfigReloaded(ctx context.Context) error
	NotifyLoginFailed(ctx context.Context, capture error) error
	NotifyPanicked(ctx context.Context, capture any) error
	NotifyIdle(ctx context.Context, channelID string, labels map[string]string) error
	NotifyPreparingFiles(
		ctx context.Context,
		channelID string,
		labels map[string]string,
		metadata any,
	) error
	NotifyDownloading(
		ctx context.Context,
		channelID string,
		labels map[string]string,
		metadata any,
	) error
	NotifyPostProcessing(
		ctx context.Context,
		channelID string,
		labels map[string]string,
		metadata any,
	) error
	NotifyFinished(
		ctx context.Context,
		channelID string,
		labels map[string]string,
		metadata any,
	) error
	NotifyError(
		ctx context.Context,
		channelID string,
		labels map[string]string,
		err error,
	) error
	NotifyCanceled(
		ctx context.Context,
		channelID string,
		labels map[string]string,
	) error
}

func NewFormatedNotifier

func NewFormatedNotifier(notifier BaseNotifier, formats NotificationFormats) FormatedNotifier

type NotificationFormat

type NotificationFormat struct {
	Enabled  *bool  `yaml:"enabled,omitempty"`
	Title    string `yaml:"title,omitempty"`
	Message  string `yaml:"message,omitempty"`
	Priority int    `yaml:"priority,omitempty"`
}

type NotificationFormats

type NotificationFormats struct {
	ConfigReloaded NotificationFormat `yaml:"configReloaded,omitempty"`
	LoginFailed    NotificationFormat `yaml:"loginFailed,omitempty"`
	Panicked       NotificationFormat `yaml:"panicked,omitempty"`
	Idle           NotificationFormat `yaml:"idle,omitempty"`
	PreparingFiles NotificationFormat `yaml:"preparingFiles,omitempty"`
	Downloading    NotificationFormat `yaml:"downloading,omitempty"`
	PostProcessing NotificationFormat `yaml:"postProcessing,omitempty"`
	Finished       NotificationFormat `yaml:"finished,omitempty"`
	Error          NotificationFormat `yaml:"error,omitempty"`
	Canceled       NotificationFormat `yaml:"canceled,omitempty"`
}

type NotificationTemplate

type NotificationTemplate struct {
	TitleTemplate   *template.Template
	MessageTemplate *template.Template
}

type NotificationTemplates

type NotificationTemplates struct {
	ConfigReloaded NotificationTemplate
	LoginFailed    NotificationTemplate
	Panicked       NotificationTemplate
	Idle           NotificationTemplate
	PreparingFiles NotificationTemplate
	Downloading    NotificationTemplate
	PostProcessing NotificationTemplate
	Finished       NotificationTemplate
	Error          NotificationTemplate
	Canceled       NotificationTemplate
}

type Shoutrrr

type Shoutrrr struct {
	*router.ServiceRouter
	// contains filtered or unexported fields
}

func (*Shoutrrr) Notify

func (n *Shoutrrr) Notify(
	ctx context.Context,
	title string,
	message string,
	priority int,
) error

type ShoutrrrOption

type ShoutrrrOption func(*ShoutrrrOptions)

func IncludeTitleInMessage

func IncludeTitleInMessage(value ...bool) ShoutrrrOption

func NoPriority

func NoPriority(value ...bool) ShoutrrrOption

type ShoutrrrOptions

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