notify

Documentation

Index

• func ListActions() utask.NotifyActions
• func ListSendersNames() []string
• func RegisterActions(na utask.NotifyActions)
• func RegisterSender(s NotificationSender, name string)
• func Send(m *Message, params utask.NotifyActionsParameters)
• func WrappedSendError(etype string, err string)
• type Message
  • func WrapTaskStateUpdate(tsu *TaskStateUpdate) *Message
• type NotificationSender
• type TaskStateUpdate

Functions

func ListActions

func ListActions() utask.NotifyActions

ListActions returns a list of available actions to notify

func ListSendersNames

func ListSendersNames() []string

ListSendersNames returns a list of available senders

func RegisterActions

func RegisterActions(na utask.NotifyActions)

RegisterActions set available actions

func RegisterSender

func RegisterSender(s NotificationSender, name string)

RegisterSender adds a NotificationSender to the pool of available senders

func Send

func Send(m *Message, params utask.NotifyActionsParameters)

Send dispatches a Message struct over all registered senders

func WrappedSendError

func WrappedSendError(etype string, err string)

WrappedSendError print a formatted string from Send Notify in case of issue

Types

type Message

type Message struct {
	MainMessage string
	Fields      map[string]string
}

Message represents a generic message to be sent

func WrapTaskStateUpdate

func WrapTaskStateUpdate(tsu *TaskStateUpdate) *Message

WrapTaskStateUpdate returns a Message struct formatted for a task state change

type NotificationSender

type NotificationSender interface {
	Send(m *Message, name string)
}

NotificationSender is an object capable of sending a Message struct over a notification channel, as determined by its implementation

type TaskStateUpdate

type TaskStateUpdate struct {
	Title              string
	PublicID           string
	State              string
	TemplateName       string
	RequesterUsername  string
	ResolverUsername   *string
	PotentialResolvers []string
	StepsDone          int
	StepsTotal         int
}

TaskStateUpdate holds a digest of data representing a task state change