notifier

Documentation

Overview

Package notifier provides functions to notify the user about the status of the download.

Index

• Variables
• func NotifyCanceled(ctx context.Context, channelID string, labels map[string]string) error
• func NotifyConfigReloaded(ctx context.Context) error
• func NotifyDownloading(ctx context.Context, channelID string, labels map[string]string, metadata any) error
• func NotifyError(ctx context.Context, channelID string, labels map[string]string, err error) error
• func NotifyFinished(ctx context.Context, channelID string, labels map[string]string, metadata any) error
• func NotifyIdle(ctx context.Context, channelID string, labels map[string]string) error
• func NotifyLoginFailed(ctx context.Context, capture error) error
• func NotifyPanicked(ctx context.Context, capture any) error
• func NotifyPostProcessing(ctx context.Context, channelID string, labels map[string]string, metadata any) error
• func NotifyPreparingFiles(ctx context.Context, channelID string, labels map[string]string, metadata any) error
• func NotifyUpdateAvailable(ctx context.Context, version string) error

Variables

var Notifier *notify.FormatedNotifier = notify.NewFormatedNotifier(
	notify.NewDummyNotifier(),
	notify.DefaultNotificationFormats,
)

Notifier is the notifier used to notify the user about the status of the download.

Functions

func NotifyCanceled

func NotifyCanceled(
	ctx context.Context,
	channelID string,
	labels map[string]string,
) error

NotifyCanceled notifies the user that the program has canceled the download.

func NotifyConfigReloaded

func NotifyConfigReloaded(ctx context.Context) error

NotifyConfigReloaded notifies the user that the configuration has been reloaded.

func NotifyDownloading

func NotifyDownloading(
	ctx context.Context,
	channelID string,
	labels map[string]string,
	metadata any,
) error

NotifyDownloading notifies the user that the program is downloading the stream.

func NotifyError

func NotifyError(
	ctx context.Context,
	channelID string,
	labels map[string]string,
	err error,
) error

NotifyError notifies the user that the program has encountered an error.

func NotifyFinished

func NotifyFinished(
	ctx context.Context,
	channelID string,
	labels map[string]string,
	metadata any,
) error

NotifyFinished notifies the user that the program has finished downloading the stream.

func NotifyIdle

func NotifyIdle(ctx context.Context, channelID string, labels map[string]string) error

NotifyIdle notifies the user that the stream is idle.

func NotifyLoginFailed

func NotifyLoginFailed(ctx context.Context, capture error) error

NotifyLoginFailed notifies the user that the login has failed.

func NotifyPanicked

func NotifyPanicked(ctx context.Context, capture any) error

NotifyPanicked notifies the user that the download has panicked.

func NotifyPostProcessing

func NotifyPostProcessing(
	ctx context.Context,
	channelID string,
	labels map[string]string,
	metadata any,
) error

NotifyPostProcessing notifies the user that the program is post processing the stream.

func NotifyPreparingFiles

func NotifyPreparingFiles(
	ctx context.Context,
	channelID string,
	labels map[string]string,
	metadata any,
) error

NotifyPreparingFiles notifies the user that the program is preparing the files for the stream.

func NotifyUpdateAvailable

func NotifyUpdateAvailable(ctx context.Context, version string) error

NotifyUpdateAvailable notifies the user that an update is available.