notification

Documentation

Index

• func Init(uri string) (err error)
• func Notify(result HookResult)
• func Register(scheme string, creator NotifierCreator)
• type HookResult
• type Notifier
  • func NewNotifier(uri string) (Notifier, error)
• type NotifierCreator

Functions

func Init

func Init(uri string) (err error)

Init creates the notifier singleton regarding the URI.

func Notify

func Notify(result HookResult)

Notify is the global method to notify hook result

func Register

func Register(scheme string, creator NotifierCreator)

Register a Notifier to the registry

Types

type HookResult

type HookResult interface {
	ID() uint64
	Name() string
	Logs(filter string) string
	StatusLabel() string
	Err() error
}

HookResult is the result of a hook execution

type Notifier

type Notifier interface {
	Notify(result HookResult) error
}

Notifier is able to send a notification.

func NewNotifier

func NewNotifier(uri string) (Notifier, error)

NewNotifier create new Notifier

type NotifierCreator

type NotifierCreator func(uri *url.URL) (Notifier, error)

NotifierCreator function for create a notifier